Skip to content

Latest commit

 

History

History
395 lines (170 loc) · 6.46 KB

DOCUMENTATION.md

File metadata and controls

395 lines (170 loc) · 6.46 KB

@lykmapipo/jwt-common 0.4.1

Helper utilities for day to day jwt usage.

lib/index.js

withDefaults([optns])

merge provided options with defaults

Parameters
Name Type Description
optns Object provided options Optional
Examples
const { withDefaults } = require('@lykmapipo/jwt-common');
withDefaults({ secret: 'xo67Rw' }) // => { secret: 'xo67Rw', ...}
Returns
  • Object merged options with environment variables

encode(payload[, opts], cb)

encode given payload as jwt.

Parameters
Name Type Description
payload Object data to encode.  
opts Object jwt sign or encoding options. Optional
cb Function callback to invoke on success or failure.  
Examples
const { encode } = require('@lykmapipo/jwt-common');

const payload = { _id: 'xo5', permissions: ['user:read'] };

// encode with default options
encode(payload, (error, jwt) => { ... });

// encode with merged options
encode(payload, { secret: 'xo67Rw' }, (error, jwt) => { ... });
Returns
  • String Error jwt token if success or error.

decode(token[, opts], cb)

decode and verify given jwt.

Parameters
Name Type Description
token String jwt token to decode.  
opts Object jwt verify or decoding options. Optional
cb Function callback to invoke on success or failure.  
Examples
const { decode } = require('@lykmapipo/jwt-common');

const token = 'eyJhbGciOiJIUz...';

// decode with default options
decode(token, (error, payload) => { ... });

// decode with provided options
decode(token, { secret: 'xo67Rw' }, (error, payload) => { ... });
Returns
  • Payload Error payload if success or error.

refresh(token, payload[, opts], cb)

decode a given jwt, if expired return new jwt.

Parameters
Name Type Description
token String jwt token to refresh.  
payload Object data to encode.  
opts Object jwt verify or decoding options. Optional
cb Function callback to invoke on success or failure.  
Examples
const { refresh } = require('@lykmapipo/jwt-common');

const token = 'eyJhbGciOiJIUz...';
const payload = { _id: 'xo5', permissions: ['user:read'] };

// refresh with default options
refresh(token, payload, (error, jwt) => { ... });

// refresh with provided options
refresh(token, payload, { secret: 'xo67Rw' }, (error, jwt) => { ... });
Returns
  • String Error jwt token if success or error.

isExpired(token[, opts, cb])

check if jwt expired without verifying if the signature is valid.

Parameters
Name Type Description
token String jwt token to check for expiry.  
opts Object jwt verify or decoding options. Optional
cb Function callback to invoke on success or failure. Optional
Examples
const { isExpired } = require('@lykmapipo/jwt-common');

const token = 'eyJhbGciOiJIUz...';

// isExpired with default options
isExpired(token); //=> false

// isExpired with provided options
const optns = { clockTimestamp : Math.floor(Date.now() / 1000) }
isExpired(token, optns); //=> true
Returns
  • Boolean whether jwt expired.

decodeJwtToUser([opts]) private method

return a function used to decode jwt to user.

Parameters
Name Type Description
opts Object decoding options. Optional
opts.user Functon Optional
Returns
  • Function jwt to user decoder

parseJwtFromHttpHeaders(done)

parse request headers to get jwt.

Parameters
Name Type Description
done Function callback to invoke on success or failure.  
Examples
const { parseJwtFromHttpHeaders } = require('@lykmapipo/jwt-common');
parseJwtFromHttpHeaders(request, (error, jwt) => { ... });
Returns
  • Payload Error jwt if success or error.

parseJwtFromHttpQueryParams(done)

parse request headers to get jwt.

Parameters
Name Type Description
done Function callback to invoke on success or failure.  
Examples
const { parseJwtFromHttpQueryParams } = require('@lykmapipo/jwt-common');
parseJwtFromHttpQueryParams(request, (error, jwt) => { ... });
Returns
  • Payload Error jwt if success or error.

parseJwtFromHttpRequest(done)

parse request headers to get jwt.

Parameters
Name Type Description
done Function callback to invoke on success or failure.  
Examples
const { parseJwtFromHttpRequest } = require('@lykmapipo/jwt-common');
parseJwtFromHttpRequest(request, (error, jwt) => { ... });
Returns
  • Payload Error jwt if success or error.

jwtAuth([opts])

create middlware to authorize request using jwt

Parameters
Name Type Description
opts Object jwt verify or decoding options. Optional
Examples
const { jwtAuth } = require('@lykmapipo/jwt-common');

app.get('/users', jwtAuth({ secret: 'xo67Rw' }), (req, res, next) => { ... });
Returns
  • Function express compactoble middleware.

jwtPermit(requiredScopes)

create middlware to check request for jwt permissions(or scopes).

Parameters
Name Type Description
requiredScopes Array.<String> String required scopes or permissions.  
Examples
const { jwtPermit } = require('@lykmapipo/jwt-common');

app.get('/users', jwtPermit('user:read'), (req, res, next) => { ... });
Returns
  • Function express compactoble middleware.

Documentation generated with doxdox.