{"id":16208502,"url":"https://github.com/ehmicky/error-http-response","last_synced_at":"2025-10-25T15:33:56.620Z","repository":{"id":63691332,"uuid":"569282450","full_name":"ehmicky/error-http-response","owner":"ehmicky","description":"Create HTTP error responses.","archived":false,"fork":false,"pushed_at":"2025-03-13T05:04:08.000Z","size":3944,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-13T06:19:07.964Z","etag":null,"topics":["api","browser","error","error-handler","error-handling","error-monitoring","http","http-response","http-rest","javascript","library","nodejs","problem-details","rest","rest-api","rfc","rfc-7807","stack","stacktrace","typescript"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ehmicky.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-11-22T13:36:52.000Z","updated_at":"2025-03-13T05:04:12.000Z","dependencies_parsed_at":"2023-02-19T11:31:32.992Z","dependency_job_id":"9e145141-c874-41db-90f3-1d6b29c9376a","html_url":"https://github.com/ehmicky/error-http-response","commit_stats":{"total_commits":130,"total_committers":3,"mean_commits":"43.333333333333336","dds":"0.038461538461538436","last_synced_commit":"2c79241f0a8323e1da82223f79f1c6e49d8b8917"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":"ehmicky/template-javascript","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ehmicky%2Ferror-http-response","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ehmicky%2Ferror-http-response/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ehmicky%2Ferror-http-response/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ehmicky%2Ferror-http-response/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ehmicky","download_url":"https://codeload.github.com/ehmicky/error-http-response/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243976471,"owners_count":20377691,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","browser","error","error-handler","error-handling","error-monitoring","http","http-response","http-rest","javascript","library","nodejs","problem-details","rest","rest-api","rfc","rfc-7807","stack","stacktrace","typescript"],"created_at":"2024-10-10T10:17:19.574Z","updated_at":"2025-10-25T15:33:51.579Z","avatar_url":"https://github.com/ehmicky.png","language":"JavaScript","readme":"[![Node](https://img.shields.io/badge/-Node.js-808080?logo=node.js\u0026colorA=404040\u0026logoColor=66cc33)](https://www.npmjs.com/package/error-http-response)\n[![Browsers](https://img.shields.io/badge/-Browsers-808080?logo=firefox\u0026colorA=404040)](https://unpkg.com/error-http-response?module)\n[![TypeScript](https://img.shields.io/badge/-Typed-808080?logo=typescript\u0026colorA=404040\u0026logoColor=0096ff)](/src/main.d.ts)\n[![Codecov](https://img.shields.io/badge/-Tested%20100%25-808080?logo=codecov\u0026colorA=404040)](https://codecov.io/gh/ehmicky/error-http-response)\n[![Minified size](https://img.shields.io/bundlephobia/minzip/error-http-response?label\u0026colorA=404040\u0026colorB=808080\u0026logo=webpack)](https://bundlephobia.com/package/error-http-response)\n[![Mastodon](https://img.shields.io/badge/-Mastodon-808080.svg?logo=mastodon\u0026colorA=404040\u0026logoColor=9590F9)](https://fosstodon.org/@ehmicky)\n[![Medium](https://img.shields.io/badge/-Medium-808080.svg?logo=medium\u0026colorA=404040)](https://medium.com/@ehmicky)\n\nCreate HTTP error responses.\n\nThis converts errors to plain objects\n([RFC 7807](https://www.rfc-editor.org/rfc/rfc7807), \"problem details\") to use\nin an HTTP response.\n\n# Example\n\nThe main HTTP response fields are automatically set using\n[`error.name`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error/name),\n[`error.message`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error/message)\n[`error.stack`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error/stack)\nand other error properties.\n\n```js\nconst error = new AuthError('Could not authenticate.')\nerror.userId = 62\nconst object = errorHttpResponse(error)\n// {\n//   title: 'AuthError',\n//   detail: 'Could not authenticate.',\n//   stack: `AuthError: Could not authenticate.\n//     at ...`,\n//   extra: { userId: 62 }\n// }\n```\n\nAdditional fields can be explicitly set in the error class's constructor, using\n`this.http`.\n\n\u003c!-- eslint-disable fp/no-class, fp/no-this, fp/no-mutation --\u003e\n\n```js\nclass AuthError extends Error {\n  constructor(...args) {\n    super(...args)\n    this.http = {\n      type: 'https://example.com/probs/auth',\n      status: 401,\n    }\n  }\n}\n```\n\nOr on the error instance, using `error.http`.\n\n\u003c!-- eslint-disable fp/no-mutating-assign --\u003e\n\n```js\nconst error = new AuthError('Could not authenticate.')\nObject.assign(error.http, {\n  instance: '/users/62',\n  extra: { userId: 62 },\n})\n```\n\nOr as an argument.\n\n```js\nimport errorHttpResponse from 'error-http-response'\n\nconst object = errorHttpResponse(error, {\n  extra: { isHttp: true },\n})\n// {\n//   type: 'https://example.com/probs/auth',\n//   status: 401,\n//   title: 'AuthError',\n//   detail: 'Could not authenticate.',\n//   instance: '/users/62',\n//   stack: `AuthError: Could not authenticate.\n//     at ...`,\n//   extra: { isHttp: true, userId: 62 },\n// }\n```\n\n# Install\n\n```bash\nnpm install error-http-response\n```\n\nThis package works in both Node.js \u003e=18.18.0 and\n[browsers](https://raw.githubusercontent.com/ehmicky/dev-tasks/main/src/browserslist).\n\nThis is an ES module. It must be loaded using\n[an `import` or `import()` statement](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c),\nnot `require()`. If TypeScript is used, it must be configured to\n[output ES modules](https://www.typescriptlang.org/docs/handbook/esm-node.html),\nnot CommonJS.\n\n# API\n\n## errorHttpResponse(error, options?)\n\n`value` `Error | any`\\\n`options` [`Options?`](#options)\\\n_Return value_: `HttpResponse`\n\nConverts `error` to a plain object\n([RFC 7807](https://www.rfc-editor.org/rfc/rfc7807), \"problem details\") to use\nin an HTTP response.\n\n`error` should be an `Error` instance, but invalid errors are automatically\n[normalized](https://github.com/ehmicky/normalize-exception).\n\n## Options\n\n_Type_: `object`\n\nThe options and the return value have the same shape\n([RFC 7807](https://www.rfc-editor.org/rfc/rfc7807)). Options can be passed\neither as an argument to\n[`errorHttpResponse()`](#errorhttpresponseerror-options) or be set to\n`error.http`.\n\nOptions are validated: an exception is thrown if their syntax is invalid.\n\n### type\n\n_Type_: `urlString`\\\n_Default_: `undefined`\n\nURI identifying and documenting the error class. Ideally, each error class\nshould set one.\n\n### status\n\n_Type_: `integer`\\\n_Default_: `undefined`\n\nHTTP status code.\n\n### title\n\n_Type_: `string`\\\n_Default_: `error.name`\n\nError class name.\n\n### detail\n\n_Type_: `string`\\\n_Default_: `error.message`\n\nError description.\n\n### instance\n\n_Type_: `urlString`\\\n_Default_: `undefined`\n\nURI identifying the value which errored.\n\n### stack\n\n_Type_: `string`\\\n_Default_: `error.stack`\n\nError stack trace. Can be set to an empty string.\n\n### extra\n\n_Type_: `object`\\\n_Default_: any additional `error` properties\n\nAdditional information. This is always\n[safe to serialize as JSON](https://github.com/ehmicky/safe-json-value). Can be\nset to an empty object.\n\n# Related projects\n\n- [`modern-errors`](https://github.com/ehmicky/modern-errors): Handle errors in\n  a simple, stable, consistent way\n- [`modern-errors-http`](https://github.com/ehmicky/modern-errors-http):\n  `modern-errors` plugin to create HTTP error responses\n- [`error-custom-class`](https://github.com/ehmicky/error-custom-class): Create\n  one error class\n- [`error-class-utils`](https://github.com/ehmicky/error-class-utils): Utilities\n  to properly create error classes\n- [`error-serializer`](https://github.com/ehmicky/error-serializer): Convert\n  errors to/from plain objects\n- [`normalize-exception`](https://github.com/ehmicky/normalize-exception):\n  Normalize exceptions/errors\n- [`is-error-instance`](https://github.com/ehmicky/is-error-instance): Check if\n  a value is an `Error` instance\n- [`merge-error-cause`](https://github.com/ehmicky/merge-error-cause): Merge an\n  error with its `cause`\n- [`set-error-class`](https://github.com/ehmicky/set-error-class): Properly\n  update an error's class\n- [`set-error-message`](https://github.com/ehmicky/set-error-message): Properly\n  update an error's message\n- [`wrap-error-message`](https://github.com/ehmicky/wrap-error-message):\n  Properly wrap an error's message\n- [`set-error-props`](https://github.com/ehmicky/set-error-props): Properly\n  update an error's properties\n- [`set-error-stack`](https://github.com/ehmicky/set-error-stack): Properly\n  update an error's stack\n- [`error-cause-polyfill`](https://github.com/ehmicky/error-cause-polyfill):\n  Polyfill `error.cause`\n- [`handle-cli-error`](https://github.com/ehmicky/handle-cli-error): 💣 Error\n  handler for CLI applications 💥\n- [`beautiful-error`](https://github.com/ehmicky/beautiful-error): Prettify\n  error messages and stacks\n- [`safe-json-value`](https://github.com/ehmicky/safe-json-value): ⛑️ JSON\n  serialization should never fail\n- [`log-process-errors`](https://github.com/ehmicky/log-process-errors): Show\n  some ❤ to Node.js process errors\n- [`error-http-response`](https://github.com/ehmicky/error-http-response):\n  Create HTTP error responses\n- [`winston-error-format`](https://github.com/ehmicky/winston-error-format): Log\n  errors with Winston\n\n# Support\n\nFor any question, _don't hesitate_ to [submit an issue on GitHub](../../issues).\n\nEveryone is welcome regardless of personal background. We enforce a\n[Code of conduct](CODE_OF_CONDUCT.md) in order to promote a positive and\ninclusive environment.\n\n# Contributing\n\nThis project was made with ❤️. The simplest way to give back is by starring and\nsharing it online.\n\nIf the documentation is unclear or has a typo, please click on the page's `Edit`\nbutton (pencil icon) and suggest a correction.\n\nIf you would like to help us fix a bug or add a new feature, please check our\n[guidelines](CONTRIBUTING.md). Pull requests are welcome!\n\n\u003c!-- Thanks go to our wonderful contributors: --\u003e\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START --\u003e\n\u003c!-- prettier-ignore --\u003e\n\u003c!--\n\u003ctable\u003e\u003ctr\u003e\u003ctd align=\"center\"\u003e\u003ca href=\"https://fosstodon.org/@ehmicky\"\u003e\u003cimg src=\"https://avatars2.githubusercontent.com/u/8136211?v=4\" width=\"100px;\" alt=\"ehmicky\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eehmicky\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/ehmicky/error-http-response/commits?author=ehmicky\" title=\"Code\"\u003e💻\u003c/a\u003e \u003ca href=\"#design-ehmicky\" title=\"Design\"\u003e🎨\u003c/a\u003e \u003ca href=\"#ideas-ehmicky\" title=\"Ideas, Planning, \u0026 Feedback\"\u003e🤔\u003c/a\u003e \u003ca href=\"https://github.com/ehmicky/error-http-response/commits?author=ehmicky\" title=\"Documentation\"\u003e📖\u003c/a\u003e\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e\n --\u003e\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fehmicky%2Ferror-http-response","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fehmicky%2Ferror-http-response","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fehmicky%2Ferror-http-response/lists"}