A progressive Node.js framework for building efficient and scalable server-side applications, heavily inspired by Angular.
JWT utilities module for Nest based on the jsonwebtoken package.
$ npm i --save @nestjs/jwtImport JwtModule:
@Module({
imports: [JwtModule.register({ secretOrPrivateKey: 'key' })],
providers: [...],
})
export class AuthModule {}Inject JwtService:
@Injectable()
export class AuthService {
constructor(private readonly jwtService: JwtService) {}
}Quite often you might want to asynchronously pass your module options instead of passing them beforehand. In such case, use registerAsync() method, that provides a couple of various ways to deal with async data.
1. Use factory
JwtModule.registerAsync({
useFactory: () => ({
secretOrPrivateKey: 'key',
}),
})Obviously, our factory behaves like every other one (might be async and is able to inject dependencies through inject).
JwtModule.registerAsync({
imports: [ConfigModule],
useFactory: async (configService: ConfigService) => ({
secretOrPrivateKey: configService.getString('SECRET_KEY'),
}),
inject: [ConfigService],
}),2. Use class
JwtModule.registerAsync({
useClass: JwtConfigService,
})Above construction will instantiate JwtConfigService inside JwtModule and will leverage it to create options object.
class JwtConfigService implements JwtOptionsFactory {
createJwtOptions(): JwtModuleOptions {
return {
secretOrPrivateKey: 'key',
};
}
}3. Use existing
JwtModule.registerAsync({
imports: [ConfigModule],
useExisting: ConfigService,
}),It works the same as useClass with one critical difference - JwtModule will lookup imported modules to reuse already created ConfigService, instead of instantiating it on its own.
The JwtService uses jsonwebtoken underneath.
The sign method is an implementation of jsonwebtoken .sign().
The sign method is an implementation of jsonwebtoken .verify().
The sign method is an implementation of jsonwebtoken .decode().
The JwtModule takes an options object:
secretOrPrivateKeyread moresignOptionsread morepublicKeyPEM encoded public key for RSA and ECDSAverifyOptionsread more
Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please read more here.
- Author - Kamil Myśliwiec
- Website - https://nestjs.com
- Twitter - @nestframework
Nest is MIT licensed.