Show some ❤️ to Node.js process errors
The npm package size has been reduced by 98%, from 4500kB to 87kB.
The log
option was renamed to onError
. Its arguments are (originalError, event)
instead of (error, level, originalError)
.
The process error event
is now passed as a second argument instead of being set as error.name
. Its case is not capitalized anymore, to match the event name in Node.js.
Before:
logProcessErrors({
log(error) {
if (error.name === 'UncaughtException') {
console.error(error)
}
},
})
After:
logProcessErrors({
onError(error, event) {
if (event === 'uncaughtException') {
console.error(error)
}
},
})
Errors are not pretty-printed anymore. As a consequence, the colors
option was removed too. The onError
option can be used instead to customize how the errors are printed.
The levels
option was removed. The onError
option can be used for filtering.
Before:
logProcessErrors({
levels: {
warning: 'silent',
},
})
After:
logProcessErrors({
onError(error, event) {
if (event !== 'warning') {
console.error(error)
}
},
})
The testing
option was removed. The onError
option can be used instead.
Before:
logProcessErrors({ testing: 'ava' })
After:
logProcessErrors({
// Throw the `error` to make the unit test fail while letting other tests run
onError(error) {
throw error
},
})
The exitOn
option was changed from an array of strings to a simpler boolean. It was also renamed exit
.
The exit is still graceful, i.e. it waits for ongoing tasks to complete, up to 3 seconds. However, if there are none, the process now exits immediately.
Before:
logProcessErrors({ exitOn: [] })
After:
logProcessErrors({ exit: false })
If other libraries (such as Winston, Bugsnag, etc.) are also listening for process events, they might also try to exit the process. This created conflicts with this library. This has been fixed by making the exit
option default to false
when process events listeners already exist.
--unhandled-rejections=strict
error.stack
is undefined
or null
TypeScript types have been simplified.
Added 100% test coverage.