set-error-class

Properly update an error's class.

Features

• Sets an error's prototype, name and constructor
• Update the error's stack with its new name
• Handles invalid errors

Example

import setErrorClass from 'set-error-class'

const typeError = new TypeError('test')
console.log(typeError instanceof TypeError) // true
console.log(typeError.name) // 'TypeError'
console.log(typeError.constructor) // TypeError
console.log(typeError.stack) // TypeError: test ...

const rangeError = setErrorClass(typeError, RangeError)
console.log(rangeError === typeError) // true
console.log(rangeError instanceof RangeError) // true
console.log(rangeError.name) // 'RangeError'
console.log(rangeError.constructor) // RangeError
console.log(rangeError.stack) // RangeError: test ...

Install

npm install set-error-class

This package is an ES module and must be loaded using an import or import() statement, not require().

API

setErrorClass(error, ErrorClass, currentName?)

error Error | unknown
ErrorClass typeof Error
currentName string?
Return value: Error

Sets the error's prototype, name and constructor.

Usage

Invalid errors

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

error.stack

In V8 (Chrome, Node.js, Deno, etc.), error.stack includes error.name. If error.stack contains currentName (which defaults to the current error.name), it is replaced with the new error.name.

Error constructors

ErrorClass is assigned to error, but its constructor is not called. In some instances, this might lead to invalid errors. If ErrorClass's constructor is doing anything significant, that logic should be performed on error as well.

Related projects

• modern-errors: Handle errors like it's 2022 🔮
• 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
• set-error-message: Properly update an error's message
• set-error-props: Properly update an error's properties
• merge-error-cause: Merge an error with its cause
• 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!