set-error-message
v3.0.0
Published
Properly update an error's message
Downloads
45,911
Maintainers
Readme
Properly update an error's message.
In V8 (Chrome, Node.js, Deno, etc.),
error.stack
includes
error.message
.
However, if error.message
is modified, error.stack
might not be updated and
still contain the previous message.
This library fixes it by setting error.message
while updating error.stack
accordingly. This works on any JavaScript engine.
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.
Example
Without set-error-message
:
const error = new Error('one')
console.log(error.message) // 'one'
console.log(error.stack) // 'Error: one ...'
error.message = 'two'
console.log(error.message) // 'two'
console.log(error.stack) // 'Error: one ...'
With set-error-message
:
import setErrorMessage from 'set-error-message'
const error = new Error('one')
console.log(error.message) // 'one'
console.log(error.stack) // 'Error: one ...'
setErrorMessage(error, 'two')
console.log(error.message) // 'two'
console.log(error.stack) // 'Error: two ...'
Install
npm install set-error-message
This package works in both Node.js >=18.18.0 and browsers.
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
setErrorMessage(error, newMessage)
error
Error | any
newMessage
string
Return value: Error
Sets error.message = newMessage
.
Returns error
. If error
is not an Error
instance, it is converted to one.
Related projects
modern-errors
: Handle errors in a simple, stable, consistent wayerror-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 anError
instancemerge-error-cause
: Merge an error with itscause
set-error-class
: Properly update an error's classwrap-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.cause
handle-cli-error
: 💣 Error handler for CLI applications 💥log-process-errors
: Show some ❤ to Node.js process errorserror-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!