Variable JWT

Type Declaration

• algorithms: {
      EdDSA: {
          sign: (data: BinaryLike, secret: KeyLike) => string;
          verify: (data: BinaryLike, secret: KeyLike, signature: string) => boolean;
      };
      ES256: {
          sign: (data: BinaryLike, secret: KeyLike) => string;
          verify: (data: BinaryLike, secret: KeyLike, signature: string) => boolean;
      };
      ES256K: {
          sign: (data: BinaryLike, secret: KeyLike) => string;
          verify: (data: BinaryLike, secret: KeyLike, signature: string) => boolean;
      };
      ES384: {
          sign: (data: BinaryLike, secret: KeyLike) => string;
          verify: (data: BinaryLike, secret: KeyLike, signature: string) => boolean;
      };
      ES512: {
          sign: (data: BinaryLike, secret: KeyLike) => string;
          verify: (data: BinaryLike, secret: KeyLike, signature: string) => boolean;
      };
      HS256: {
          sign: (data: BinaryLike, secret: KeyLike) => string;
          verify: (data: BinaryLike, secret: KeyLike, signature: string) => boolean;
      };
      HS384: {
          sign: (data: BinaryLike, secret: KeyLike) => string;
          verify: (data: BinaryLike, secret: KeyLike, signature: string) => boolean;
      };
      HS512: {
          sign: (data: BinaryLike, secret: KeyLike) => string;
          verify: (data: BinaryLike, secret: KeyLike, signature: string) => boolean;
      };
      PS256: {
          sign: (data: BinaryLike, secret: KeyLike) => string;
          verify: (data: BinaryLike, secret: KeyLike, signature: string) => boolean;
      };
      PS384: {
          sign: (data: BinaryLike, secret: KeyLike) => string;
          verify: (data: BinaryLike, secret: KeyLike, signature: string) => boolean;
      };
      PS512: {
          sign: (data: BinaryLike, secret: KeyLike) => string;
          verify: (data: BinaryLike, secret: KeyLike, signature: string) => boolean;
      };
      RS256: {
          sign: (data: BinaryLike, secret: KeyLike) => string;
          verify: (data: BinaryLike, secret: KeyLike, signature: string) => boolean;
      };
      RS384: {
          sign: (data: BinaryLike, secret: KeyLike) => string;
          verify: (data: BinaryLike, secret: KeyLike, signature: string) => boolean;
      };
      RS512: {
          sign: (data: BinaryLike, secret: KeyLike) => string;
          verify: (data: BinaryLike, secret: KeyLike, signature: string) => boolean;
      };
  }

• decode: (token: string) => JWT

  Decode a JWT string into its parts (without verification)

• sign: (
      payload: JWTPayload,
      secret: KeyLike,
      options?: {
          alg?:
              | "HS256"
              | "HS384"
              | "HS512"
              | "RS256"
              | "RS384"
              | "RS512"
              | "ES256"
              | "ES384"
              | "ES512"
              | "ES256K"
              | "PS256"
              | "PS384"
              | "PS512"
              | "EdDSA";
          kid?: string;
          typ?: string;
      },
  ) => string

  Sign a JWT

• verify: (
      token: string,
      secret: KeyLike,
      options?: {
          algorithms?: (
              | "HS256"
              | "HS384"
              | "HS512"
              | "RS256"
              | "RS384"
              | "RS512"
              | "ES256"
              | "ES384"
              | "ES512"
              | "ES256K"
              | "PS256"
              | "PS384"
              | "PS512"
              | "EdDSA"
          )[];
          audience?: string
          | string[];
          clockSkew?: number;
          ignoreExpiration?: boolean;
          issuer?: string;
          jwtId?: string;
          maxTokenAge?: number;
          subject?: string;
      },
  ) => | {
      header: JWTHeader;
      payload: JWTPayload;
      signature: string;
      valid: true;
  }
  | { error: { code: string; reason: string }; valid: false }

  Verify and validate a JWT