1. module json-web-token
   1. function json-web-token.JWTError (message)
   2. function json-web-token.JWTError.super_ ()
   3. function json-web-token.decode (key, token, cb)
   4. function json-web-token.encode (key, data, algorithm, cb)
   5. function json-web-token.getAlgorithms ()
2. module json-web-token.JWTError
   1. function json-web-token.JWTError (message)
   2. function json-web-token.JWTError.super_ ()
3. module json-web-token.JWTError.super_
   1. function json-web-token.JWTError.super_ ()
   2. function json-web-token.JWTError.super_.captureStackTrace ()
   3. number json-web-token.JWTError.super_.stackTraceLimit

module json-web-token

function json-web-token.JWTError (message)

• description and source-code

  function JWTError(message) {
    Error.call(this)
    Error.captureStackTrace(this, this.constructor)
    this.name = this.constructor.name
    this.message = message
  }

• example usage

  n/a

function json-web-token.JWTError.super_ ()

• description and source-code

  function Error() { [native code] }

• example usage

  n/a

function json-web-token.decode (key, token, cb)

• description and source-code

  function decode(key, token, cb) {
    if (paramsAreFalsy(key, token)) {
      return prcResult('The key and token are mandatory!', null, cb)
    }
  
    const parts = token.split('.')
  
    // check all parts're present
    if (parts.length !== 3) {
      return prcResult(
        'The JWT should consist of three parts!',
        null,
        cb
      )
    }
  
    // base64 decode and parse JSON
    const header = JSONParse(b64url.decode(parts[0]))
    const payload = JSONParse(b64url.decode(parts[1]))
  
    // get algorithm hash and type and check if is valid
    const algorithm = algorithms[header.alg]
  
    if (!algorithm) {
      return prcResult('The algorithm is not supported!', null, cb)
    }
  
    // verify the signature
    const res = verify(
      algorithm,
      key,
      parts.slice(0, 2).join('.'),
      parts[2]
    )
  
    return prcResult(!res && 'Invalid key!' || null, payload, header, cb)
  }

• example usage

  ...
  jwt.encode(secret, payload, function (err, token) {
  if (err) {
    console.error(err.name, err.message);
  } else {
    console.log(token);
  
    // decode
    jwt.decode(secret, token, function (err_, decodedPayload, decodedHeader) {
      if (err) {
        console.error(err.name, err.message);
      } else {
        console.log(decodedPayload, decodedHeader);
      }
    });
  }
  ...

function json-web-token.encode (key, data, algorithm, cb)

• description and source-code

  function encode(key, data, algorithm, cb) {
    if (paramIsValid(algorithm, 'function')) {
      cb = algorithm
      algorithm = 'HS256'
    }
  
    var defaultHeader = {typ: 'JWT', alg: algorithm}
  
    var payload = isObject(data) && data.payload ?
      data.payload :
      data
  
    var header = isObject(data) && data.header ?
      extend(data.header, defaultHeader) :
      defaultHeader
  
    const validationError = encodeValidations(key, payload, algorithm)
  
    if (validationError) {
      return prcResult(validationError, null, cb)
    }
  
    const parts = b64url.encode(JSON.stringify(header)) +
      '.' +
      b64url.encode(JSON.stringify(payload))
  
    return prcResult(
      null,
      parts + '.' + sign(algorithms[algorithm], key, parts),
      cb
    )
  }

• example usage

  ...
  "status": "SUCCESS"
    }
  };
  
  var secret = 'TOPSECRETTTTT';
  
  // encode
  jwt.encode(secret, payload, function (err, token) {
    if (err) {
  console.error(err.name, err.message);
    } else {
  console.log(token);
  
  // decode
  jwt.decode(secret, token, function (err_, decodedPayload, decodedHeader) {
  ...

function json-web-token.getAlgorithms ()

• description and source-code

  function getAlgorithms() {
    return Object.keys(algorithms)
  }

• example usage

  n/a

module json-web-token.JWTError

function json-web-token.JWTError (message)

• description and source-code

  function JWTError(message) {
    Error.call(this)
    Error.captureStackTrace(this, this.constructor)
    this.name = this.constructor.name
    this.message = message
  }

• example usage

  n/a

function json-web-token.JWTError.super_ ()

• description and source-code

  function Error() { [native code] }

• example usage

  n/a

module json-web-token.JWTError.super_

function json-web-token.JWTError.super_ ()

• description and source-code

  function Error() { [native code] }

• example usage

  n/a

function json-web-token.JWTError.super_.captureStackTrace ()

• description and source-code

  function captureStackTrace() { [native code] }

• example usage

  ...
  
  //
  // JWT token error
  //
  
  function JWTError (message) {
    Error.call(this)
    Error.captureStackTrace(this, this.constructor)
    this.name = this.constructor.name
    this.message = message
  }
  
  inherits(JWTError, Error)
  
  //
  ...