Create HTTP error responses.

This converts errors to plain objects
(RFC 7807, "problem details") to use
in an HTTP response.

Example

The main HTTP response fields are automatically set using
error.name,
error.message
error.stack
and other error properties.

``js
const error = new AuthError('Could not authenticate.')
error.userId = 62
const object = errorHttpResponse(error)
// {
// title: 'AuthError',
// detail: 'Could not authenticate.',
// stack: AuthError: Could not authenticate.
// at ...,
// extra: { userId: 62 }
// }
`

Additional fields can be explicitly set in the error class's constructor, using
this.http.

`js
class AuthError extends Error {
constructor(...args) {
super(...args)
this.http = {
type: 'https://example.com/probs/auth',
status: 401,
}
}
}
`

Or on the error instance, using error.http.

`js
const error = new AuthError('Could not authenticate.')
Object.assign(error.http, {
instance: '/users/62',
extra: { userId: 62 },
})
`

Or as an argument.

`js
import errorHttpResponse from 'error-http-response'

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

Install

`bash
npm install error-http-response
`

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

errorHttpResponse(error, options?)

value Error | any\
options Options?\
_Return value_: HttpResponse

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

error should be an Error instance, but invalid errors are automatically
normalized.

Options

_Type_: object

The options and the return value have the same shape
(RFC 7807). Options can be passed
either as an argument to
errorHttpResponse() or be set to
error.http.

Options are validated: an exception is thrown if their syntax is invalid.

$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.

Related projects

- modern-errors: Handle errors in
a simple, stable, consistent way
- modern-errors-http:
modern-errors plugin to create HTTP error responses
- error-custom-class: Create
one error class
- 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 💥
- safe-json-value: ⛑️ JSON
serialization should never fail
- 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!