You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

readme.md 1.5 KiB

3 years ago
1234567891011121314151617181920212223242526272829303132333435363738394041424344
  1. # 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)
  2. > Track the list of currently unhandled promise rejections.
  3. ## Install
  4. ```
  5. $ npm install --save currently-unhandled
  6. ```
  7. ## Usage
  8. ```js
  9. const currentlyUnhandled = require('currently-unhandled')(); // <- note the invocation
  10. var fooError = new Error('foo');
  11. var p = Promise.reject(new Error('foo'));
  12. // on the next tick - unhandled rejected promise is added to the list:
  13. currentlyUnhandled();
  14. //=> [{promise: p, reason: fooError}]'
  15. p.catch(() => {});
  16. // on the next tick - handled promise is now removed from the list:
  17. currentlyUnhandled();
  18. //=> [];
  19. ```
  20. ## API
  21. ### currentlyUnhandled()
  22. 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.
  23. ## Browser Support
  24. 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.
  25. ## License
  26. MIT © [James Talmage](http://github.com/jamestalmage)