{"_id":"@asanovr/ts-sinon","name":"@asanovr/ts-sinon","dist-tags":{"latest":"0.2.0"},"versions":{"0.2.0":{"name":"@asanovr/ts-sinon","version":"0.2.0","description":"

\"version\" \"downloads\"","author":{"name":"Omer \"version\" \"downloads\"","homepage":"https://github.com/golevelup/nestjs#readme","keywords":["NestJS","testing","utilities","levelup","sinon"],"repository":{"type":"git","url":"git+https://github.com/asanovr/nestjs.git"},"author":{"name":"Omer\n\"version\"\n\"downloads\"\n\"license\"\n

\n\n## Motivation\n\nWith `@golevelup/ts-sinon`'s `createMock` utility function, you can easily generate deeply nested mock objects for unit\ntesting, especially useful for mocking complex types like those found in NestJS.\n\n## Usage\n\nThis package is particularly handy when unit testing components in NestJS, but it's not limited to that. It can\nessentially mock any TypeScript interface!\n\n### Installation\n\n```sh\nnpm i @golevelup/ts-sinon --save-dev\n```\n\nor\n\n```sh\nyarn add @golevelup/ts-sinon --dev\n```\n\n### Creating Mocks\n\n1. Import the `createMock` function into your test class.\n2. Create a variable and set it equal to the `createMock` function with its generic type input.\n3. Use the mock, Luke.\n\nHere's an example with NestJS' `ExecutionContext`:\n\n```ts\nimport { createMock } from '@golevelup/ts-sinon';\nimport { ExecutionContext } from '@nestjs/common';\n\ndescribe('Mocked Execution Context', () => {\n it('should have a fully mocked Execution Context', () => {\n const mockExecutionContext = createMock();\n expect(mockExecutionContext.switchToHttp()).toBeDefined();\n });\n});\n```\n\n`createMock` generates all sub-properties as `sinon.stub()`, so you can chain method calls:\n\n```ts\nit('should correctly resolve mocked providers', async () => {\n const request = {\n key: 'val',\n };\n\n mockExecutionContext.switchToHttp.returns(\n createMock({\n getRequest: () => request,\n })\n );\n\n const mockResult = mockExecutionContext.switchToHttp().getRequest();\n expect(mockResult).toBe(request);\n});\n```\n\nYou can also easily provide your own mocks:\n\n```ts\nconst mockExecutionContext = createMock({\n switchToHttp: () => ({\n getRequest: () => ({\n headers: {\n authorization: 'auth',\n },\n }),\n getResponse: sinon.stub().returns({ data: 'res return data' }),\n }),\n});\n```\n\n> **Note**: When providing your own mocks, the number of times a parent mock function was called includes the times\n> needed to set your mocks.\n\n## Contribute\n\nContributions welcome! Read the [contribution guidelines](../../../CONTRIBUTING.md) first.\n\n## License\n\n[MIT License](../../../LICENSE)\n","readmeFilename":"README.md"}