Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Functions

decodeJWT

  • decodeJWT<TToken>(token: string, options?: Optional<DecodeOptions>): TToken | false
  • Decodes a JWT and returns it, if succeeded.

    Type parameters

    • TToken: unknown = any

    Parameters

    • token: string

      The token as string.

    • Optional options: Optional<DecodeOptions>

    Returns TToken | false

    The decoded token, or (false) if failed.

signJWT

  • signJWT(decodedToken: any, options?: Optional<SignOptions>): string
  • Creates a JWT from an object.

    Parameters

    • decodedToken: any

      The token as object.

    • Optional options: Optional<SignOptions>

    Returns string

    The JWT.

verifyJWT

  • verifyJWT<TToken>(token: string, options?: Optional<VerifyOptions>): TToken | false
  • Verifies a JWT and returns it decoded version, if succeeded.

    Type parameters

    • TToken: unknown = any

    Parameters

    • token: string

      The token as string.

    • Optional options: Optional<VerifyOptions>

    Returns TToken | false

    The decoded token, or (false), if verification failed.

withJWT

  • Creates a new Express middleware, that checks for a valid JWT.

    Parameters

    Returns RequestHandler

    The new middleware.

Generated using TypeDoc