@litert/jwt

Appearance

Documents for @litert/jwt / ManagedApis/Builder / IJwtBuilderOptions

Interface: IJwtBuilderOptions ​

Defined in: src/lib/ManagedApis/Builder.ts:27

The options for creating a JWT builder.

Properties ​

optional header: Partial<IJwtHeader>

Defined in: src/lib/ManagedApis/Builder.ts:45

Initial header claims to include in every new generated token.

If a function is provided, it will be called to get the initial header claims for the builder.

For alg and typ claims, they will be ignored, and automatically set according to the signer used.

Default ​

ts
{}

payload? ​

optional payload: IJwtPayload

Defined in: src/lib/ManagedApis/Builder.ts:55

Initial payload claims to include in every new generated token.

If a function is provided, it will be called to get the initial payload claims for the builder.

Default ​

ts
{}

signer ​

signer: IJwaSigner

Defined in: src/lib/ManagedApis/Builder.ts:32

The signer to use to sign the JWT tokens.