summaryrefslogtreecommitdiff
path: root/deps/npm/node_modules/pacote/node_modules/promise-retry/node_modules/err-code/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'deps/npm/node_modules/pacote/node_modules/promise-retry/node_modules/err-code/README.md')
-rw-r--r--deps/npm/node_modules/pacote/node_modules/promise-retry/node_modules/err-code/README.md72
1 files changed, 72 insertions, 0 deletions
diff --git a/deps/npm/node_modules/pacote/node_modules/promise-retry/node_modules/err-code/README.md b/deps/npm/node_modules/pacote/node_modules/promise-retry/node_modules/err-code/README.md
new file mode 100644
index 0000000000..19a390df08
--- /dev/null
+++ b/deps/npm/node_modules/pacote/node_modules/promise-retry/node_modules/err-code/README.md
@@ -0,0 +1,72 @@
+# err-code
+
+[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency status][david-dm-image]][david-dm-url] [![Dev Dependency status][david-dm-dev-image]][david-dm-dev-url]
+
+[npm-url]:https://npmjs.org/package/err-code
+[downloads-image]:http://img.shields.io/npm/dm/err-code.svg
+[npm-image]:http://img.shields.io/npm/v/err-code.svg
+[travis-url]:https://travis-ci.org/IndigoUnited/js-err-code
+[travis-image]:http://img.shields.io/travis/IndigoUnited/js-err-code/master.svg
+[david-dm-url]:https://david-dm.org/IndigoUnited/js-err-code
+[david-dm-image]:https://img.shields.io/david/IndigoUnited/js-err-code.svg
+[david-dm-dev-url]:https://david-dm.org/IndigoUnited/js-err-code#info=devDependencies
+[david-dm-dev-image]:https://img.shields.io/david/dev/IndigoUnited/js-err-code.svg
+
+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:
+
+```js
+var err = new Error('My message');
+err.code = 'SOMECODE';
+err.detail = 'Additional information about the error';
+throw err;
+```
+
+
+## Usage
+
+Simple usage.
+
+```js
+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](http://www.opensource.org/licenses/mit-license.php).