set-error-message

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.

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 is an ES module and must be loaded using an import or import() statement, not require().

API

setErrorMessage(error, newMessage, currentMessage?)

error Error | any
newMessage string
currentMessage string?
Return value: Error

Sets error.message = newMessage.

Returns error. If error is not an Error instance, it is converted to one.

If error.stack contains currentMessage, it is replaced by newMessage. currentMessage is the error message currently included in error.stack. It defaults to error.message, which is usually best.

Related projects

• modern-errors: Handle errors like it's 2022 🔮
• error-custom-classes: Create multiple error classes
• error-custom-class: Create one error class
• error-class-utils: Utilities to properly create error classes
• error-serializer: Convert errors to/from plain objects
• normalize-exception: Normalize exceptions/errors
• merge-error-cause: Merge an error with its cause
• set-error-class: Properly update an error's class
• set-error-props: Properly update an error's properties
• error-cause-polyfill: Polyfill error.cause
• handle-cli-error: 💣 Error handler for CLI applications 💥
• log-process-errors: Show some ❤ to Node.js process errors

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!

Changelog

1.2.0

Features

• Improve handling empty error messages