{"id":16208474,"url":"https://github.com/ehmicky/error-class-utils","last_synced_at":"2025-03-19T08:30:47.663Z","repository":{"id":58387884,"uuid":"531586732","full_name":"ehmicky/error-class-utils","owner":"ehmicky","description":"Properly create error classes.","archived":false,"fork":false,"pushed_at":"2025-02-04T20:38:19.000Z","size":5526,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-12T15:19:37.069Z","etag":null,"topics":["browser","cause","code-quality","create","custom","error","error-classes","error-handler","error-handling","error-monitoring","error-reporting","errors","javascript","library","message","monitoring","nodejs","properties","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-09-01T15:51:32.000Z","updated_at":"2025-02-04T20:38:23.000Z","dependencies_parsed_at":"2023-02-07T12:15:58.006Z","dependency_job_id":"595bb6c8-0c52-49ca-be26-b181de6eb464","html_url":"https://github.com/ehmicky/error-class-utils","commit_stats":{"total_commits":201,"total_committers":3,"mean_commits":67.0,"dds":0.02487562189054726,"last_synced_commit":"7bf02f416cb314e6dc44d78146a53bfe9d136f62"},"previous_names":[],"tags_count":12,"template":false,"template_full_name":"ehmicky/template-javascript","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ehmicky%2Ferror-class-utils","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ehmicky%2Ferror-class-utils/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ehmicky%2Ferror-class-utils/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ehmicky%2Ferror-class-utils/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ehmicky","download_url":"https://codeload.github.com/ehmicky/error-class-utils/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","cause","code-quality","create","custom","error","error-classes","error-handler","error-handling","error-monitoring","error-reporting","errors","javascript","library","message","monitoring","nodejs","properties","stacktrace","typescript"],"created_at":"2024-10-10T10:17:10.132Z","updated_at":"2025-03-19T08:30:47.202Z","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-class-utils)\n[![Browsers](https://img.shields.io/badge/-Browsers-808080?logo=firefox\u0026colorA=404040)](https://unpkg.com/error-class-utils?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-class-utils)\n[![Minified size](https://img.shields.io/bundlephobia/minzip/error-class-utils?label\u0026colorA=404040\u0026colorB=808080\u0026logo=webpack)](https://bundlephobia.com/package/error-class-utils)\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\nProperly create error classes.\n\nUseful utilities when creating custom error classes.\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- Ponyfill\n  [`error.cause`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error/cause)\n  on\n  [older Node.js and browsers](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error/cause#browser_compatibility)\n- Properly [set `error.name`](#seterrornameerrorclass-name)\n- Fix [issues](#ensurecorrectclasserror-newtarget) when `Error` has been\n  polyfilled\n\n# Example\n\n\u003c!-- eslint-disable fp/no-this, fp/no-class, fp/no-mutating-assign --\u003e\n\n```js\nimport {\n  ensureCorrectClass,\n  ponyfillCause,\n  setErrorName,\n} from 'error-class-utils'\n\nexport class CustomError extends Error {\n  constructor(message, parameters) {\n    super(message, parameters)\n\n    // Fix some issues when `Error` has been polyfilled\n    ensureCorrectClass(this, new.target)\n\n    // Ponyfill `error.cause` on old Node.js/browsers\n    ponyfillCause(this, parameters)\n  }\n}\n\n// Properly set `error.name` as a non-enumerable and inherited property\nsetErrorName(CustomError, 'CustomError')\n```\n\n```js\nimport { CustomError } from './errors.js'\n\nconst cause = new Error('innerMessage')\nconst error = new CustomError('message', { cause })\nconsole.log(error instanceof CustomError) // true\nconsole.log(error.name) // 'CustomError'\nconsole.log(error.cause) // Error: innerMessage ...\n```\n\n# Install\n\n```bash\nnpm install error-class-utils\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## ensureCorrectClass(error, new.target)\n\n`error` `Error`\\\n`new.target` `typeof Error`\\\n_Return value_: `void`\n\nSome `Error` polyfills (such as\n[`es-shims/error-cause`](https://github.com/es-shims/error-cause)) prevent\nextending from it. This fixes it.\n\nThe second argument must be\n[`new.target`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/new.target).\nThis must be called directly inside a class constructor, after\n[`super(message, parameters)`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/super).\n\n\u003c!-- eslint-disable fp/no-class, fp/no-this --\u003e\n\n```js\nimport { ensureCorrectClass } from 'error-class-utils'\n\nclass CustomError extends Error {\n  constructor(message, parameters) {\n    super(message, parameters)\n    ensureCorrectClass(this, new.target)\n  }\n}\n\n// Thanks to `ensureCorrectClass()`, this is now always true even when\n// `Error` has been polyfilled\nconsole.log(new CustomError('message') instanceof CustomError) // true\n```\n\n## ponyfillCause(error, parameters?)\n\n`error` `Error`\\\n`parameters` `ErrorParams?`\\\n_Return value_: `void`\n\nPonyfills\n[`error.cause`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error/cause)\non\n[older Node.js and browsers](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error/cause#browser_compatibility).\n\nThis must be called inside a class constructor, after\n[`super(message, parameters)`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/super).\n\n\u003c!-- eslint-disable fp/no-class, fp/no-this --\u003e\n\n```js\nimport { ponyfillCause } from 'error-class-utils'\n\nclass CustomError extends Error {\n  constructor(message, parameters) {\n    super(message, parameters)\n    ponyfillCause(this, parameters)\n  }\n}\n\ntry {\n  throw new Error('innerMessage')\n} catch (cause) {\n  // Works on any platforms thanks to ponyfill\n  const error = new CustomError('message', { cause })\n  console.log(error.cause.message) // 'innerMessage'\n}\n```\n\n## setErrorName(ErrorClass, name)\n\n`ErrorClass` `typeof Error`\\\n`name` `string`\\\n_Return value_: `void`\n\nSet an `ErrorClass`'s\n[`name`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error/name).\n\nThis must be performed on an error class, not instance. Unlike setting\n`this.name = '...'` inside an error's constructor, this follows the native\n`Error` classes' pattern where `error.name`:\n\n- Ends with the `Error` suffix\n- Matches the\n  [constructor's `name`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function/name)\n- Is\n  [inherited](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Enumerability_and_ownership_of_properties)\n- Is\n  [non-enumerable](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Enumerability_and_ownership_of_properties)\n\n\u003c!-- eslint-disable fp/no-class --\u003e\n\n```js\nimport { setErrorName } from 'error-class-utils'\n\nclass CustomError extends Error {}\nsetErrorName(CustomError, 'CustomError')\n\nconsole.log(CustomError.name) // 'CustomError'\nconsole.log(CustomError.prototype.name) // 'CustomError'\n\nconst error = new CustomError('message')\nconsole.log(error.name) // 'CustomError'\nconsole.log(Object.keys(error).includes('name')) // false\n```\n\n# Related projects\n\n- [`modern-errors`](https://github.com/ehmicky/modern-errors): Handle errors in\n  a simple, stable, consistent way\n- [`error-custom-class`](https://github.com/ehmicky/error-custom-class): Create\n  one error class\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- [`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-class-utils/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-class-utils/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-class-utils","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fehmicky%2Ferror-class-utils","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fehmicky%2Ferror-class-utils/lists"}