node-vitals/test/helpers/valid-err.js

Do more with less. A simple, high-performing, functional JavaScript library.

/**
 * -----------------------------------------------------------------------------
 * VITALS UNIT TESTS HELPER: validErr
 * -----------------------------------------------------------------------------
 * @author Adam Smith <adam@imaginate.life> (https://github.com/imaginate)
 * @copyright 2017 Adam A Smith <adam@imaginate.life> (https://github.com/imaginate)
 *
 * Annotations:
 * @see [JSDoc3](http://usejsdoc.org)
 * @see [Closure Compiler JSDoc Syntax](https://developers.google.com/closure/compiler/docs/js-for-compiler)
 */

'use strict';

module.exports = validErr;

var is = require('./is');

/**
 * @param {!Error} err
 * @return {boolean}
 */
function validErr(err) {
  return is.err(err) && err.vitals === true && err.name === 'Error';
}