@types/passport-jwt

What is @types/passport-jwt?

@types/passport-jwt provides TypeScript type definitions for the passport-jwt library, which is a Passport strategy for authenticating with a JSON Web Token (JWT). This package allows developers to use TypeScript's type-checking features when working with passport-jwt, ensuring better code quality and reducing runtime errors.

What are @types/passport-jwt's main functionalities?

JWT Strategy Configuration

This feature allows you to configure the JWT strategy for Passport. The code sample demonstrates how to set up the strategy with options for extracting the JWT from the authorization header and specifying the secret key.

const JwtStrategy = require('passport-jwt').Strategy;
const ExtractJwt = require('passport-jwt').ExtractJwt;
const opts = {
  jwtFromRequest: ExtractJwt.fromAuthHeaderAsBearerToken(),
  secretOrKey: 'your_jwt_secret'
};
passport.use(new JwtStrategy(opts, (jwt_payload, done) => {
  User.findOne({id: jwt_payload.sub}, (err, user) => {
    if (err) {
      return done(err, false);
    }
    if (user) {
      return done(null, user);
    } else {
      return done(null, false);
    }
  });
}));

JWT Authentication Middleware

This feature allows you to protect routes using JWT authentication. The code sample shows how to use the configured JWT strategy as middleware in an Express route to protect it from unauthorized access.

const express = require('express');
const passport = require('passport');
const app = express();
app.use(passport.initialize());
app.get('/protected', passport.authenticate('jwt', { session: false }), (req, res) => {
  res.json({ message: 'You have accessed a protected route!' });
});

Other packages similar to @types/passport-jwt

@types/passport

@types/passport provides TypeScript type definitions for the core Passport library. While @types/passport-jwt focuses on JWT authentication, @types/passport provides types for the core Passport functionalities, including session management and other authentication strategies.

@types/jsonwebtoken

@types/jsonwebtoken provides TypeScript type definitions for the jsonwebtoken library, which is used to sign and verify JWTs. While @types/passport-jwt is used for integrating JWTs with Passport, @types/jsonwebtoken focuses on the creation and validation of JWTs themselves.

@types/express

@types/express provides TypeScript type definitions for the Express framework. While it does not directly relate to JWT authentication, it is often used in conjunction with @types/passport-jwt to build web applications that require authentication.

README

Installation

npm install --save @types/passport-jwt

Summary

This package contains type definitions for passport-jwt (https://github.com/themikenicholson/passport-jwt).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/passport-jwt.

Additional Details

• Last updated: Fri, 26 Jan 2024 06:07:46 GMT
• Dependencies: @types/jsonwebtoken, @types/passport-strategy

Credits

These definitions were written by TANAKA Koichi, Alex Young, Carlos Eduardo Scheffer, Byungjin Kim, and Svyatoslav Bychkov.