Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ehmicky/set-error-class
Properly update an error's class.
https://github.com/ehmicky/set-error-class
browser code-quality error error-classes error-handler error-handling error-monitoring error-reporting errors exceptions javascript library monitoring name nodejs prototype stack stacktrace stacktraces typescript
Last synced: 3 months ago
JSON representation
Properly update an error's class.
- Host: GitHub
- URL: https://github.com/ehmicky/set-error-class
- Owner: ehmicky
- License: mit
- Created: 2022-08-29T17:12:21.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-14T16:52:56.000Z (4 months ago)
- Last Synced: 2024-10-11T10:17:07.837Z (3 months ago)
- Topics: browser, code-quality, error, error-classes, error-handler, error-handling, error-monitoring, error-reporting, errors, exceptions, javascript, library, monitoring, name, nodejs, prototype, stack, stacktrace, stacktraces, typescript
- Language: JavaScript
- Homepage:
- Size: 7.41 MB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://www.npmjs.com/package/set-error-class)
[](https://unpkg.com/set-error-class?module)
[](/src/main.d.ts)
[](https://codecov.io/gh/ehmicky/set-error-class)
[](https://bundlephobia.com/package/set-error-class)
[](https://fosstodon.org/@ehmicky)
[](https://medium.com/@ehmicky)
Properly update an error's class.
# Hire me
Please
[reach out](https://www.linkedin.com/feed/update/urn:li:activity:7117265228068716545/)
if you're looking for a Node.js API or CLI engineer (11 years of experience).
Most recently I have been [Netlify Build](https://github.com/netlify/build)'s
and [Netlify Plugins](https://www.netlify.com/products/build/plugins/)'
technical lead for 2.5 years. I am available for full-time remote positions.
# Features
- Sets an error's
[prototype, name and constructor](#seterrorclasserror-errorclass)
- Update the [error's `stack`](#errorstack) with its new `name`
- Handles [invalid errors](#invalid-errors)
# Example
```js
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
```bash
npm install set-error-class
```
This package works in both Node.js >=18.18.0 and
[browsers](https://raw.githubusercontent.com/ehmicky/dev-tasks/main/src/browserslist).
This is an ES module. It must be loaded using
[an `import` or `import()` statement](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c),
not `require()`. If TypeScript is used, it must be configured to
[output ES modules](https://www.typescriptlang.org/docs/handbook/esm-node.html),
not CommonJS.
# API
## setErrorClass(error, ErrorClass)
`error` `Error | unknown`\
`ErrorClass` `typeof Error`\
_Return value_: `Error`
Sets the `error`'s
[prototype](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/getPrototypeOf),
[`name`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error/name)
and
[`constructor`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/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`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error/stack)
includes
[`error.name`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error/message).
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`](https://github.com/ehmicky/modern-errors): Handle errors in
a simple, stable, consistent way
- [`error-custom-class`](https://github.com/ehmicky/error-custom-class): Create
one error class
- [`error-class-utils`](https://github.com/ehmicky/error-class-utils): Utilities
to properly create error classes
- [`error-serializer`](https://github.com/ehmicky/error-serializer): Convert
errors to/from plain objects
- [`normalize-exception`](https://github.com/ehmicky/normalize-exception):
Normalize exceptions/errors
- [`is-error-instance`](https://github.com/ehmicky/is-error-instance): Check if
a value is an `Error` instance
- [`set-error-message`](https://github.com/ehmicky/set-error-message): Properly
update an error's message
- [`wrap-error-message`](https://github.com/ehmicky/wrap-error-message):
Properly wrap an error's message
- [`set-error-props`](https://github.com/ehmicky/set-error-props): Properly
update an error's properties
- [`set-error-stack`](https://github.com/ehmicky/set-error-stack): Properly
update an error's stack
- [`merge-error-cause`](https://github.com/ehmicky/merge-error-cause): Merge an
error with its `cause`
- [`error-cause-polyfill`](https://github.com/ehmicky/error-cause-polyfill):
Polyfill `error.cause`
- [`handle-cli-error`](https://github.com/ehmicky/handle-cli-error): 💣 Error
handler for CLI applications 💥
- [`log-process-errors`](https://github.com/ehmicky/log-process-errors): Show
some ❤ to Node.js process errors
- [`error-http-response`](https://github.com/ehmicky/error-http-response):
Create HTTP error responses
- [`winston-error-format`](https://github.com/ehmicky/winston-error-format): Log
errors with Winston
# Support
For any question, _don't hesitate_ to [submit an issue on GitHub](../../issues).
Everyone is welcome regardless of personal background. We enforce a
[Code of conduct](CODE_OF_CONDUCT.md) 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](CONTRIBUTING.md). Pull requests are welcome!