@types/passport-jwt

constructor

constructor(opt: StrategyOptionsWithoutRequest, verify: VerifyCallback);

• Strategy constructor

constructor

constructor(
    opt: StrategyOptionsWithRequest,
    verify: VerifyCallbackWithRequest<any>
);

• Strategy constructor

property name

name: string;

property algorithms

algorithms?: Algorithm[] | undefined;

• List of strings with the names of allowed algorithms (e.g., ["HS256", "HS384"]).

property audience

audience?: string | string[] | undefined;

• If defined, the audience will be verified against this value.

property ignoreExpiration

ignoreExpiration?: boolean | undefined;

• If true, do not validate the expiration of the token.

property issuer

issuer?: string | string[] | undefined;

• If defined, the issuer will be verified against this value.

property jsonWebTokenOptions

jsonWebTokenOptions?: VerifyOptions | undefined;

• Deprecated

  for backwards compatibility, still allowing you to pass audience / issuer / algorithms / ignoreExpiration on the options.

property jwtFromRequest

jwtFromRequest: JwtFromRequestFunction;

• Function that accepts a request as the only parameter and returns either the JWT as a string or null. REQUIRED.

call signature

(req: T): string | null;

call signature

(
    request: T,
    rawJwtToken: any,
    done: (err: any, secretOrKey?: string | Buffer) => void
): void;

• Callback for secret or key provider.

  Parameter request

  The request object from your framework (e.g., Express.Request)

  Parameter rawJwtToken

  The raw JWT token string

  Parameter done

  A function with the signature function(err, secret)

call signature

(error: any, user?: unknown | false, info?: any): void;

property secretOrKey

secretOrKey: string | Buffer;

property secretOrKeyProvider

secretOrKeyProvider: SecretOrKeyProvider;

function fromAuthHeaderAsBearerToken

fromAuthHeaderAsBearerToken: () => JwtFromRequestFunction;

• Creates an extractor function to retrieve a token from the authorization header as a Bearer token.

  Returns

  {JwtFromRequestFunction} A function that takes a request object and returns the extracted token.

function fromAuthHeaderWithScheme

fromAuthHeaderWithScheme: (auth_scheme: string) => JwtFromRequestFunction;

• Creates an extractor function to retrieve a token from the authorization header with a specific scheme.

  Parameter auth_scheme

  The authorization scheme (e.g., 'Bearer').

  Returns

  {JwtFromRequestFunction} A function that takes a request object and returns the extracted token.

function fromBodyField

fromBodyField: (field_name: string) => JwtFromRequestFunction;

• Creates an extractor function to retrieve a token from a field in the request body.

  Parameter field_name

  The name of the field to extract the token from.

  Returns

  {JwtFromRequestFunction} A function that takes a request object and returns the extracted token.

function fromExtractors

fromExtractors: <T = any>(
    extractors: Array<JwtFromRequestFunction<T>>
) => JwtFromRequestFunction<T>;

• Creates an extractor function that combines multiple extractor functions.

  Parameter extractors

  An array of extractor functions.

  Returns

  {JwtFromRequestFunction} A function that takes a request object and returns the extracted token.

function fromHeader

fromHeader: (header_name: string) => JwtFromRequestFunction;

• Creates an extractor function to retrieve a token from the request header.

  Parameter header_name

  The name of the header to extract the token from.

  Returns

  {JwtFromRequestFunction} A function that takes a request object and returns the extracted token.

function fromUrlQueryParameter

fromUrlQueryParameter: (param_name: string) => JwtFromRequestFunction;

• Creates an extractor function to retrieve a token from a query parameter in the URL.

  Parameter param_name

  The name of the query parameter to extract the token from.

  Returns

  {JwtFromRequestFunction} A function that takes a request object and returns the extracted token.