Function verify

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
Parameters
- 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;
  } = {}
Returns
    | {
        header: JWTHeader;
        payload: JWTPayload;
        signature: string;
        valid: true;
    }
    | { error: { code: string; reason: string }; valid: false }
- Defined in index.ts:378

Function verify

Parameters

Returns | { header: JWTHeader; payload: JWTPayload; signature: string; valid: true; } | { error: { code: string; reason: string }; valid: false }

Settings

Returns
| {
header: JWTHeader;
payload: JWTPayload;
signature: string;
valid: true;
}
| { error: { code: string; reason: string }; valid: false }