{"id":13769047,"url":"https://github.com/doniyor2109/jest-generator","last_synced_at":"2025-04-11T03:42:54.019Z","repository":{"id":53069753,"uuid":"157502335","full_name":"doniyor2109/jest-generator","owner":"doniyor2109","description":"Testing generator function never been easy","archived":false,"fork":false,"pushed_at":"2021-04-08T05:10:45.000Z","size":194,"stargazers_count":30,"open_issues_count":1,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-25T01:43:45.268Z","etag":null,"topics":["assertions","generator","generator-function","generator-functions","generators","jest","jest-matchers","testing"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/jest-generator","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/doniyor2109.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-11-14T06:33:11.000Z","updated_at":"2025-02-11T21:56:56.000Z","dependencies_parsed_at":"2022-09-20T00:13:24.828Z","dependency_job_id":null,"html_url":"https://github.com/doniyor2109/jest-generator","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/doniyor2109%2Fjest-generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/doniyor2109%2Fjest-generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/doniyor2109%2Fjest-generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/doniyor2109%2Fjest-generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/doniyor2109","download_url":"https://codeload.github.com/doniyor2109/jest-generator/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248143964,"owners_count":21054855,"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":["assertions","generator","generator-function","generator-functions","generators","jest","jest-matchers","testing"],"created_at":"2024-08-03T17:00:16.179Z","updated_at":"2025-04-11T03:42:54.001Z","avatar_url":"https://github.com/doniyor2109.png","language":"JavaScript","funding_links":[],"categories":["Packages"],"sub_categories":["Matchers"],"readme":"# jest-generator\n\n[![npm](https://img.shields.io/npm/v/jest-generator.svg)](https://www.npmjs.com/package/jest-generator)\n[![Build Status](https://travis-ci.com/doniyor2109/jest-generator.svg?branch=master)](https://travis-ci.com/doniyor2109/jest-generator)\n[![GitHub](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/doniyor2109/jest-generator/blob/master/LICENSE)\n[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/doniyor2109/jest-generator/pulls) \n\n\nTesting generators are verbose as they require calling `next` method of generator each time you want to iterate. `jest-generator` encapsulates all iteration and assertion logic itself. It provides easy and readable API for testing generator functions.\n\n![Testing with jest-generator](https://raw.githubusercontent.com/doniyor2109/jest-generator/master/jest-generator-example.png)\n\n\n# Installation\n\n```bash\n\nyarn add --dev jest-generator\n\n```\n\nor\n\n```bash\n\nnpm install --save-dev jest-generator\n\n```\n\n# Setup\n\n#### Via `setupTestFrameworkScriptFile` config\n\nAdd `jest-generator` to your Jest `setupTestFrameworkScriptFile` configuration\n\n```json\n\"jest\": {\n  \"setupTestFrameworkScriptFile\": \"jest-generator\"\n}\n```\n\n#### Via `setupTest` script\n\nRequire `jest-generator` from setupTest script\n\n```js\n// ./setupTest.js\n\nrequire('jest-generator');\n```\n\nThen add this config\n\n```json\n\"jest\": {\n  \"setupTestFrameworkScriptFile\": \"./setupTest.js\"\n}\n```\n\n# Usage\n\n```js\n// ./pay.js\n\nexport default function* pay() {\n  yield validatePayment();\n  yield makePayment();\n\n  return finishPayment();\n}\n```\n\n```js\n// ./pay.test.js\n\nimport pay from './pay';\n\ntest('should work correctly', () =\u003e {\n  const iterator = pay();\n\n  expect(iterator).toMatchYields([\n    [validatePayment()],\n    [makePayment()],\n    [finishPayment()]\n  ]);\n});\n\n```\n\n# Usage with other libraries\n\n## Usage with Saga\n\n \n```js\n// ./books.js\n\nexport function* loadBooks(params) {\n  try {\n    const response = yield call(api.loadBooks, params)\n    \n    yield put(booksLoadedSuccess(response))\n  } catch (error) {\n    yield put(booksLoadFail(error.message))\n  }\n}\n```\n\n```js\n// ./books.test.js\n\nimport { loadBooks } from './books';\n\ntest('should handle success response', () =\u003e {\n  const params = { id: 201 };\n  const iterator = loadBooks(params);\n  const response = [];\n\n  expect(iterator).toMatchYields([\n    [call(api.loadBooks, params), response],\n    [booksLoadedSuccess(response)],\n  ]);\n});\n\ntest('should handle error response', () =\u003e {\n  const params = { id: 201 };\n  const iterator = loadBooks(params);\n  const response = new Error('failed to load books');\n\n  expect(iterator).toMatchYields([\n    [call(api.loadBooks, params), response],\n    [put(booksLoadFail(response.message))],\n  ]);\n});\n\n```\n\n# API\n\n```js\n.toMatchYields(\n  yieldValues: [\n    [yieldValue: any, returnType?: any | Error]\n  ]\n)\n```\n\nMatches iterator against given yield values\n\n```js\nexpect(iterator).toMatchYields([\n  [callAPI()]\n])\n```\n\nIn order to return value from yield, simply pass your return value as second array value\n\n```js\nfunction* gen() {\n  const response = yield fetch()\n  yield update(response)\n}\n\nconst mockResponse = {};\nconst iterator = gen();\n\nexpect(iterator).toMatchYields([\n  [fetch(), mockResponse],\n  [update(mockResponse)]\n])\n```\n\nIn order to throw error from yield, you should simply pass `Error` instance to return type\n\n```js\nfunction* gen() {\n  const response = yield fetch()\n  yield update(response)\n}\n\nconst mockErrorResponse = new Error('network error');\nconst iterator = gen();\n\nexpect(iterator).toMatchYields([\n  [fetch(), mockErrorResponse],\n  [handleError(mockErrorResponse)]\n])\n```\n \n# Licence\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdoniyor2109%2Fjest-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdoniyor2109%2Fjest-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdoniyor2109%2Fjest-generator/lists"}