What is uncaughtException in Node.js: Explanation and Usage

uncaughtException is an event in Node.js that triggers when an error is thrown but not caught anywhere in the code. It allows you to handle unexpected errors globally before the program crashes.

How It Works

Imagine your Node.js program is like a kitchen where you cook meals (run code). Sometimes, mistakes happen, like dropping an ingredient (an error). Usually, you catch these mistakes right away and fix them (try-catch blocks). But if a mistake slips past all your checks, the uncaughtException event acts like a safety net catching that mistake before the kitchen closes (program crashes).

This event listens for any error that was not handled anywhere else. When such an error happens, Node.js emits the uncaughtException event, giving you a chance to log the error or clean up resources. However, because the program state might be unstable after such an error, it is recommended to restart the program after handling it.

Example

This example shows how to listen for uncaughtException and handle an error that was not caught anywhere else.

javascript

process.on('uncaughtException', (err) => {
  console.log('Caught an unhandled error:', err.message);
  // Usually, you should exit the process after handling
  process.exit(1);
});

// This will throw an error that is not caught
setTimeout(() => {
  throw new Error('Oops! Something went wrong');
}, 100);

Output

Caught an unhandled error: Oops! Something went wrong

When to Use

You use uncaughtException as a last-resort safety net to catch errors that slip through your normal error handling. It helps you log unexpected problems and perform cleanup before your program stops.

For example, in a server application, you might want to log the error and close database connections gracefully before restarting the server. However, relying on this event for regular error handling is not recommended because the program might be in an unstable state.

Key Points

• uncaughtException catches errors not handled anywhere else.
• It helps log errors and clean up before the program crashes.
• Use it only as a last-resort safety net, not for normal error handling.
• After handling, it is best to restart the Node.js process.

Key Takeaways

uncaughtException handles errors that escape all try-catch blocks in Node.js.

It allows logging and cleanup before the program crashes unexpectedly.

Use it only as a last-resort safety net, not for regular error handling.

Always restart your Node.js process after catching an uncaught exception.