Wondering what’s next for npm?Check out our public roadmap! »

    jwt-decode
    TypeScript icon, indicating that this package has built-in type declarations

    3.1.2 • Public • Published

    jwt-decode is a small browser library that helps decoding JWTs token which are Base64Url encoded.

    IMPORTANT: This library doesn't validate the token, any well formed JWT can be decoded. You should validate the token in your server-side logic by using something like express-jwt, koa-jwt, Owin Bearer JWT, etc.


    Warning: When upgrading from version 2 to 3, there's a potentially breaking change

    If you've previously imported the library as import * as jwt_decode from 'jwt-decode', you'll have to change your import to import jwt_decode from 'jwt-decode';.


    Installation

    FOSSA Status

    Install with NPM or Yarn.

    Run npm install jwt-decode or yarn add jwt-decode to install the library.

    Usage

    import jwt_decode from "jwt-decode";
     
    var token = "eyJ0eXAiO.../// jwt token";
    var decoded = jwt_decode(token);
     
    console.log(decoded);
     
    /* prints:
     * { foo: "bar",
     *   exp: 1393286893,
     *   iat: 1393268893  }
     */
     
    // decode header by passing in options (useful for when you need `kid` to verify a JWT):
    var decodedHeader = jwt_decode(token, { header: true });
    console.log(decodedHeader);
     
    /* prints:
     * { typ: "JWT",
     *   alg: "HS256" }
     */

    Note: A falsy or malformed token will throw an InvalidTokenError error.

    Use as a CommonJS package

    const jwt_decode = require('jwt-decode');
    ...

    Include with a script tag

    Copy the file jwt-decode.js from the build/ folder to your project somewhere, then include like so:

    <script src="jwt-decode.js"></script>

    Older versions

    If you want to use the library trough Bower, an HTML import, use version v2.2.0. It has the same functionality.

    Develop

    Run npm run dev, this will fire up a browser and watch the /lib folder.

    Issue Reporting

    If you have found a bug or if you have a feature request, please report them at this repository issues section. Please do not report security vulnerabilities on the public GitHub issue tracker. The Responsible Disclosure Program details the procedure for disclosing security issues.

    Author

    Auth0

    License

    This project is licensed under the MIT license. See the LICENSE file for more info.

    FOSSA Status

    Keywords

    Install

    npm i jwt-decode

    DownloadsWeekly Downloads

    2,272,811

    Version

    3.1.2

    License

    MIT

    Unpacked Size

    29.7 kB

    Total Files

    11

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar