Show some ❤️ to Node.js process errors.
This improves process errors: uncaught exceptions, unhandled promises, promises handled too late and warnings.
Hire me
Please reach out if you're looking for a Node.js API or CLI engineer (11 years of experience). Most recently I have been Netlify Build's and Netlify Plugins' technical lead for 2.5 years. I am available for full-time remote positions.
Features
- Stack traces for warnings and
rejectionHandled - Single event handler for all process errors
- Ignore duplicate process errors
- Normalize invalid errors
- Process exit is graceful and can be prevented
Install
Production code (e.g. a server) can install this either as a production or development dependency:
npm install log-process-errorsHowever, libraries should install this as a development dependency:
npm install -D log-process-errorsThis is because logging is modified globally and libraries users might not expect this side-effect. Also, this might lead to conflicts between libraries.
This package works in Node.js >=18.18.0.
This is an ES module. It must be loaded using
an import or import() statement,
not require(). If TypeScript is used, it must be configured to
output ES modules,
not CommonJS.
API
logProcessErrors(options?)
options object?
Return value: () => void
Start handling process errors.
import logProcessErrors from 'log-process-errors'
logProcessErrors(options)The return value restores Node.js default behavior.
const restore = logProcessErrors(options)
restore()Options
exit
Type: boolean
Whether to exit the process on uncaught exceptions or unhandled promises.
This is false by default if other libraries are listening to those events, so
they can perform the exit instead. Otherwise, this is true.
If some tasks are still ongoing, the exit waits for them to complete up to 3 seconds.
onError
Type: (error, event) => Promise<void> | void
Default: console.error(error)
Function called once per process error. Duplicate process errors are ignored.
// Log process errors with Winston instead
logProcessErrors({
onError: (error, event) => {
winstonLogger.error(error.stack)
},
})error
Type: Error
The process error. This is guaranteed to be a normalized error instance. A short description of the event is also appended to its message.
event
Type: Event
Process event name among:
'uncaughtException',
'unhandledRejection',
'rejectionHandled',
'warning'.
Related projects
modern-errors: Handle errors in a simple, stable, consistent waymodern-errors-process: Handle process errorserror-custom-class: Create one error classerror-class-utils: Utilities to properly create error classeserror-serializer: Convert errors to/from plain objectsnormalize-exception: Normalize exceptions/errorsis-error-instance: Check if a value is anErrorinstancemerge-error-cause: Merge an error with itscauseset-error-class: Properly update an error's classset-error-message: Properly update an error's messagewrap-error-message: Properly wrap an error's messageset-error-props: Properly update an error's propertiesset-error-stack: Properly update an error's stackerror-cause-polyfill: Polyfillerror.causehandle-cli-error: 💣 Error handler for CLI applications 💥error-http-response: Create HTTP error responseswinston-error-format: Log errors with Winston
Support
For any question, don't hesitate to submit an issue on GitHub.
Everyone is welcome regardless of personal background. We enforce a Code of conduct in order to promote a positive and inclusive environment.
Contributing
This project was made with ❤️. The simplest way to give back is by starring and sharing it online.
If the documentation is unclear or has a typo, please click on the page's Edit
button (pencil icon) and suggest a correction.
If you would like to help us fix a bug or add a new feature, please check our guidelines. Pull requests are welcome!
Thanks go to our wonderful contributors:
 ehmicky 💻 🎨 🤔 📖 |
 Steven Vachon 💬 |
 Hongarc 📖 💻 |
 Andy Brenneke 🐛 |