set-error-stack

Properly update an error's stack.

In V8 (Chrome, Node.js, Deno, etc.), error.stack includes error.message. However, if error.stack is modified, error.message is not updated accordingly. This library fixes it.

In other JavaScript engines, this library just sets error.stack.

Example

Without set-error-stack:

const error = new Error('one')
console.log(error.stack) // 'Error: one ...'
console.log(error.message) // 'one'

error.stack = error.stack.replace('one', 'two')
console.log(error.stack) // 'Error: two ...'
console.log(error.message) // 'one'

With set-error-stack:

import setErrorStack from 'set-error-stack'

const error = new Error('one')
console.log(error.stack) // 'Error: one ...'
console.log(error.message) // 'one'

setErrorStack(error, error.stack.replace('one', 'two'))
console.log(error.stack) // 'Error: two ...'
console.log(error.message) // 'two'

Install

npm install set-error-stack

This package works in both Node.js >=16.17.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

setErrorStack(error, stack)

error Error | any
stack string
Return value: Error

Sets error.stack = stack. If needed, also modifies error.message accordingly.

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 way
• 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
• is-error-instance: Check if a value is an Error instance
• merge-error-cause: Merge an error with its cause
• set-error-class: Properly update an error's class
• set-error-message: Properly update an error's message
• wrap-error-message: Properly wrap an error's message
• 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
• error-http-response: Create HTTP error responses
• winston-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!

Changelog

2.0.0

Breaking changes

• Minimal supported Node.js version is now 16.17.0