diff options
author | Florian Dold <florian.dold@gmail.com> | 2016-10-10 03:43:44 +0200 |
---|---|---|
committer | Florian Dold <florian.dold@gmail.com> | 2016-10-10 03:43:44 +0200 |
commit | abd94a7f5a50f43c797a11b53549ae48fff667c3 (patch) | |
tree | ab8ed457f65cdd72e13e0571d2975729428f1551 /node_modules/currently-unhandled/readme.md | |
parent | a0247c6a3fd6a09a41a7e35a3441324c4dcb58be (diff) | |
download | wallet-core-abd94a7f5a50f43c797a11b53549ae48fff667c3.tar.xz |
add node_modules to address #4364
Diffstat (limited to 'node_modules/currently-unhandled/readme.md')
-rw-r--r-- | node_modules/currently-unhandled/readme.md | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/node_modules/currently-unhandled/readme.md b/node_modules/currently-unhandled/readme.md new file mode 100644 index 000000000..b73c56838 --- /dev/null +++ b/node_modules/currently-unhandled/readme.md @@ -0,0 +1,44 @@ +# currently-unhandled [![Build Status](https://travis-ci.org/jamestalmage/currently-unhandled.svg?branch=master)](https://travis-ci.org/jamestalmage/currently-unhandled) [![Coverage Status](https://coveralls.io/repos/github/jamestalmage/currently-unhandled/badge.svg?branch=master)](https://coveralls.io/github/jamestalmage/currently-unhandled?branch=master) + +> Track the list of currently unhandled promise rejections. + + +## Install + +``` +$ npm install --save currently-unhandled +``` + + +## Usage + +```js +const currentlyUnhandled = require('currently-unhandled')(); // <- note the invocation + +var fooError = new Error('foo'); +var p = Promise.reject(new Error('foo')); + +// on the next tick - unhandled rejected promise is added to the list: +currentlyUnhandled(); +//=> [{promise: p, reason: fooError}]' + +p.catch(() => {}); + +// on the next tick - handled promise is now removed from the list: +currentlyUnhandled(); +//=> []; +``` + +## API + +### currentlyUnhandled() + +Returns an array of objects with `promise` and `reason` properties representing the rejected promises that currently do not have a rejection handler. The list grows and shrinks as unhandledRejections are published, and later handled. + +## Browser Support + +This module can be bundled with `browserify`. At time of writing, it will work with native Promises in the Chrome browser only. For best cross-browser support, use `bluebird` instead of native Promise support in browsers. + +## License + +MIT © [James Talmage](http://github.com/jamestalmage) |