{"id":13447440,"url":"https://github.com/ehmicky/log-process-errors","last_synced_at":"2025-04-11T05:06:10.213Z","repository":{"id":40571995,"uuid":"153081701","full_name":"ehmicky/log-process-errors","owner":"ehmicky","description":"Show some ❤️ to Node.js process errors","archived":false,"fork":false,"pushed_at":"2025-03-29T03:13:37.000Z","size":19044,"stargazers_count":469,"open_issues_count":0,"forks_count":9,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-04T00:04:06.801Z","etag":null,"topics":["code-quality","debugging","error","error-handler","error-handling","exception","handler","handling","javascript","library","logging","monitoring","nodejs","process","promise","test","testing","typescript","uncaught","uncaught-exceptions"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","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":"2018-10-15T08:50:30.000Z","updated_at":"2025-03-29T03:13:41.000Z","dependencies_parsed_at":"2024-04-22T20:27:46.637Z","dependency_job_id":"f7353fff-be4f-40e7-a392-e859662633d5","html_url":"https://github.com/ehmicky/log-process-errors","commit_stats":{"total_commits":2683,"total_committers":6,"mean_commits":447.1666666666667,"dds":0.009690644800596337,"last_synced_commit":"4dc53b825a0508e29942bf1f8fe30c1e890ad711"},"previous_names":[],"tags_count":101,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ehmicky%2Flog-process-errors","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ehmicky%2Flog-process-errors/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ehmicky%2Flog-process-errors/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ehmicky%2Flog-process-errors/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ehmicky","download_url":"https://codeload.github.com/ehmicky/log-process-errors/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247415961,"owners_count":20935388,"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":["code-quality","debugging","error","error-handler","error-handling","exception","handler","handling","javascript","library","logging","monitoring","nodejs","process","promise","test","testing","typescript","uncaught","uncaught-exceptions"],"created_at":"2024-07-31T05:01:17.743Z","updated_at":"2025-04-11T05:06:10.168Z","avatar_url":"https://github.com/ehmicky.png","language":"JavaScript","funding_links":[],"categories":["JavaScript","Typescript / Javascript"],"sub_categories":[],"readme":"\u003cpicture\u003e\n  \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://raw.githubusercontent.com/ehmicky/design/main/log-process-errors/log-process-errors_dark.svg\"/\u003e\n  \u003cimg alt=\"log-process-errors logo\" src=\"https://raw.githubusercontent.com/ehmicky/design/main/log-process-errors/log-process-errors.svg\" width=\"500\"/\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/log-process-errors)\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/log-process-errors)\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[📰 Medium article.](https://medium.com/@ehmicky/node-js-process-errors-are-broken-193980f0a77b)\n\nShow some ❤️ to Node.js process errors.\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# 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- Ignore [duplicate](#onerror) process errors\n- [Normalize](#error) invalid errors\n- [Process exit](#exit) is graceful and can be prevented\n\n# Install\n\nProduction code (e.g. a server) can install this either as a production or\ndevelopment dependency:\n\n```bash\nnpm install log-process-errors\n```\n\nHowever, libraries should install this as a development dependency:\n\n```bash\nnpm install -D log-process-errors\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 works in 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## logProcessErrors(options?)\n\n[`options`](#options) `object?`\\\n_Return value_: `() =\u003e void`\n\nStart handling process errors.\n\n```js\nimport logProcessErrors from 'log-process-errors'\nlogProcessErrors(options)\n```\n\nThe return value restores Node.js default behavior.\n\n```js\nconst restore = logProcessErrors(options)\nrestore()\n```\n\n## Options\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```js\n// Log process errors with Winston instead\nlogProcessErrors({\n  onError: (error, event) =\u003e {\n    winstonLogger.error(error.stack)\n  },\n})\n```\n\n#### error\n\n_Type_: `Error`\n\nThe process error. This is guaranteed to be a\n[normalized](https://github.com/ehmicky/normalize-exception) error instance. A\nshort description of the [event](#event) is also appended to its message.\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# Related projects\n\n- [`modern-errors`](https://github.com/ehmicky/modern-errors): Handle errors in\n  a simple, stable, consistent way\n- [`modern-errors-process`](https://github.com/ehmicky/modern-errors-process):\n  Handle process errors\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- [`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\nThanks go to our wonderful contributors:\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START --\u003e\n\u003c!-- prettier-ignore-start --\u003e\n\u003c!-- markdownlint-disable --\u003e\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://fosstodon.org/@ehmicky\"\u003e\u003cimg src=\"https://avatars2.githubusercontent.com/u/8136211?v=4\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eehmicky\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/ehmicky/log-process-errors/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/log-process-errors/commits?author=ehmicky\" title=\"Documentation\"\u003e📖\u003c/a\u003e\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://svachon.com\"\u003e\u003cimg src=\"https://avatars0.githubusercontent.com/u/170197?v=4\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eSteven Vachon\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"#question-stevenvachon\" title=\"Answering Questions\"\u003e💬\u003c/a\u003e\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://github.com/Hongarc\"\u003e\u003cimg src=\"https://avatars1.githubusercontent.com/u/19208123?v=4\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eHongarc\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/ehmicky/log-process-errors/commits?author=Hongarc\" title=\"Documentation\"\u003e📖\u003c/a\u003e \u003ca href=\"https://github.com/ehmicky/log-process-errors/commits?author=Hongarc\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://github.com/abrenneke\"\u003e\u003cimg src=\"https://avatars0.githubusercontent.com/u/342540?v=4\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eAndy Brenneke\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/ehmicky/log-process-errors/issues?q=author%3Aabrenneke\" title=\"Bug reports\"\u003e🐛\u003c/a\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n\u003c!-- markdownlint-enable --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fehmicky%2Flog-process-errors","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fehmicky%2Flog-process-errors","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fehmicky%2Flog-process-errors/lists"}