@nestjs/jwt/dist/interfaces/jwt-module-options.interface.d.ts

Sign and verify JSON Web Tokens in NestJS with an injectable JwtService, built on jsonwebtoken.

import { ModuleMetadata, Provider, Type } from '@nestjs/common';
import type * as jwt from 'jsonwebtoken';
export declare enum JwtSecretRequestType {
    SIGN = 0,
    VERIFY = 1
}
export interface JwtModuleOptions {
    global?: boolean;
    signOptions?: jwt.SignOptions;
    secret?: jwt.Secret;
    publicKey?: jwt.Secret;
    privateKey?: jwt.Secret;
    secretOrPrivateKey?: jwt.Secret;
    secretOrKeyProvider?: (requestType: JwtSecretRequestType, tokenOrPayload: string | object | Buffer, options?: jwt.VerifyOptions | jwt.SignOptions) => jwt.Secret | Promise<jwt.Secret>;
    verifyOptions?: jwt.VerifyOptions;
}
export interface JwtOptionsFactory {
    createJwtOptions(): Promise<JwtModuleOptions> | JwtModuleOptions;
}
export interface JwtModuleAsyncOptions extends Pick<ModuleMetadata, 'imports'> {
    global?: boolean;
    useExisting?: Type<JwtOptionsFactory>;
    useClass?: Type<JwtOptionsFactory>;
    useFactory?: (...args: any[]) => Promise<JwtModuleOptions> | JwtModuleOptions;
    inject?: any[];
    extraProviders?: Provider[];
}
export interface JwtSignOptions extends jwt.SignOptions {
    secret?: jwt.Secret;
    privateKey?: jwt.Secret;
}
export interface JwtVerifyOptions extends jwt.VerifyOptions {
    secret?: jwt.Secret;
    publicKey?: jwt.Secret;
}
export type GetSecretKeyResult = string | Buffer | jwt.Secret;