History

mn a0e4803194 test		11 months ago
..
api.js	test	11 months ago
index.js	test	11 months ago
license	test	11 months ago
package.json	test	11 months ago
readme.md	test	11 months ago
register.js	test	11 months ago

readme.md

loud-rejection

Make unhandled promise rejections fail loudly instead of the default silent fail

By default, promises fail silently if you don't attach a .catch() handler to them.

Use this in top-level things like tests, CLI tools, apps, etc, but not in reusable modules.
Not needed in the browser as unhandled promises are shown in the console.

Install

$ npm install --save loud-rejection

Usage

const loudRejection = require('loud-rejection');
const promiseFn = require('promise-fn');

// Install the unhandledRejection listeners
loudRejection();

promiseFn();

Without this module it's more verbose and you might even miss some that will fail silently:

const promiseFn = require('promise-fn');

function error(err) {
	console.error(err.stack);
	process.exit(1);
}

promiseFn().catch(error);

Register script

Alternatively to the above, you may simply require loud-rejection/register and the unhandledRejection listener will be automagically installed for you.

This is handy for ES2015 imports:

import 'loud-rejection/register';

API

loudRejection([log])

log

Type: Function
Default: console.error

Custom logging function to print the rejected promise. Receives the error stack.