modern-errors
plugin to create HTTP error
responses.

This adds BaseError.httpResponse(error) which
converts error to a plain object
(RFC 7807, "problem details") to use
in an HTTP response.

Example

Adding the plugin to
modern-errors.

``js
import ModernError from 'modern-errors'

import modernErrorsHttp from 'modern-errors-http'

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

Configuring error fields.

`js
export const AuthError = BaseError.subclass('AuthError', {
http: {
type: 'https://example.com/probs/auth',
status: 401,
},
})
`

Creating an HTTP error response.

`js
const error = new AuthError('Could not authenticate.', {
http: {
instance: '/users/62',
extra: { userId: 62 },
},
})
const object = BaseError.httpResponse(error)
// {
// type: 'https://example.com/probs/auth',
// status: 401,
// title: 'AuthError',
// detail: 'Could not authenticate.',
// instance: '/users/62',
// stack: AuthError: Could not authenticate.
// at ...,
// extra: { userId: 62 },
// }
`

Install

`bash
npm install modern-errors-http
`

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

modernErrorsHttp

_Type_: Plugin

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

BaseError.httpResponse(error)

error: Error\
_Return value_: HttpResponse

Converts error to a plain object to use in an HTTP response. Its shape follows
RFC 7807 ("problem details").

Options

_Type_: object

$3

_Type_: urlString\
_Default_: undefined

URI identifying and documenting the error class. Ideally, each error class
should set one.

$3

_Type_: integer\
_Default_: undefined

HTTP status code.

$3

_Type_: string\
_Default_: error.name

Error class name.

$3

_Type_: string\
_Default_: error.message

Error description.

$3

_Type_: urlString\
_Default_: undefined

URI identifying the value which errored.

$3

_Type_: string\
_Default_: error.stack

Error stack trace. Can be set to an empty string.

$3

_Type_: object\
_Default_: any additional error properties

Additional information. This is always
safe to serialize as JSON. Can be
set to an empty object.

Configuration

Options can apply to (in priority order):

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

`js
export const BaseError = ModernError.subclass('BaseError', {
plugins: [modernErrorsHttp],
http: options,
})
`

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

`js
export const AuthError = BaseError.subclass('AuthError', { http: options })
`

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

`js
throw new AuthError('...', { http: options })
`

- A specific BaseError.httpResponse(error) call

`js
BaseError.httpResponse(error, options)
`

Related projects

- error-http-response:
Create HTTP error responses
- safe-json-value: ⛑️ JSON
serialization should never fail
- 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-bugs: Print
where to report bugs
- modern-errors-serialize:
Serialize/parse errors
- modern-errors-clean: Clean
stack traces
- 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!