How do I use loud-rejection with ES modules?

Import 'loud-rejection/register' in your ES module code to automatically install the unhandled rejection handlers without additional setup. This works with import statements and ensures errors are logged before exit.

What's the difference between loud-rejection and hard-rejection?

loud-rejection logs errors and exits the process at the end if unhandled rejections remain, while hard-rejection fails immediately on unhandled rejections. Choose based on whether you need delayed or immediate failure.

Does loud-rejection work in Node.js 15 or later?

No, loud-rejection is moot in Node.js 15 and higher because the default behavior already throws on unhandled promise rejections. It's only useful for versions below 15 to address silent failures.

Can I customize the error logging in loud-rejection?

Yes, you can pass a custom logging function to loudRejection() to control how errors are printed, such as modifying the stack trace format or sending logs to an external service.

Why does loud-rejection always exit the process?

loud-rejection exits with code 1 to enforce that unhandled rejections cause a failure, making errors visible and preventing silent bugs, which aligns with its philosophy of loud failures.

Is loud-rejection suitable for browser projects?

No, loud-rejection is designed for Node.js only and is unnecessary in browsers, as unhandled rejections are already displayed in the console there.

Open-Awesome

loud-rejection

MITJavaScriptv2.2.0

Make unhandled promise rejections fail loudly and exit with code 1 instead of silently failing.

GitHub

282 stars16 forks0 contributors

What is loud-rejection?

loud-rejection is a Node.js library that makes unhandled promise rejections fail loudly by logging them and exiting the process. It solves the problem of silent failures in applications where promises might reject without proper error handling, ensuring developers don't miss critical bugs.

Target Audience

Node.js developers building CLI tools, tests, or applications who need to guarantee that unhandled promise rejections are visible and cause process failure.

Value Proposition

It provides a simple, zero-configuration way to enforce loud failures for unhandled rejections, reducing debugging time and preventing hidden errors in production environments.

Overview

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

Use Cases

Best For

Ensuring CLI tools exit with code 1 on unhandled promise rejections
Making test suites fail loudly when promises reject unexpectedly
Debugging applications with silent promise failures
Enforcing error visibility in Node.js apps before version 15
Adding global unhandled rejection handlers without boilerplate
Customizing how unhandled rejections are logged before exit

Not Ideal For

Projects using Node.js version 15 or higher, where default behavior already handles unhandled rejections
Reusable Node.js modules, as the README explicitly advises against it for library code
Browser-based applications, since it's designed only for Node.js environments
Applications requiring graceful error recovery without process termination, due to its forced exit on unhandled rejections

Pros & Cons

Pros

Simple Integration

Offers easy setup via require() or import, with automatic registration using 'loud-rejection/register', reducing boilerplate code for global error handling.

Ensures Error Visibility

Logs unhandled promise rejections to STDERR and exits with code 1, preventing silent failures that could hide critical bugs in production.

Custom Logging Support

Allows passing an optional logging function to control error output, providing flexibility for formatting or redirecting error messages.

Global Rejection Tracking

Monitors all promises globally, ensuring no unhandled rejection goes unnoticed, which is essential for debugging CLI tools and tests.

Cons

Obsolete in Modern Node.js

With Node.js 15 and above, the default behavior throws on unhandled rejections, making this package unnecessary and limiting its relevance for newer projects.

Forced Process Exit

Always terminates the process on unhandled rejections, which can be too aggressive for applications needing graceful shutdowns or error recovery mechanisms.

Limited Application Scope

Not recommended for reusable modules, restricting use to top-level applications like CLI tools and tests, as per the README's guidance.

Frequently Asked Questions

Related Projects

p-queue

Promise queue with concurrency control

Stars4,244

Forks213

Last commit2 days ago

p-limit

Run multiple promise-returning & async functions with limited concurrency

Stars2,906

Forks137

Last commit4 days ago

pify

Promisify a callback-style function

Map over promises concurrently

Stars1,504

Forks74