TanTan
2a69b23b47
Dev Build / cleanup (push) Canceled after 0s
Dev Build / typecheck (push) Canceled after 0s
Dev Build / build (linux-arm64, ubuntu-24.04-arm, linux-arm64) (push) Canceled after 0s
Dev Build / build (linux-x64, ubuntu-latest, linux-x64) (push) Canceled after 0s
Dev Build / build (win-x64, windows-latest, win32-x64) (push) Canceled after 0s
Dev Build / dispatch-dev-docker (push) Canceled after 0s
44 lines
1.6 KiB
Plaintext
44 lines
1.6 KiB
Plaintext
/**
|
|
* JSON Web Token (JWT) Signing (JWT is in JWS format)
|
|
*
|
|
* @module
|
|
*/
|
|
import type * as types from '../types.d.ts';
|
|
/**
|
|
* The SignJWT class is used to build and sign Compact JWS formatted JSON Web Tokens.
|
|
*
|
|
* This class is exported (as a named export) from the main `'jose'` module entry point as well as
|
|
* from its subpath export `'jose/jwt/sign'`.
|
|
*
|
|
*/
|
|
export declare class SignJWT implements types.ProduceJWT {
|
|
#private;
|
|
/**
|
|
* {@link SignJWT} constructor
|
|
*
|
|
* @param payload The JWT Claims Set object. Defaults to an empty object.
|
|
*/
|
|
constructor(payload?: types.JWTPayload);
|
|
setIssuer(issuer: string): this;
|
|
setSubject(subject: string): this;
|
|
setAudience(audience: string | string[]): this;
|
|
setJti(jwtId: string): this;
|
|
setNotBefore(input: number | string | Date): this;
|
|
setExpirationTime(input: number | string | Date): this;
|
|
setIssuedAt(input?: number | string | Date): this;
|
|
/**
|
|
* Sets the JWS Protected Header on the SignJWT object.
|
|
*
|
|
* @param protectedHeader JWS Protected Header. Must contain an "alg" (JWS Algorithm) property.
|
|
*/
|
|
setProtectedHeader(protectedHeader: types.JWTHeaderParameters): this;
|
|
/**
|
|
* Signs and returns the JWT.
|
|
*
|
|
* @param key Private Key or Secret to sign the JWT with. See
|
|
* {@link https://github.com/panva/jose/issues/210#jws-alg Algorithm Key Requirements}.
|
|
* @param options JWT Sign options.
|
|
*/
|
|
sign(key: types.CryptoKey | types.KeyObject | types.JWK | Uint8Array, options?: types.SignOptions): Promise<string>;
|
|
}
|