{"_id":"@bugsplat/vitest-auto-spies","name":"@bugsplat/vitest-auto-spies","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@bugsplat/vitest-auto-spies","version":"1.0.0","publishConfig":{"access":"public"},"author":{"name":"BugSplat","url":"https://bugsplat.com"},"contributors":[{"name":"Shai Reznik"}],"description":"Create automatic spies from classes in Vitest tests, also for promises and observables","license":"MIT","keywords":["vitest","spies","mocks","async methods","TypeScript Tests","RxJS testing","Promises tests"],"homepage":"https://github.com/BugSplat-Git/auto-spies/tree/main/packages/vitest-auto-spies","repository":{"type":"git","url":"git+https://github.com/BugSplat-Git/auto-spies.git","directory":"packages/vitest-auto-spies"},"main":"dist/index.js","types":"dist/index.d.ts","scripts":{"clean":"rimraf dist tsconfig.build.tsbuildinfo","compile":"tsc -b tsconfig.build.json","build":"run-s clean compile","test":"vitest","test:watch":"vitest --watchAll"},"devDependencies":{"@types/node":"22.13.14","vitest":"^4.0.16","rxjs":"^7.5.1","typescript":"^5.9.2"},"dependencies":{"@hirez_io/auto-spies-core":"3.0.0"},"peerDependencies":{"vitest":">=1.0.0","rxjs":">=6.0.0 < 8","typescript":">=4.7.0"},"type":"module","_id":"@bugsplat/vitest-auto-spies@1.0.0","gitHead":"90d16bcdb5d1b4ab83f3969f2ec047e12c634005","bugs":{"url":"https://github.com/BugSplat-Git/auto-spies/issues"},"_nodeVersion":"22.18.0","_npmVersion":"10.9.3","dist":{"integrity":"sha512-EbhudLU41sMbjCfQcUwolpriJf2Jcnld/dCx2JhQ8ctqDyApd8i6BRGei0okVIWZEpyhOB5PhxWAgVSKTKGJ8A==","shasum":"aedc845d98c4e47c76f34f93a2ae33abfc4b4d3f","tarball":"https://registry.npmjs.org/@bugsplat/vitest-auto-spies/-/vitest-auto-spies-1.0.0.tgz","fileCount":33,"unpackedSize":168533,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIAwDD9FZpbcwSX6FG9vrVOvwvMLstX4UgQcCo9uoBuL0AiEAkgCQA6kriw2mnGqlQ2i9u59jAfMP0xntgeaR9BdDVW0="}]},"_npmUser":{"name":"bugsplat","email":"support@bugsplat.com"},"directories":{},"maintainers":[{"name":"bugsplat","email":"support@bugsplat.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/vitest-auto-spies_1.0.0_1770230861163_0.6457274986063672"},"_hasShrinkwrap":false}},"time":{"created":"2026-02-04T18:47:41.108Z","1.0.0":"2026-02-04T18:47:41.337Z","modified":"2026-02-04T18:47:41.965Z"},"maintainers":[{"name":"bugsplat","email":"support@bugsplat.com"}],"description":"Create automatic spies from classes in Vitest tests, also for promises and observables","homepage":"https://github.com/BugSplat-Git/auto-spies/tree/main/packages/vitest-auto-spies","keywords":["vitest","spies","mocks","async methods","TypeScript Tests","RxJS testing","Promises tests"],"repository":{"type":"git","url":"git+https://github.com/BugSplat-Git/auto-spies.git","directory":"packages/vitest-auto-spies"},"contributors":[{"name":"Shai Reznik"}],"author":{"name":"BugSplat","url":"https://bugsplat.com"},"bugs":{"url":"https://github.com/BugSplat-Git/auto-spies/issues"},"license":"MIT","readme":"# vitest-auto-spies\n\nEasy and type safe way to write spies for vitest tests, for both sync and async (promises, Observables) returning methods.\n\n[](https://www.npmjs.org/package/vitest-auto-spies)\n[](http://npm-stat.com/charts.html?package=vitest-auto-spies&from=2017-07-26)\n\n[](https://codecov.io/gh/hirezio/auto-spies)\n[](../../CODE_OF_CONDUCT.md)\n[](https://opensource.org/licenses/MIT) \n[](#contributors-)\n\n \n\n
\n\n \n\n# Table of Contents\n\n\n\n\n- [Installation](#installation)\n\n- [THE PROBLEM: writing manual spies is tedious](#the-problem-writing-manual-spies-is-tedious)\n- [THE SOLUTION: Auto Spies! πͺ](#the-solution-auto-spies-)\n\n- [Usage (JavaScript)](#usage-javascript)\n\n- [Usage (TypeScript)](#usage-typescript)\n\n - [βΆ Angular developers - use `TestBed.inject(...)`](#-angular-developers---use-testbedinjectany)\n - [βΆ Spying on synchronous methods](#-spying-on-synchronous-methods)\n - [βΆ Spying on methods (manually)](#-spying-on-methods-manually)\n - [βΆ Spying on Promises](#-spying-on-promises)\n - [βΆ Spying on Observables](#-spying-on-observables)\n - [βΆ Spying on observable properties](#-spying-on-observable-properties)\n - [βΆ `calledWith()` - conditional return values](#-calledwith---conditional-return-values)\n\n - [βΆ `mustBeCalledWith()` - conditional return values that throw errors (Mocks)](#-mustbecalledwith---conditional-return-values-that-throw-errors-mocks)\n - [βΆ Create accessors spies (getters and setters)](#-create-accessors-spies-getters-and-setters)\n - [βΆ Spying on a function](#-spying-on-a-function)\n - [βΆ Spying on abstract classes](#-spying-on-abstract-classes)\n - [βΆ `createObservableWithValues()` - Create a pre-configured standalone observable](##-createobservablewithvalues---create-a-pre-configured-standalone-observable)\n\n- [Contributing](#contributing)\n- [Code Of Conduct](#code-of-conduct)\n- [Contributors β¨](#contributors-)\n- [License](#license)\n\n\n\n \n\n## Installation\n\n```console\npnpm add -D vitest-auto-spies\n```\n\nor\n\n```console\nnpm install -D vitest-auto-spies\n```\n\n \n\n## THE PROBLEM: writing manual spies is tedious\n\nYou've probably seen this type of manual spies in tests:\n\n```js\nlet mySpy = {\n myMethod: vi.fn(),\n};\n```\n\nThe problem with that is first -\n\n- β You need to repeat the method names in each test.\n- β Strings are not \"type safe\" or \"refactor friendly\"\n- β You don't have the ability to write conditional return values\n- β You don't have helper methods for Observables\n\n \n\n# THE SOLUTION: Auto Spies! πͺ\n\nIf you need to create a spy from any class, just do:\n\n```js\nconst myServiceSpy = createSpyFromClass(MyService);\n```\n\nTHAT'S IT!\n\nIf you're using TypeScript, you get EVEN MORE BENEFITS:\n\n```ts\nconst myServiceSpy: Spy = createSpyFromClass(MyService);\n```\n\nNow that you have an auto spy you'll be able to:\n\n- β Have a spy with all of its methods generated **automatically** as \"spy methods\".\n\n- β Rename/refactor your methods and have them **change in ALL tests at once**\n\n- β Asynchronous helpers for **Promises** and **Observables**.\n\n- β Conditional return values with `calledWith` and `mustBeCalledWith`\n\n- β Have **Type completion** for both the original Class and the spy methods\n\n- β Spy on **getters** and **setters**\n\n- β Spy on **Observable properties**\n\n \n\n## Usage (JavaScript)\n\n### `my-component.js`\n\n```js\nexport class MyComponent {\n constructor(myService) {\n this.myService = myService;\n }\n init() {\n this.compData = this.myService.getData();\n }\n}\n```\n\n### `my-service.js`\n\n```js\nexport class MyService{\n\n getData{\n return [\n { ...someRealData... }\n ]\n }\n}\n```\n\n### `my-spec.js`\n\n```js\nimport { createSpyFromClass } from 'vitest-auto-spies';\nimport { MyService } from './my-service';\nimport { MyComponent } from './my-component';\n\ndescribe('MyComponent', () => {\n let myServiceSpy;\n let componentUnderTest;\n\n beforeEach(() => {\n // π\n myServiceSpy = createSpyFromClass(MyService); // <- THIS IS THE IMPORTANT LINE\n\n componentUnderTest = new MyComponent(myServiceSpy);\n });\n\n it('should fetch data on init', () => {\n const fakeData = [{ fake: 'data' }];\n\n myServiceSpy.getData.mockReturnValue(fakeData);\n\n componentUnderTest.init();\n\n expect(myServiceSpy.getData).toHaveBeenCalled();\n expect(componentUnderTest.compData).toEqual(fakeData);\n });\n});\n```\n\n \n\n## Usage (TypeScript)\n\n### βΆ Angular developers - use `TestBed.inject(...)`\n\nβ Make sure you cast your spy with `any` when you inject it:\n\n```ts\nimport { MyService } from './my-service';\nimport { Spy, createSpyFromClass } from 'vitest-auto-spies';\n\nlet serviceUnderTest: MyService;\n\n// π\nlet apiServiceSpy: Spy;\n\nbeforeEach(() => {\n TestBed.configureTestingModule({\n providers: [\n MyService,\n // π\n { provide: ApiService, useValue: createSpyFromClass(ApiService) },\n ],\n });\n\n serviceUnderTest = TestBed.inject(MyService);\n\n // π\n apiServiceSpy = TestBed.inject(ApiService);\n});\n```\n\n \n\n### βΆ Spying on synchronous methods\n\n```ts\n// my-service.ts\n\nclass MyService{\n getName(): string{\n return 'Bonnie';\n }\n}\n\n// my-spec.ts\n\nimport { Spy, createSpyFromClass } from 'vitest-auto-spies';\nimport { MyService } from './my-service';\n\n// π\nlet myServiceSpy: Spy; // <- THIS IS THE IMPORTANT LINE\n\nbeforeEach( ()=> {\n // π\n myServiceSpy = createSpyFromClass( MyService );\n});\n\nit('should do something', ()=> {\n myServiceSpy.getName.mockReturnValue('Fake Name');\n\n ... (the rest of the test) ...\n});\n\n```\n\n \n\n### βΆ Spying on methods (manually)\n\nFor cases that you have methods which are not part of the Class prototype (but instead being defined in the constructor), for example:\n\n```ts\nclass MyClass {\n constructor() {\n this.customMethod1 = function () {\n // This definition is not part of MyClass' prototype\n };\n }\n}\n```\n\nYou can **FORCE** the creation of this methods spies like this:\n\n```\n// π\nlet spy = createSpyFromClass(MyClass, ['customMethod1', 'customMethod2']);\n```\n\n**OR THIS WAY** -\n\n```ts\nlet spy = createSpyFromClass(MyClass, {\n // π\n methodsToSpyOn: ['customMethod1', 'customMethod2'],\n});\n```\n\n \n\n### βΆ Spying on Promises\n\nUse the `resolveWith` or `rejectWith` methods.\n\nβ You **must define a return type** `: Promise` for it to work!\n\n```ts\n// SERVICE:\n\nclass MyService {\n // (you must define a return type)\n // π\n getItems(): Promise {\n return http.get('/items');\n }\n}\n\n// TEST:\n\nimport { Spy, createSpyFromClass } from 'vitest-auto-spies';\n\nlet myServiceSpy: Spy;\n\nbeforeEach(() => {\n myServiceSpy = createSpyFromClass(MyService);\n});\n\nit(() => {\n // π\n myServiceSpy.getItems.resolveWith(fakeItemsList);\n // OR\n // π\n myServiceSpy.getItems.rejectWith(fakeError);\n\n // OR\n // π\n myServiceSpy.getItems.resolveWithPerCall([\n // π return this promise for the FIRST getItems() call\n { value: fakeItemsList },\n // π return this promise with a delay of 2 seconds (2000ms) for the SECOND getItems() call\n { value: someOtherItemsList, delay: 2000 },\n ]);\n});\n```\n\nalthough with `vitest` you don't really have to do that as you have the native `mockResolvedValue` and `mockRejectedValue` -\n\n```ts\nimport { Spy, createSpyFromClass } from 'vitest-auto-spies';\n\nlet myServiceSpy: Spy;\n\nbeforeEach(() => {\n myServiceSpy = createSpyFromClass(MyService);\n});\n\nit(() => {\n // π\n myServiceSpy.getItems.mockResolvedValue(fakeItemsList);\n // OR\n // π\n myServiceSpy.getItems.mockRejectedValue(fakeError);\n});\n```\n\nSo the `resolveWith` and `rejectWith` are useful for backward compatibility if you're migrating from `jasmine-auto-spies`.\n\n \n\n### βΆ Spying on Observables\n\nUse the `nextWith` or `throwWith` and other helper methods.\n\nβ You **must define a return type** `: Observable` for it to work!\n\n```ts\n// SERVICE:\n\nclass MyService {\n // (you must define a return type)\n // π\n getItems(): Observable {\n return http.get('/items');\n }\n}\n\n// TEST:\n\nimport { Spy, createSpyFromClass } from 'vitest-auto-spies';\n\nlet myServiceSpy: Spy;\n\nbeforeEach(() => {\n myServiceSpy = createSpyFromClass(MyService);\n});\n\nit(() => {\n // π\n myServiceSpy.getItems.nextWith(fakeItemsList);\n\n // OR\n // π\n myServiceSpy.getItems.nextOneTimeWith(fakeItemsList); // emits one value and completes\n\n // OR\n // π\n myServiceSpy.getItems.nextWithValues([\n { value: fakeItemsList },\n { value: fakeItemsList, delay: 1000 },\n { errorValue: someError }, // <- will throw this error, you can also add a \"delay\"\n { complete: true }, // <- you can add a \"delay\" as well\n ]);\n\n // OR\n // π\n const subjects = myServiceSpy.getItems.nextWithPerCall([\n // π return this observable for the FIRST getItems() call\n { value: fakeItemsList },\n\n // π return this observable after 2 seconds for the SECOND getItems call()\n { value: someOtherItemsList, delay: 2000 },\n\n // π by default, the observable completes after 1 value\n // set \"doNotComplete\" if you want to keep manually emit values\n { value: someOtherItemsList, doNotComplete: true },\n ]);\n subjects[2].next('yet another emit');\n subjects[2].complete();\n\n // OR\n // π\n myServiceSpy.getItems.throwWith(fakeError);\n\n // OR\n // π\n myServiceSpy.getItems.complete();\n\n // OR\n\n // \"returnSubject\" is good for cases where you want\n // to separate the Spy Observable creation from it's usage.\n\n // π\n const subject = myServiceSpy.getItems.returnSubject(); // create and get a ReplaySubject\n subject.next(fakeItemsList);\n});\n```\n\n \n\n### βΆ Spying on observable properties\n\nIf you have a property that extends the `Observable` type, you can create a spy for it as follows:\n\n```ts\n\nMyClass{\n myObservable: Observable;\n mySubject: Subject;\n}\n\nit('should spy on observable properties', ()=>{\n\n let classSpy = createSpyFromClass(MyClass, {\n // π\n observablePropsToSpyOn: ['myObservable', 'mySubject']\n }\n );\n\n // and then you could configure it with methods like `nextWith`:\n // π\n classSpy.myObservable.nextWith('FAKE VALUE');\n\n let actualValue;\n classSpy.myObservable.subscribe((value) => actualValue = value )\n\n expect(actualValue).toBe('FAKE VALUE');\n\n})\n\n```\n\n \n\n### βΆ `calledWith()` - conditional return values\n\nYou can setup the expected arguments ahead of time\nby using `calledWith` like so:\n\n```ts\n// π\nmyServiceSpy.getProducts.calledWith(1).returnValue(true);\n```\n\nand it will only return this value if your subject was called with `getProducts(1)`.\n\n#### Oh, and it also works with Promises / Observables:\n\n```ts\n// π π\nmyServiceSpy.getProductsPromise.calledWith(1).resolveWith(true);\n\n// OR\n\nmyServiceSpy.getProducts$.calledWith(1).nextWith(true);\n\n// OR ANY OTHER ASYNC CONFIGURATION METHOD...\n```\n\n \n\n### βΆ `mustBeCalledWith()` - conditional return values that throw errors (Mocks)\n\n```ts\n// π\nmyServiceSpy.getProducts.mustBeCalledWith(1).returnValue(true);\n```\n\nis the same as:\n\n```ts\nmyServiceSpy.getProducts.mockReturnValue(true);\n\nexpect(myServiceSpy.getProducts).toHaveBeenCalledWith(1);\n```\n\nBut the difference is that the error is being thrown during `getProducts()` call and not in the `expect(...)` call.\n\n \n\n### βΆ Create accessors spies (getters and setters)\n\nIf you have a property that extends the `Observable` type, you can create a spy for it.\n\nYou need to configure whether you'd like to create a \"SetterSpy\" or a \"GetterSpy\" by using the configuration `settersToSpyOn` and `GettersToSpyOn`.\n\nThis will create an object on the Spy called `accessorSpies` and through that you'll gain access to either the \"setter spies\" or the \"getter spies\":\n\n```ts\n\n// CLASS:\n\nMyClass{\n private _myProp: number;\n get myProp(){\n return _myProp;\n }\n set myProp(value: number){\n _myProp = value;\n }\n}\n\n// TEST:\n\nlet classSpy: Spy;\n\nbeforeEach(()=>{\n classSpy = createSpyFromClass(MyClass, {\n\n // π\n gettersToSpyOn: ['myProp'],\n\n // π\n settersToSpyOn: ['myProp']\n });\n})\n\nit('should return the fake value', () => {\n\n // π π π\n classSpy.accessorSpies.getters.myProp.mockReturnValue(10);\n\n expect(classSpy.myProp).toBe(10);\n});\n\nit('allow spying on setter', () => {\n\n classSpy.myProp = 2;\n\n // π π π\n expect(classSpy.accessorSpies.setters.myProp).toHaveBeenCalledWith(2);\n});\n\n```\n\n \n\n### βΆ Spying on a function\n\nYou can create an \"auto spy\" for a function using:\n\n```ts\nimport { createFunctionSpy } from 'vitest-auto-spies';\n\ndescribe('Testing a function', () => {\n it('should be able to spy on a function', () => {\n function addTwoNumbers(a, b) {\n return a + b;\n }\n // π π\n const functionSpy = createFunctionSpy('addTwoNumbers');\n\n functionSpy.mockReturnValue(4);\n\n expect(functionSpy()).toBe(4);\n });\n});\n```\n\nCould also be useful for Observables -\n\n```ts\n// FUNCTION:\n\nfunction getResultsObservable(): Observable {\n return of(1, 2, 3);\n}\n\n// TEST:\n\nit('should ...', () => {\n const functionSpy =\n createFunctionSpy('getResultsObservable');\n\n functionSpy.nextWith(4);\n\n // ... rest of the test\n});\n```\n\n \n\n### βΆ Spying on abstract classes\n\nHere's a nice trick you could apply in order to spy on abstract classes -\n\n```ts\n// π\nabstract class MyAbstractClass {\n getName(): string {\n return 'Bonnie';\n }\n}\n\ndescribe(() => {\n // π\n abstractClassSpy = createSpyFromClass(MyAbstractClass as any);\n abstractClassSpy.getName.mockReturnValue('Evil Baboon');\n});\n```\n\nAnd if you have **abstract methods** on that abstract class -\n\n```ts\nabstract class MyAbstractClass {\n // π\n abstract getAnimalName(): string;\n}\n\ndescribe(() => {\n // π\n abstractClassSpy = createSpyFromClass(MyAbstractClass as any, [\n 'getAnimalName',\n ]);\n // OR\n\n abstractClassSpy.getAnimalName.mockReturnValue('Evil Badger');\n});\n```\n\n \n\n### βΆ `createObservableWithValues()` - Create a pre-configured standalone observable\n\n**MOTIVATION:** You can use this in order to create fake observable inputs with delayed values (instead of using marbles).\n\nAccepts the same configuration as `nextWithValues` but returns a standalone observable.\n\n**EXAMPLE:**\n\n```ts\n//\nimport { createObservableWithValues } from 'jasmine-auto-spies';\n\nit('should emit the correct values', () => {\n // π\n const observableUnderTest = createObservableWithValues([\n { value: fakeItemsList },\n { value: secondFakeItemsList, delay: 1000 },\n { errorValue: someError }, // <- will throw this error, you can also add a \"delay\" to the error\n { complete: true }, // <- you can also add a \"delay\" to the complete\n ]);\n});\n```\n\nAnd if you need to emit more values, you can set `returnSubject` to true and get the subject as well.\n\n```ts\nit('should emit the correct values', () => {\n // π π\n const { subject, values$ } = createObservableWithValues(\n [\n { value: fakeItemsList },\n { value: secondFakeItemsList, delay: 1000 },\n { errorValue: someError }, // <- will throw this error, you can also add a \"delay\" to the error\n { complete: true }, // <- you can also add a \"delay\" to the complete\n ],\n // π\n { returnSubject: true }\n );\n\n subject.next(moreValues);\n});\n```\n\n \n\n### βΆ `provideAutoSpy()` - Small Utility for Angular Tests\n\nThis will save you the need to type:\n\n`{ provide: MyService, useValue: createSpyFromClass(MyService, config?) }`\n\n**INTERFACE**: `provideAutoSpy(Class, config?)`\n\n**USAGE EXAMPLE:**\n\n```ts\nTestBed.configureTestingModule({\n\n providers: [\n MyComponent,\n provideAutoSpy(MyService)\n ];\n})\n\nmyServiceSpy = TestBed.inject(MyService);\n\n```\n\n \n\n---\n\n \n\n## Contributing\n\nWant to contribute? Yayy! π\n\nPlease read and follow our [Contributing Guidelines](../../CONTRIBUTING.md) to learn what are the right steps to take before contributing your time, effort and code.\n\nThanks π\n\n \n\n## Code Of Conduct\n\nBe kind to each other and please read our [code of conduct](../../CODE_OF_CONDUCT.md).\n\n \n\n## Contributors β¨\n\nThanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n\n\n\n\n
\n\n\n\n\n\n\nThis project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!\n\n \n\n## License\n\nMIT\n","readmeFilename":"README.md","_rev":"1-548dfa6122e01efc5302339b1679d039"}
![\"TestAngular.com](\"../../for-readme/test-angular.jpg\"\n)
\n \n![\"\"/](\"https://avatars1.githubusercontent.com/u/1430726?v=4?s=100\")
![\"\"/](\"https://avatars0.githubusercontent.com/u/5407478?v=4\")
![\"\"/](\"https://avatars.githubusercontent.com/u/5721205?v=4?s=100\")