{"id":15552421,"url":"https://github.com/bahmutov/error-snapshot","last_synced_at":"2025-09-28T23:31:29.736Z","repository":{"id":57239422,"uuid":"115235992","full_name":"bahmutov/error-snapshot","owner":"bahmutov","description":"Checks if given function throws an expected error (by saving snapshot)","archived":false,"fork":false,"pushed_at":"2017-12-27T22:16:31.000Z","size":13,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-12-27T20:52:11.519Z","etag":null,"topics":["error","snapshot","test","testing","utility"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bahmutov.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-12-24T02:57:52.000Z","updated_at":"2023-09-08T17:34:19.000Z","dependencies_parsed_at":"2022-08-29T22:22:27.577Z","dependency_job_id":null,"html_url":"https://github.com/bahmutov/error-snapshot","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bahmutov%2Ferror-snapshot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bahmutov%2Ferror-snapshot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bahmutov%2Ferror-snapshot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bahmutov%2Ferror-snapshot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bahmutov","download_url":"https://codeload.github.com/bahmutov/error-snapshot/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234570369,"owners_count":18854156,"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":["error","snapshot","test","testing","utility"],"created_at":"2024-10-02T14:19:19.137Z","updated_at":"2025-09-28T23:31:24.456Z","avatar_url":"https://github.com/bahmutov.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# error-snapshot\n\n\u003e Checks if given function throws an expected error (by saving snapshot)\n\n[![NPM][npm-icon] ][npm-url]\n\n[![Build status][ci-image] ][ci-url]\n[![semantic-release][semantic-image] ][semantic-url]\n[![js-standard-style][standard-image]][standard-url]\n\n## Install\n\nRequires [Node](https://nodejs.org/en/) version 6 or above.\n\n```sh\nnpm install --save-dev error-snapshot\n```\n\nBring a snapshot function, for example [snap-shot-it][snap-shot-it]\n\n```sh\nnpm install --save-dev snap-shot-it\n```\n\n## Use\n\nWhen checking if a function throws an error as expected when called\n\n```js\nconst snapshot = require('snap-shot-it')\nconst errorSnapshot = require('error-snapshot')(snapshot)\nit('snapshots error', () =\u003e {\n  const fn = () =\u003e {\n    throw new Error('A test error')\n  }\n  errorSnapshot(fn)\n})\n```\n\nFirst time the test runs, it will save error message snapshot. If the\nfunction does NOT throw an error, or if the error has a different message,\nit throws an error. The error message is saved into a snapshot file\nusing [snap-shot-it][snap-shot-it].\n\nBy default, the error message and the constructor name is saved, but\nyou can specify additional properties to pick.\n\n## Example\n\n```js\n// basic\nit('snapshots error', () =\u003e {\n  const fn = () =\u003e {\n    throw new Error('A test error')\n  }\n  errorSnapshot(fn)\n})\n// saved snapshot\nexports['snapshots error 1'] = {\n  \"name\": \"Error\",\n  \"message\": \"A test error\"\n}\n```\n\n```js\n// extra properties\nit('snapshots extra properties by name', () =\u003e {\n  const fn = () =\u003e {\n    const e = new Error('A test error')\n    e.foo = 42\n    e.bar = 'some bar prop'\n    throw e\n  }\n  errorSnapshot(fn, 'foo', 'bar')\n})\n// saved snapshot\nexports['snapshots extra properties by name 1'] = {\n  \"name\": \"Error\",\n  \"message\": \"A test error\",\n  \"foo\": 42,\n  \"bar\": \"some bar prop\"\n}\n```\n\nFor more examples, see [test file](src/error-snapshot-spec.js) and\nthe [snapshots](__snapshots__/error-snapshot-spec.js)\n\n[snap-shot-it]: https://github.com/bahmutov/snap-shot-it\n\n### Small print\n\nAuthor: Gleb Bahmutov \u0026lt;gleb.bahmutov@gmail.com\u0026gt; \u0026copy; 2017\n\n* [@bahmutov](https://twitter.com/bahmutov)\n* [glebbahmutov.com](https://glebbahmutov.com)\n* [blog](https://glebbahmutov.com/blog)\n\nLicense: MIT - do anything with the code, but don't blame me if it does not work.\n\nSupport: if you find any problems with this module, email / tweet /\n[open issue](https://github.com/bahmutov/error-snapshot/issues) on Github\n\n## MIT License\n\nCopyright (c) 2017 Gleb Bahmutov \u0026lt;gleb.bahmutov@gmail.com\u0026gt;\n\nPermission is hereby granted, free of charge, to any person\nobtaining a copy of this software and associated documentation\nfiles (the \"Software\"), to deal in the Software without\nrestriction, including without limitation the rights to use,\ncopy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the\nSoftware is furnished to do so, subject to the following\nconditions:\n\nThe above copyright notice and this permission notice shall be\nincluded in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES\nOF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND\nNONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT\nHOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,\nWHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING\nFROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR\nOTHER DEALINGS IN THE SOFTWARE.\n\n[npm-icon]: https://nodei.co/npm/error-snapshot.svg?downloads=true\n[npm-url]: https://npmjs.org/package/error-snapshot\n[ci-image]: https://travis-ci.org/bahmutov/error-snapshot.svg?branch=master\n[ci-url]: https://travis-ci.org/bahmutov/error-snapshot\n[semantic-image]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg\n[semantic-url]: https://github.com/semantic-release/semantic-release\n[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg\n[standard-url]: http://standardjs.com/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbahmutov%2Ferror-snapshot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbahmutov%2Ferror-snapshot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbahmutov%2Ferror-snapshot/lists"}