Logo for jsDocs.io

jwt-decode

  • Version 4.0.0
  • Published
  • 13.9 kB
  • No dependencies
  • MIT license

Install

npm i jwt-decode
yarn add jwt-decode
pnpm add jwt-decode

Overview

Decode JWT tokens, mostly useful for browser applications.

Index

Functions

Classes

Interfaces

Functions

function jwtDecode

jwtDecode: {
    <T = JwtHeader>(token: string, options: JwtDecodeOptions & { header: true }): T;
    <T = JwtPayload>(token: string, options?: JwtDecodeOptions): T;
};

    Classes

    class InvalidTokenError

    class InvalidTokenError extends Error {}

      Interfaces

      interface JwtDecodeOptions

      interface JwtDecodeOptions {}

        property header

        header?: boolean;

          interface JwtHeader

          interface JwtHeader {}

            property alg

            alg?: string;

              property kid

              kid?: string;

                property typ

                typ?: string;

                  interface JwtPayload

                  interface JwtPayload {}

                    property aud

                    aud?: string[] | string;

                      property exp

                      exp?: number;

                        property iat

                        iat?: number;

                          property iss

                          iss?: string;

                            property jti

                            jti?: string;

                              property nbf

                              nbf?: number;

                                property sub

                                sub?: string;

                                  Package Files (1)

                                  Dependencies (0)

                                  No dependencies.

                                  Dev Dependencies (20)

                                  Peer Dependencies (0)

                                  No peer dependencies.

                                  Badge

                                  To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                  You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/jwt-decode.

                                  • Markdown
                                    [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/jwt-decode)
                                  • HTML
                                    <a href="https://www.jsdocs.io/package/jwt-decode"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>