modern-errors
plugin to print where to
report bugs.

This appends a bug reports URL to error messages.

Example

Adding the plugin to
modern-errors.

``js
import ModernError from 'modern-errors'

import modernErrorsBugs from 'modern-errors-bugs'

export const BaseError = ModernError.subclass('BaseError', {
plugins: [modernErrorsBugs],
})
`

Configuring the bugs report URL.

`js
export const UnknownError = BaseError.subclass('UnknownError', {
bugs: 'https://github.com/my-name/my-project/issues',
})
`

Unknown errors now
include the following message.

`
Please report this bug at: https://github.com/my-name/my-project/issues
`

Install

`bash
npm install modern-errors-bugs
`

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

modernErrorsBugs

_Type_: Plugin

Plugin object to pass to the
plugins option of
ErrorClass.subclass().

Configuration

The bug reports URL must be a string or a
URL.

While this plugin is especially useful with
_unknown_ errors, it
can also apply to (in priority order):

- Any error: second argument to
ModernError.subclass()

`js
export const BaseError = ModernError.subclass('BaseError', {
plugins: [modernErrorsBugs],
bugs: 'https://github.com/my-name/my-project/issues',
})
`

- Any error of a specific class (and its subclasses): second argument to
ErrorClass.subclass()

`js
export const UnknownError = BaseError.subclass('UnknownError', {
bugs: 'https://github.com/my-name/my-project/issues',
})
`

- A specific error: second argument to
new ErrorClass()

`js
throw new ExampleError('...', {
bugs: 'https://github.com/my-name/my-project/issues',
})
`

Related projects

- modern-errors: Handle errors in
a simple, stable, consistent way
- modern-errors-cli: Handle
errors in CLI modules
- modern-errors-process:
Handle process errors
- modern-errors-serialize:
Serialize/parse errors
- modern-errors-clean: Clean
stack traces
- modern-errors-http: Create
HTTP error responses
- modern-errors-winston:
Log errors with Winston
- modern-errors-switch:
Execute class-specific logic

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!