Get unlimited public & private packages + package-based permissions with npm Pro.Get started »

jwt-service

5.0.0 • Public • Published

jwt-service

A simple wrapper for a simpler JWT surface API

GitHub license Build status Coverage Status NPM version Dependency Status devDependency Status Package Quality Code Climate

This wrapper is directly usable with Knifecycle.

API

Functions

initJWTService(services)Promise.<JWTService>

Instantiate the JWT service

Typedefs

JWTService

initJWTService(services) ⇒ Promise.<JWTService>

Instantiate the JWT service

Kind: global function
Returns: Promise.<JWTService> - A promise of the jwt service

Param Type Description
services Object The services to inject
services.JWT function The JWT service configuration object
[services.log] function A logging function
[services.time] function A function returning the current timestamp

Example

import initJWTService from 'jwt-service';
 
const jwt = await initJWTService({
  JWT: {
    secret: 'secret',
    duration: '2d',
    tolerance: '2h',
    algorithms: ['HS256'],
  },
  log: console.log.bind(console),
  time: Date.now.bind(Date),
});
 
const token = await jwt.sign({ my: 'payload' });

JWTService

Kind: global typedef

JWTService.sign(payload, [algorithm]) ⇒ Promise.<JWTSignResult>

Sign the given payload

Kind: static method of JWTService
Returns: Promise.<JWTSignResult> - A promise to be resolved with the signed token.

Param Type Description
payload Object The payload to sign
[algorithm] String The signing algorithm

Example

const token = await jwt.sign({ my: 'payload' });

JWTService.verify([token]) ⇒ Promise.<Object>

Verify and decode the given token

Kind: static method of JWTService
Returns: Promise.<Object> - A promise to be resolved with the token payload.

Param Type Description
[token] String The token to decode

Example

const payload = await jwt.verify('my.jwt.token');

Authors

License

MIT

Install

npm i jwt-service

DownloadsWeekly Downloads

21

Version

5.0.0

License

MIT

Unpacked Size

70 kB

Total Files

15

Last publish

Collaborators

  • avatar