{"id":15117132,"url":"https://github.com/ehmicky/modern-errors-process","last_synced_at":"2025-03-19T08:30:47.079Z","repository":{"id":62744698,"uuid":"561925362","full_name":"ehmicky/modern-errors-process","owner":"ehmicky","description":"`modern-errors` plugin to handle process errors.","archived":false,"fork":false,"pushed_at":"2025-02-04T20:38:19.000Z","size":7400,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-12T22:37:07.581Z","etag":null,"topics":["browser","code-quality","error","error-handler","error-handling","error-monitoring","javascript","library","modern-errors","modern-errors-plugin","monitoring","nodejs","plugins","process","promise","typescript","uncaught","uncaught-exception-handler","uncaught-exceptions","unhandled-rejection"],"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-04T20:13:18.000Z","updated_at":"2025-02-04T20:38:22.000Z","dependencies_parsed_at":"2023-09-21T21:57:32.668Z","dependency_job_id":"755e36d5-c081-440d-9063-d5c50cdeef60","html_url":"https://github.com/ehmicky/modern-errors-process","commit_stats":{"total_commits":184,"total_committers":3,"mean_commits":"61.333333333333336","dds":0.02717391304347827,"last_synced_commit":"5eb0903a57a2c8236550d73c647f13284f1df2cb"},"previous_names":[],"tags_count":9,"template":false,"template_full_name":"ehmicky/template-javascript","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ehmicky%2Fmodern-errors-process","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ehmicky%2Fmodern-errors-process/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ehmicky%2Fmodern-errors-process/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ehmicky%2Fmodern-errors-process/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ehmicky","download_url":"https://codeload.github.com/ehmicky/modern-errors-process/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":["browser","code-quality","error","error-handler","error-handling","error-monitoring","javascript","library","modern-errors","modern-errors-plugin","monitoring","nodejs","plugins","process","promise","typescript","uncaught","uncaught-exception-handler","uncaught-exceptions","unhandled-rejection"],"created_at":"2024-09-26T01:45:50.826Z","updated_at":"2025-03-19T08:30:46.709Z","avatar_url":"https://github.com/ehmicky.png","language":"JavaScript","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-process)\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-process)\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 handle process\nerrors.\n\nThis improves process errors:\n[uncaught](https://nodejs.org/api/process.html#process_event_uncaughtexception)\nexceptions,\n[unhandled](https://nodejs.org/api/process.html#process_event_unhandledrejection)\npromises, promises\n[handled too late](https://nodejs.org/api/process.html#process_event_rejectionhandled)\nand [warnings](https://nodejs.org/api/process.html#process_event_warning).\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# Features\n\n- Stack traces for warnings and\n  [`rejectionHandled`](https://nodejs.org/api/process.html#process_event_rejectionhandled)\n- [Single event handler](#onerror) for all process errors\n- Set any process error's class to\n  [`UnknownError`](https://github.com/ehmicky/modern-errors#-unknown-errors)\n- Ignore [duplicate](#onerror) process errors\n- [Normalize](#error) invalid errors\n- [Process exit](#exit) is graceful and can be prevented\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 modernErrorsProcess from 'modern-errors-process'\n\nexport const BaseError = ModernError.subclass('BaseError', {\n  plugins: [modernErrorsProcess],\n})\nexport const UnknownError = BaseError.subclass('UnknownError')\n// ...\n```\n\n[Initializing](#errorclasslogprocess) the process error handler.\n\n```js\nUnknownError.logProcess()\n```\n\n# Install\n\nProduction code (e.g. a server) can install this either as a production or as a\ndevelopment dependency.\n\n```bash\nnpm install modern-errors-process\n```\n\nHowever, libraries should install this as a development dependency.\n\n```bash\nnpm install -D modern-errors-process\n```\n\nThis is because logging is modified globally and libraries users might not\nexpect this side-effect. Also, this might lead to conflicts between libraries.\n\nThis package requires Node.js \u003e=18.18.0.\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## modernErrorsProcess\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## ErrorClass.logProcess()\n\n_Return value_: `() =\u003e void`\n\nStart handling process errors.\n\nThe return value restores Node.js default behavior.\n\n```js\nconst restore = UnknownError.logProcess()\nrestore()\n```\n\n## Options\n\n_Type_: `object`\n\n### exit\n\n_Type_: `boolean`\n\nWhether to exit the process on\n[uncaught exceptions](https://nodejs.org/api/process.html#process_event_uncaughtexception)\nor\n[unhandled promises](https://nodejs.org/api/process.html#process_event_unhandledrejection).\n\nThis is `false` by default if other libraries are listening to those events, so\nthey can perform the exit instead. Otherwise, this is `true`.\n\nIf some tasks are still ongoing, the exit waits for them to complete up to 3\nseconds.\n\n### onError\n\n_Type_: `(error, event) =\u003e Promise\u003cvoid\u003e | void`\\\n_Default_: `console.error(error)`\n\nFunction called once per process error. Duplicate process errors are ignored.\n\n#### error\n\n_Type_:\n[`UnknownError`](https://github.com/ehmicky/modern-errors#-unknown-errors)\n\nThe process error. This is guaranteed to be a\n[normalized](https://github.com/ehmicky/normalize-exception)\n[`UnknownError`](https://github.com/ehmicky/modern-errors#-unknown-errors)\ninstance. A short description of the [event](#event) is also appended to its\nmessage.\n\n#### event\n\n_Type_: `Event`\n\nProcess event name among:\n[`'uncaughtException'`](https://nodejs.org/api/process.html#process_event_uncaughtexception),\n[`'unhandledRejection'`](https://nodejs.org/api/process.html#process_event_unhandledrejection),\n[`'rejectionHandled'`](https://nodejs.org/api/process.html#process_event_rejectionhandled),\n[`'warning'`](https://nodejs.org/api/process.html#process_event_warning).\n\n## Configuration\n\n[Options](#options) must be passed either to\n[`ModernError.subclass()`](https://github.com/ehmicky/modern-errors#options-1).\n\n```js\nexport const BaseError = ModernError.subclass('BaseError', {\n  plugins: [modernErrorsProcess],\n  process: options,\n})\n```\n\nTo\n[`UnknownError.subclass()`](https://github.com/ehmicky/modern-errors#options-1).\n\n```js\nexport const UnknownError = BaseError.subclass('UnknownError', {\n  process: options,\n})\n```\n\nOr to [`UnknownError.logProcess()`](#errorclasslogprocess).\n\n```js\nUnknownError.logProcess(options)\n```\n\n# Related projects\n\n- [`log-process-errors`](https://github.com/ehmicky/log-process-errors): Show\n  some ❤ to Node.js process errors\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-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-http`](https://github.com/ehmicky/modern-errors-http): Create\n  HTTP error responses\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-process/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-process/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":["JavaScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fehmicky%2Fmodern-errors-process","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fehmicky%2Fmodern-errors-process","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fehmicky%2Fmodern-errors-process/lists"}