Create custom error classes.

Features

- Very simple API
- Ponyfill
error.cause
on
older Node.js and browsers
- Properly
set error.name
- Fix
issues
when Error has been polyfilled

Example

``js
import errorCustomClass from 'error-custom-class'

const UserError = errorCustomClass('UserError')
const DatabaseError = errorCustomClass('DatabaseError')

try {
throw new UserError('message')
} catch (error) {
console.log(error.name) // 'UserError'
console.log(error instanceof UserError) // true
}
`

Install

`bash
npm install error-custom-class
`

This 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

The API is designed for simplicity. For more customization,
error-class-utils should be
used instead.

errorCustomClass(errorName)

errorName string\
_Return value_: CustomError

Creates a custom error class.

Related projects

- modern-errors: Handle errors in
a simple, stable, consistent way
- 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
- set-error-stack: Properly
update an error's stack
- 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!