@types/jsonwebtoken

What is @types/jsonwebtoken?

The @types/jsonwebtoken package provides TypeScript type definitions for the jsonwebtoken package, which is a popular library for working with JSON Web Tokens (JWTs) in Node.js applications. These type definitions allow developers to use jsonwebtoken in TypeScript projects with type checking, enabling better development experience and error handling.

What are @types/jsonwebtoken's main functionalities?

Signing Tokens

This feature allows you to create a JWT by encoding a payload and a secret. The `sign` method takes the payload and the secret key, then returns a token string.

import jwt from 'jsonwebtoken';

const token = jwt.sign({ foo: 'bar' }, 'shhhhh');

Verifying Tokens

This feature enables the verification of a JWT's signature and the extraction of the token's payload. The `verify` method takes the token and the secret key, and either returns the decoded payload or throws an error if the token is invalid.

import jwt from 'jsonwebtoken';

try {
  const decoded = jwt.verify(token, 'shhhhh');
  console.log(decoded);
} catch(err) {
  // handle token verification error
}

Decoding Tokens

This feature allows for the decoding of a JWT without verifying its signature. The `decode` method returns the payload of the token. This is useful for cases where you just need to read the token's payload without needing to validate it.

import jwt from 'jsonwebtoken';

const decoded = jwt.decode(token, { complete: true });
console.log(decoded);

Other packages similar to @types/jsonwebtoken

jsonwebtoken

The jsonwebtoken package is the core library that @types/jsonwebtoken provides types for. It offers the actual implementation for creating, verifying, and decoding JWTs without built-in TypeScript support.

jose

A comprehensive library for JSON Object Signing and Encryption (JOSE). It provides functionalities similar to jsonwebtoken but with additional features for handling JOSE standards like JWE, JWK, JWS, and more. It's a more feature-rich option compared to jsonwebtoken, with built-in TypeScript types.

oauth2-server

While not directly comparable to jsonwebtoken as it's a library for implementing OAuth2 servers, oauth2-server can use JWTs as part of the OAuth2 flow. It's a higher-level package compared to jsonwebtoken, focusing on the OAuth2 protocol rather than just JWT operations.

README

Installation

npm install --save @types/jsonwebtoken

Summary

This package contains type definitions for jsonwebtoken (https://github.com/auth0/node-jsonwebtoken).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/jsonwebtoken.

Additional Details

• Last updated: Fri, 23 Dec 2022 23:02:41 GMT
• Dependencies: @types/node
• Global values: none

Credits

These definitions were written by Maxime LUCE, Daniel Heim, Brice BERNARD, Veli-Pekka Kestilä, Daniel Parker, Kjell Dießel, Robert Gajda, Nico Flaig, Linus Unnebäck, Ivan Sieder, Piotr Błażejewicz, and Nandor Kraszlan.