{"id":15118151,"url":"https://github.com/ehmicky/modern-errors-http","last_synced_at":"2025-03-16T11:30:36.426Z","repository":{"id":62713488,"uuid":"561926552","full_name":"ehmicky/modern-errors-http","owner":"ehmicky","description":"`modern-errors` plugin to create HTTP error responses.","archived":false,"fork":false,"pushed_at":"2025-03-13T05:04:08.000Z","size":8297,"stargazers_count":13,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-13T06:19:10.089Z","etag":null,"topics":["browser","error","error-handler","error-handling","error-monitoring","http","javascript","library","modern-errors","modern-errors-plugin","nodejs","plugins","problem-details","rest","rest-api","rfc","rfc-7807","stack","stacktrace","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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-04T20:17:23.000Z","updated_at":"2025-03-13T05:04:12.000Z","dependencies_parsed_at":"2024-04-08T01:26:25.190Z","dependency_job_id":"8b6df0e7-1ac5-4527-8089-47908688b7c3","html_url":"https://github.com/ehmicky/modern-errors-http","commit_stats":{"total_commits":191,"total_committers":3,"mean_commits":"63.666666666666664","dds":0.02617801047120416,"last_synced_commit":"7f72660234cc05f2eb3e9ef57c314cc93795a743"},"previous_names":[],"tags_count":13,"template":false,"template_full_name":"ehmicky/template-javascript","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ehmicky%2Fmodern-errors-http","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ehmicky%2Fmodern-errors-http/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ehmicky%2Fmodern-errors-http/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ehmicky%2Fmodern-errors-http/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ehmicky","download_url":"https://codeload.github.com/ehmicky/modern-errors-http/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243814907,"owners_count":20352037,"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":["browser","error","error-handler","error-handling","error-monitoring","http","javascript","library","modern-errors","modern-errors-plugin","nodejs","plugins","problem-details","rest","rest-api","rfc","rfc-7807","stack","stacktrace","typescript"],"created_at":"2024-09-26T01:46:09.091Z","updated_at":"2025-03-16T11:30:36.038Z","avatar_url":"https://github.com/ehmicky.png","language":"TypeScript","readme":"\u003cpicture\u003e\n  \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://raw.githubusercontent.com/ehmicky/design/main/modern-errors/modern-errors_dark.svg\"/\u003e\n  \u003cimg alt=\"modern-errors logo\" src=\"https://raw.githubusercontent.com/ehmicky/design/main/modern-errors/modern-errors.svg\" width=\"600\"/\u003e\n\u003c/picture\u003e\n\n[![Node](https://img.shields.io/badge/-Node.js-808080?logo=node.js\u0026colorA=404040\u0026logoColor=66cc33)](https://www.npmjs.com/package/modern-errors-http)\n[![Browsers](https://img.shields.io/badge/-Browsers-808080?logo=firefox\u0026colorA=404040)](https://unpkg.com/modern-errors-http?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/modern-errors-http)\n[![Minified size](https://img.shields.io/bundlephobia/minzip/modern-errors-http?label\u0026colorA=404040\u0026colorB=808080\u0026logo=webpack)](https://bundlephobia.com/package/modern-errors-http)\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\n[`modern-errors`](https://github.com/ehmicky/modern-errors)\n[plugin](https://github.com/ehmicky/modern-errors#-plugins) to create HTTP error\nresponses.\n\nThis adds [`BaseError.httpResponse(error)`](#baseerrorhttpresponseerror) which\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# Hire me\n\nPlease\n[reach out](https://www.linkedin.com/feed/update/urn:li:activity:7117265228068716545/)\nif you're looking for a Node.js API or CLI engineer (11 years of experience).\nMost recently I have been [Netlify Build](https://github.com/netlify/build)'s\nand [Netlify Plugins](https://www.netlify.com/products/build/plugins/)'\ntechnical lead for 2.5 years. I am available for full-time remote positions.\n\n# Example\n\n[Adding the plugin](https://github.com/ehmicky/modern-errors#adding-plugins) to\n[`modern-errors`](https://github.com/ehmicky/modern-errors).\n\n```js\nimport ModernError from 'modern-errors'\n\nimport modernErrorsHttp from 'modern-errors-http'\n\nexport const BaseError = ModernError.subclass('BaseError', {\n  plugins: [modernErrorsHttp],\n})\n```\n\n[Configuring](#configuration) error fields.\n\n```js\nexport const AuthError = BaseError.subclass('AuthError', {\n  http: {\n    type: 'https://example.com/probs/auth',\n    status: 401,\n  },\n})\n```\n\n[Creating](#baseerrorhttpresponseerror) an HTTP error response.\n\n```js\nconst error = new AuthError('Could not authenticate.', {\n  http: {\n    instance: '/users/62',\n    extra: { userId: 62 },\n  },\n})\nconst object = BaseError.httpResponse(error)\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: { userId: 62 },\n// }\n```\n\n# Install\n\n```bash\nnpm install modern-errors-http\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## modernErrorsHttp\n\n_Type_: `Plugin`\n\nPlugin object to pass to the\n[`plugins` option](https://github.com/ehmicky/modern-errors#adding-plugins) of\n`ErrorClass.subclass()`.\n\n## BaseError.httpResponse(error)\n\n`error`: `Error`\\\n_Return value_: `HttpResponse`\n\nConverts `error` to a plain object to use in an HTTP response. Its shape follows\n[RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) (\"problem details\").\n\n## Options\n\n_Type_: `object`\n\n### type\n\n_Type_: `urlString`\\\n_Default_: `undefined`\n\nURI identifying and documenting the error class. Ideally, each error class\n[should set one](#configuration).\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## Configuration\n\n[Options](#options) can apply to (in priority order):\n\n- Any error: second argument to\n  [`ModernError.subclass()`](https://github.com/ehmicky/modern-errors#options-1)\n\n```js\nexport const BaseError = ModernError.subclass('BaseError', {\n  plugins: [modernErrorsHttp],\n  http: options,\n})\n```\n\n- Any error of a specific class (and its subclasses): second argument to\n  [`ErrorClass.subclass()`](https://github.com/ehmicky/modern-errors#options-1)\n\n```js\nexport const AuthError = BaseError.subclass('AuthError', { http: options })\n```\n\n- A specific error: second argument to\n  [`new ErrorClass()`](https://github.com/ehmicky/modern-errors#options-3)\n\n```js\nthrow new AuthError('...', { http: options })\n```\n\n- A specific [`BaseError.httpResponse(error)`](#baseerrorhttpresponseerror) call\n\n```js\nBaseError.httpResponse(error, options)\n```\n\n# Related projects\n\n- [`error-http-response`](https://github.com/ehmicky/error-http-response):\n  Create HTTP error responses\n- [`safe-json-value`](https://github.com/ehmicky/safe-json-value): ⛑️ JSON\n  serialization should never fail\n- [`modern-errors`](https://github.com/ehmicky/modern-errors): Handle errors in\n  a simple, stable, consistent way\n- [`modern-errors-cli`](https://github.com/ehmicky/modern-errors-cli): Handle\n  errors in CLI modules\n- [`modern-errors-process`](https://github.com/ehmicky/modern-errors-process):\n  Handle process errors\n- [`modern-errors-bugs`](https://github.com/ehmicky/modern-errors-bugs): Print\n  where to report bugs\n- [`modern-errors-serialize`](https://github.com/ehmicky/modern-errors-serialize):\n  Serialize/parse errors\n- [`modern-errors-clean`](https://github.com/ehmicky/modern-errors-clean): Clean\n  stack traces\n- [`modern-errors-winston`](https://github.com/ehmicky/modern-errors-winston):\n  Log errors with Winston\n- [`modern-errors-switch`](https://github.com/ehmicky/modern-errors-switch):\n  Execute class-specific logic\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/modern-errors-http/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/modern-errors-http/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":["TypeScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fehmicky%2Fmodern-errors-http","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fehmicky%2Fmodern-errors-http","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fehmicky%2Fmodern-errors-http/lists"}