Package Exports

err-code

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 (err-code) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

err-code

Create new error instances with a code and additional properties.

Installation

$ npm install err-code - NPM
$ bower install err-code - bower

The browser file is named index.umd.js which supports CommonJS, AMD and globals (errCode).

Why

I find myself doing this repeatedly:

var err = new Error('My message');
err.code = 'SOMECODE';
err.detail = 'Additional information about the error';
throw err;

Usage

Simple usage.

var errcode = require('err-code');

// fill error with message + code
throw errcode(new Error('My message'), 'ESOMECODE');
// fill error with message + code + props
throw errcode(new Error('My message'), 'ESOMECODE', { detail: 'Additional information about the error' });
// fill error with message + props
throw errcode(new Error('My message'), { detail: 'Additional information about the error' });


// You may also pass a string in the first argument and an error will be automatically created
// for you, though the stack trace will contain err-code in it.

// create error with message + code
throw errcode('My message', 'ESOMECODE');
// create error with message + code + props
throw errcode('My message', 'ESOMECODE', { detail: 'Additional information about the error' });
// create error with message + props
throw errcode('My message', { detail: 'Additional information about the error' });

Tests

$ npm test

License

Released under the MIT License.