error-http-response
TypeScript icon, indicating that this package has built-in type declarations

3.0.0 • Public • Published

Node Browsers TypeScript Codecov Minified size Mastodon Medium

Create HTTP error responses.

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

Hire me

Please reach out if you're looking for a Node.js API or CLI engineer (11 years of experience). Most recently I have been Netlify Build's and Netlify Plugins' technical lead for 2.5 years. I am available for full-time remote positions.

Example

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

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.

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.

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

Or as an argument.

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

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.

type

Type: urlString
Default: undefined

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

status

Type: integer
Default: undefined

HTTP status code.

title

Type: string
Default: error.name

Error class name.

detail

Type: string
Default: error.message

Error description.

instance

Type: urlString
Default: undefined

URI identifying the value which errored.

stack

Type: string
Default: error.stack

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

extra

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

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!

Package Sidebar

Install

npm i error-http-response

Weekly Downloads

272

Version

3.0.0

License

MIT

Unpacked Size

16.9 kB

Total Files

6

Last publish

Collaborators

  • ehmicky