ehmicky
Properly update an error's class.
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.
Features
- Sets an error's prototype, name and constructor
- Update the error's
stackwith its newname - 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-classThis 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
setErrorClass(error, ErrorClass)
error Error | unknown\
ErrorClass typeof Error\
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.
It is updated accordingly.
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 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 anErrorinstanceset-error-message: Properly update an error's messagewrap-error-message: Properly wrap an error's messageset-error-props: Properly update an error's propertiesset-error-stack: Properly update an error's stackmerge-error-cause: Merge an error with itscauseerror-cause-polyfill: Polyfillerror.causehandle-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!