Package Exports

human-error

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (human-error) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

human-error

Good errors for people to read.

First create your error codes:

// myfun-errors.js
const errors = require('human-error')({});

errors.MissingCallback = () => `
  myFun() expects a callback to be passed but nothing was passed.
`;

errors.InvalidCallback = ({ type }) => `
  myFun() expects the argument to be a callback function.
  ${type ? `"${type}" was passed instead.` : ''}
`;

module.exports = errors;

Then use them in your code:

// myfun.js
const errors = require('./myfun-errors');

module.exports = (cb) => {
  if (!cb) {
    throw new errors.MissingCallback();
  }
  if (!(cb instanceof Function)) {
    throw new errors.InvalidCallback({ type: typeof cb });
  }
  cb('Cool library!');
};

Options

url [false]: if there's an url to show more info. It can be a string in which case it will just be printed or a function that build the error such as (key) => 'https://example.com/errors#' + key so you can show the appropriate support url.
width [80]: the width of the row