\n\n## Why we need it?\n\nQuite often we have to load data into a database before running tests.\nThis library helps to solve this problem effortlessly.\n\n## Usage example:\n\n#### 1. Create fixture creators (only once per project)\n\n```typescript\nimport { fixtureCreator, many, one } from \"typeorm-fixtures\";\n\nimport { Role } from \"../..\"; // this is typeorm Entity\nimport { Project } from \"../..\"; // this is typeorm Entity\nimport { User } from \"../..\"; // this is typeorm Entity\n\n// NOTICE: not arrow function here!\nexport const createUsersFixture = fixtureCreator(User, function(\n entity,\n index\n) {\n return {\n email: `test${index}@mail.com`,\n status: 10,\n ...entity,\n roles: many(this, Role, entity.roles)\n };\n});\n\n// NOTICE: not arrow function here!\nexport const createProjectsFixture = fixtureCreator(Project, function(\n entity,\n index\n) {\n return {\n title: `Default Title`,\n ...entity,\n owner: one(this, User, entity.owner)\n };\n});\n```\n\n#### 2. Create fixtures (each time for certain test)\n\n```typescript\nexport const usersFixture = createUsersFixture([\n {\n email: \"user@mail.com\",\n roles: [{ name: \"user\" }] // roles will automatically added here (look usage)\n },\n {\n email: \"admin@mail.com\",\n roles: [{ name: \"user\" }, { name: \"admin\" }]\n }\n]);\n\nexport const projectsFixture = createProjectsFixture([\n {\n owner: { email: \"admin@mail.com\" } // owner will automatically linked with user above\n }\n]);\n```\n\n#### 3. Download data before test and drop after\n\n```typescript\nimport { TypeormFixtures } from \"typeorm-fixtures\";\n\nconst h = new TypeormFixtures()\n .findEntities({ name: In([\"user\", \"admin\"]) }, Role) // sequence is important here!\n .addFixture(usersFixture) // sequence is important here!\n .addFixture(projectsFixture); // sequence is important here!\n\ndescribe(`GET /url`, async () => {\n let projectId: number;\n let user: User;\n\n beforeAll(async () => {\n await h.loadFixtures();\n projectId = h.entities.Project[0].id; // this is our project id, which was loaded\n user = h.entities.User.find(el => el.email === \"user@mail.com\"); // we also can find loaded user by email\n });\n\n afterAll(h.dropFixtures);\n\n it(\"test\", async () => {\n // now all data loaded to database and you can perform any actions here\n });\n});\n```\n\n## Install\n\n```bash\nnpm i typeorm-fixtures --save-dev\n```\n\n```bash\nyarn add typeorm-fixtures --dev\n```\n\n## Stay in touch\n\n- Author - [Razzwan](https://t.me/Razzwan)\n\n## Thanks for helping\n\n- [Artem Batura](https://github.com/artemirq)\n- [Volodymyr Steblii](https://github.com/vsteblii)\n\n## License\n\nNest is [MIT licensed](LICENSE).\n\n## [Contributing](CONTRIBUTING.md)\n","readmeFilename":"README.md"}
![](\"https://github.com/typeorm/typeorm/raw/master/resources/logo_big.png\"){kind=logo}
\n \n ![\"npm](\"https://badge.fury.io/js/typeorm-fixtures.svg\"){kind=icon}
\n \n