Interface CreateJwtOptions<Payload, Transformed>

interface CreateJwtOptions<Payload, Transformed> {
    additionalValidations?: ValidationFunction<Payload, Transformed>[];
    algorithms?: Algorithm[];
    allowedAud?: string | RegExp | (string | RegExp)[];
    allowedIss?: string | RegExp | (string | RegExp)[];
    allowedJti?: string | RegExp | (string | RegExp)[];
    allowedNonce?: string | RegExp | (string | RegExp)[];
    allowedSub?: string | RegExp | (string | RegExp)[];
    cache?: number | boolean;
    cacheTTL?: number;
    checkTyp?: string;
    clockTimestamp?: number;
    clockTolerance?: number;
    complete?: boolean;
    discoveryEndpoint?: string;
    errorCacheTTL?: number | ((tokenError) => number);
    ignoreExpiration?: boolean;
    ignoreNotBefore?: boolean;
    issuer?: string;
    key?: string;
    maxAge?: number;
    requiredClaims?: string[];
    schema: Payload;
    transformer?: JwtPayloadTransformer<Payload, Transformed>;
}

Type Parameters

  • Payload extends TSchema
  • Transformed extends Record<string, unknown> | undefined = undefined

Hierarchy (view full)

Properties

additionalValidations? algorithms? allowedAud? allowedIss? allowedJti? allowedNonce? allowedSub? cache? cacheTTL? checkTyp? clockTimestamp? clockTolerance? complete? discoveryEndpoint? errorCacheTTL? ignoreExpiration? ignoreNotBefore? issuer? key? maxAge? requiredClaims? schema transformer?

Properties

Optional additionalValidations

additionalValidations?: ValidationFunction<Payload, Transformed>[]

An optional array of functions that will also be used to validate the JWT.

Optional algorithms

algorithms?: Algorithm[]

Optional allowedAud

allowedAud?: string | RegExp | (string | RegExp)[]

Optional allowedIss

allowedIss?: string | RegExp | (string | RegExp)[]

Optional allowedJti

allowedJti?: string | RegExp | (string | RegExp)[]

Optional allowedNonce

allowedNonce?: string | RegExp | (string | RegExp)[]

Optional allowedSub

allowedSub?: string | RegExp | (string | RegExp)[]

Optional cache

cache?: number | boolean

Optional cacheTTL

cacheTTL?: number

Optional checkTyp

checkTyp?: string

Optional clockTimestamp

clockTimestamp?: number

Optional clockTolerance

clockTolerance?: number

Optional complete

complete?: boolean

Optional discoveryEndpoint

discoveryEndpoint?: string

Optional errorCacheTTL

errorCacheTTL?: number | ((tokenError) => number)

Type declaration

    • (tokenError): number

    • Parameters

      • tokenError: TokenError

      Returns number

Optional ignoreExpiration

ignoreExpiration?: boolean

Optional ignoreNotBefore

ignoreNotBefore?: boolean

Optional issuer

issuer?: string

Optional key

key?: string

Optional maxAge

maxAge?: number

Optional requiredClaims

requiredClaims?: string[]

schema

schema: Payload

A required schema for the Payload you will be validating

Optional transformer

transformer?: JwtPayloadTransformer<Payload, Transformed>

The function that you will use for manipulating the JWT you are authenticating.

Settings

Member Visibility

Theme

On This Page

additionalValidationsalgorithmsallowedAudallowedIssallowedJtiallowedNonceallowedSubcachecacheTTLcheckTypclockTimestampclockTolerancecompletediscoveryEndpointerrorCacheTTLignoreExpirationignoreNotBeforeissuerkeymaxAgerequiredClaimsschematransformer