{"id":16208509,"url":"https://github.com/ehmicky/set-error-props","last_synced_at":"2025-03-19T08:30:48.415Z","repository":{"id":58017119,"uuid":"529356021","full_name":"ehmicky/set-error-props","owner":"ehmicky","description":"Properly update an error's properties","archived":false,"fork":false,"pushed_at":"2025-03-13T05:04:08.000Z","size":8056,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-13T06:19:09.642Z","etag":null,"topics":["browser","code-quality","deep","deepmerge","error","error-classes","error-handler","error-handling","error-monitoring","error-reporting","errors","exceptions","javascript","library","merge","message","monitoring","nodejs","properties","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-08-26T17:53:05.000Z","updated_at":"2025-03-13T05:04:12.000Z","dependencies_parsed_at":"2024-04-22T20:27:43.445Z","dependency_job_id":"862845a5-b850-4664-859c-b9563448c27f","html_url":"https://github.com/ehmicky/set-error-props","commit_stats":{"total_commits":269,"total_committers":3,"mean_commits":89.66666666666667,"dds":"0.018587360594795488","last_synced_commit":"8a8cfeb1082192295535ae0e06cfe0160435c2bc"},"previous_names":[],"tags_count":14,"template":false,"template_full_name":"ehmicky/template-javascript","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ehmicky%2Fset-error-props","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ehmicky%2Fset-error-props/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ehmicky%2Fset-error-props/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ehmicky%2Fset-error-props/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ehmicky","download_url":"https://codeload.github.com/ehmicky/set-error-props/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243976470,"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","deep","deepmerge","error","error-classes","error-handler","error-handling","error-monitoring","error-reporting","errors","exceptions","javascript","library","merge","message","monitoring","nodejs","properties","typescript"],"created_at":"2024-10-10T10:17:22.758Z","updated_at":"2025-03-19T08:30:47.834Z","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/set-error-props)\n[![Browsers](https://img.shields.io/badge/-Browsers-808080?logo=firefox\u0026colorA=404040)](https://unpkg.com/set-error-props?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/set-error-props)\n[![Minified size](https://img.shields.io/bundlephobia/minzip/set-error-props?label\u0026colorA=404040\u0026colorB=808080\u0026logo=webpack)](https://bundlephobia.com/package/set-error-props)\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 update an error's properties.\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- Prevents overriding [error core properties](#error-core-properties) (`name`,\n  `message`, etc.)\n- Protects against [prototype pollution](#prototype-pollution)\n- Prevents overriding [existing properties](#overriding-protection)\n- [Copies](#error-copy) another error's properties\n- Can set properties as [non-enumerable](#non-enumerable-properties)\n- Preserves properties [descriptors](#descriptors) (`enumerable`, `writable`,\n  `configurable`, `get`/`set`)\n- [Exception-safe](#exception-safety): this only throws syntax errors\n- Strict [TypeScript typing](/src/main.d.ts) of the return value\n\n# Example\n\n```js\nimport setErrorProps from 'set-error-props'\n\nconst error = new Error('one')\nsetErrorProps(error, { prop: true, message: 'two' })\nconsole.log(error.prop) // true\nconsole.log(error.message) // 'one': message is readonly\n```\n\n# Install\n\n```bash\nnpm install set-error-props\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## setErrorProps(error, props, options?)\n\n`error` `Error | object`\\\n`props` `Error | object`\\\n`options` [`Options?`](#options)\\\n_Return value_: `Error`\n\nAssigns `props` to `error`, then returns `error`.\n\n### Options\n\n#### soft\n\n_Type_: `boolean`\\\n_Default_: `false`\n\nPrevents [overriding](#overriding-protection) existing properties.\n\n# Usage\n\n## Error core properties\n\n```js\nconst error = new Error('one')\nsetErrorProps(error, { message: 'two' })\nconsole.log(error.message) // 'one'\n```\n\n## Prototype pollution\n\n```js\nconst error = new Error('one')\nsetErrorProps(error, { toString: () =\u003e 'injected' })\nconsole.log(error.toString()) // 'Error: one'\nconsole.log(Error.prototype.toString()) // 'Error'\n```\n\n## Overriding protection\n\n```js\nconst error = new Error('message')\nerror.one = true\nsetErrorProps(error, { one: false, two: true }, { soft: true })\nconsole.log(error.one) // true\nconsole.log(error.two) // true\n```\n\n## Error copy\n\n\u003c!-- eslint-disable fp/no-mutation --\u003e\n\n```js\nconst error = new Error('one')\nconst secondError = new Error('two')\nsecondError.prop = true\nsetErrorProps(error, secondError)\nconsole.log(error.message) // 'one'\nconsole.log(error.prop) // true\n```\n\n## Non-enumerable properties\n\n\u003c!-- eslint-disable fp/no-mutation, no-underscore-dangle --\u003e\n\n```js\nconst error = new Error('message')\n\n// Properties that start with `_` are not enumerable\nsetErrorProps(error, { _one: true, two: true })\n\nconsole.log(error._one) // true\nconsole.log(error.two) // true\nconsole.log(Object.keys(error)) // ['two']\nconsole.log(error) // Prints `two` but not `_one`\n```\n\n## Descriptors\n\n\u003c!-- eslint-disable fp/no-mutating-methods, fp/no-let, fp/no-mutation --\u003e\n\n```js\nconst error = new Error('message')\nObject.defineProperty(error, 'prop', {\n  value: false,\n  enumerable: false,\n  writable: true,\n  configurable: true,\n})\nsetErrorProps(error, { prop: true })\nconsole.log(error.prop) // true\nconsole.log(Object.getOwnPropertyDescriptor(error, 'prop').enumerable) // false\n```\n\n## Exception safety\n\n\u003c!-- eslint-disable fp/no-proxy --\u003e\n\n```js\nconst error = new Proxy(new Error('message'), {\n  set: () =\u003e {\n    throw new Error('example')\n  },\n  defineProperty: () =\u003e {\n    throw new Error('example')\n  },\n})\nsetErrorProps(error, { prop: true }) // This does not throw\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-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- [`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-stack`](https://github.com/ehmicky/set-error-stack): Properly\n  update an error's stack\n- [`merge-error-cause`](https://github.com/ehmicky/merge-error-cause): Merge an\n  error with its `cause`\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/set-error-props/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/set-error-props/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%2Fset-error-props","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fehmicky%2Fset-error-props","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fehmicky%2Fset-error-props/lists"}