Skip to content

Documents for @litert/jwt / CoreApis/Stringify / IStringifyOptions

Interface: IStringifyOptions ​

Defined in: src/lib/CoreApis/Stringify.ts:23

The options for API stringify.

Properties ​

optional header?: Partial<IJwtHeader>

Defined in: src/lib/CoreApis/Stringify.ts:32

The JWT header to use.

The typ (type) and alg (algorithm) claims will be set automatically according to the provided signer. And they are not allowed to be overridden.


payload ​

payload: IJwtPayload

Defined in: src/lib/CoreApis/Stringify.ts:40

The JWT payload to use.

Only the user provided claims will be included in the JWT. No default claims will be set.


signer ​

signer: IJwaSigner

Defined in: src/lib/CoreApis/Stringify.ts:45

The signer to use for signing the JWT.