https://github.com/sindresorhus/hard-rejection

Make unhandled promise rejections fail hard right away instead of the default silent fail
https://github.com/sindresorhus/hard-rejection

Last synced: about 2 months ago
JSON representation

Make unhandled promise rejections fail hard right away instead of the default silent fail

• Host: GitHub
• URL: https://github.com/sindresorhus/hard-rejection
• Owner: sindresorhus
• License: mit
• Created: 2016-08-27T20:02:58.000Z (almost 8 years ago)
• Default Branch: main
• Last Pushed: 2022-07-08T12:05:27.000Z (almost 2 years ago)
• Last Synced: 2024-04-18T07:23:59.200Z (2 months ago)
• Language: JavaScript
• Size: 14.6 KB
• Stars: 106
• Watchers: 6
• Forks: 8
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • Funding: .github/funding.yml
  • License: license
  • Security: .github/security.md

Lists

• awesome-promises - hard-rejection - Make unhandled promise rejections fail hard right away instead of the default silent fail (Convenience Utilities / sindresorhus's many Promise utilities ([see notes](https://github.com/sindresorhus/promise-fun)))
• awesome-stars - hard-rejection - Make unhandled promise rejections fail hard right away instead of the default silent fail (JavaScript)
• awesome-stars - hard-rejection - Make unhandled promise rejections fail hard right away instead of the default silent fail (JavaScript)

README

        
# hard-rejection

> Make unhandled promise rejections fail hard right away instead of the default [silent fail](https://gist.github.com/benjamingr/0237932cee84712951a2)

Promises fail silently if you don't attach a `.catch()` handler.

This module exits the process with an error message right away when an unhandled rejection is encountered.


**Note: That might not be desirable as unhandled rejections can be [handled at a future point in time](https://nodejs.org/api/process.html#process_event_unhandledrejection), although not common. You've been warned.**

Intended for top-level long-running processes like servers, **but not in reusable modules.**


For command-line apps and tests, see [`loud-rejection`](https://github.com/sindresorhus/loud-rejection).

**With [Node.js 15](https://medium.com/@nodejs/node-js-v15-0-0-is-here-deb00750f278), this package is moot as the default behavior then is to throw on unhandled rejections.**

## Install

```

$ npm install hard-rejection

```

## Usage

```js

const hardRejection = require('hard-rejection');

const promiseFunction = require('some-promise-fn');

// Install the handler

hardRejection();

promiseFunction();

```

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

```js

const promiseFunction = require('some-promise-fn');

function error(error) {

	console.error(error.stack);

	process.exit(1);

}

promiseFunction().catch(error);

```

### Register script

Alternatively to the above, you may simply require `hard-rejection/register` and the handler will be automagically installed for you.

This is handy for ES2015 imports:

```js

import 'hard-rejection/register';

```

## API

### hardRejection([log])

#### log

Type: `Function`


Default: `console.error`

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

## Related

- [loud-rejection](https://github.com/sindresorhus/loud-rejection) - Make unhandled promise rejections fail loudly instead of the default silent fail

- [More…](https://github.com/sindresorhus/promise-fun)

## License

MIT © [Sindre Sorhus](https://sindresorhus.com)