modern-errors
plugin to handle process
errors.

This improves process errors:
uncaught
exceptions,
unhandled
promises, promises
handled too late
and warnings.

Features

- Stack traces for warnings and
rejectionHandled
- Single event handler for all process errors
- Set any process error's class to
UnknownError
- Ignore duplicate process errors
- Normalize invalid errors
- Process exit is graceful and can be prevented

Example

Adding the plugin to
modern-errors.

``js
import ModernError from 'modern-errors'

import modernErrorsProcess from 'modern-errors-process'

export const BaseError = ModernError.subclass('BaseError', {
plugins: [modernErrorsProcess],
})
export const UnknownError = BaseError.subclass('UnknownError')
// ...
`

Initializing the process error handler.

`js
UnknownError.logProcess()
`

Install

Production code (e.g. a server) can install this either as a production or as a
development dependency.

`bash
npm install modern-errors-process
`

However, libraries should install this as a development dependency.

`bash
npm install -D modern-errors-process
`

This 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 requires 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

modernErrorsProcess

_Type_: Plugin

Plugin object to pass to the
plugins option of
ErrorClass.subclass().

ErrorClass.logProcess()

_Return value_: () => void

Start handling process errors.

The return value restores Node.js default behavior.

`js
const restore = UnknownError.logProcess()
restore()
`

Options

_Type_: object

$3

_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.

$3

_Type_: (error, event) => Promise | void\
_Default_: console.error(error)

Function called once per process error. Duplicate process errors are ignored.

#### error

_Type_:
UnknownError

The process error. This is guaranteed to be a
normalized
UnknownError
instance. A short description of the event is also appended to its
message.

#### event

_Type_: Event

Process event name among:
'uncaughtException',
'unhandledRejection',
'rejectionHandled',
'warning'.

Configuration

Options must be passed either to
ModernError.subclass().

`js
export const BaseError = ModernError.subclass('BaseError', {
plugins: [modernErrorsProcess],
process: options,
})
`

To
UnknownError.subclass().

`js
export const UnknownError = BaseError.subclass('UnknownError', {
process: options,
})
`

Or to UnknownError.logProcess().

`js
UnknownError.logProcess(options)
`

Related projects

- log-process-errors: Show
some ❤ to Node.js process errors
- modern-errors: Handle errors in
a simple, stable, consistent way
- modern-errors-cli: Handle
errors in CLI modules
- modern-errors-bugs: Print
where to report bugs
- modern-errors-serialize:
Serialize/parse errors
- modern-errors-clean: Clean
stack traces
- modern-errors-http: Create
HTTP error responses
- modern-errors-winston:
Log errors with Winston
- modern-errors-switch:
Execute class-specific logic

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!