Merge pull request #19 from ShellyDCMS/add-types-for-spies-and-stubs

add types for stubbing and spying
ShellyDCMS · Aug 27, 2023 · 5613fe7 · 5613fe7
2 parents ea3f82b + 8526ea3
commit 5613fe7
Show file tree

Hide file tree

Showing 7 changed files with 25 additions and 16 deletions.
diff --git a/documents/classes/CypressAngularComponentHelper.md b/documents/classes/CypressAngularComponentHelper.md
@@ -1,4 +1,4 @@
-[@shellygo/cypress-test-utils - v1.0.30](../README.md) / [Modules](../modules.md) / CypressAngularComponentHelper
+[@shellygo/cypress-test-utils - v1.0.32](../README.md) / [Modules](../modules.md) / CypressAngularComponentHelper
 
 # Class: CypressAngularComponentHelper<T\>
 

diff --git a/documents/classes/CypressHelper.md b/documents/classes/CypressHelper.md
@@ -1,4 +1,4 @@
-[@shellygo/cypress-test-utils - v1.0.30](../README.md) / [Modules](../modules.md) / CypressHelper
+[@shellygo/cypress-test-utils - v1.0.32](../README.md) / [Modules](../modules.md) / CypressHelper
 
 # Class: CypressHelper
 
@@ -262,8 +262,8 @@ This is a classic place to have methods which will set the inputs which are goin
 | Name | Type |
 | :------ | :------ |
 | `interceptAndMockResponse` | (`options`: { `alias?`: `string` ; `method?`: `string` ; `response`: `Object` ; `url`: `StringMatcher`  }) => `void` |
-| `spy` | (`name`: `string`) => `Omit`<`SinonSpy`<`any`[], `any`\>, ``"withArgs"``\> & `SinonSpyAgent`<`SinonSpy`<`any`[], `any`\>\> & `SinonSpy`<`any`[], `any`\> |
-| `spyOnObject` | <T\>(`obj`: `T`, `method`: keyof `T`) => `Omit`<`SinonSpy`<`any`[], `any`\>, ``"withArgs"``\> & `SinonSpyAgent`<`SinonSpy`<`any`[], `any`\>\> & `SinonSpy`<`any`[], `any`\> |
+| `spy` | (`name`: `string`) => `Agent`<`SinonSpy`<`any`[], `any`\>\> |
+| `spyOnObject` | <T\>(`obj`: `T`, `method`: keyof `T`) => `Agent`<`SinonSpy`<`any`[], `any`\>\> |
 | `stub` | () => `Agent`<`SinonStub`<`any`[], `any`\>\> |
 
 **interceptAndMockResponse**: (`options`: { `alias?`: `string` ; `method?`: `string` ; `response`: `Object` ; `url`: `StringMatcher`  }) => `void`
@@ -327,13 +327,13 @@ helper.given.interceptAndMockResponse({
 
 -----
 
-**spy**: (`name`: `string`) => `Omit`<`SinonSpy`<`any`[], `any`\>, ``"withArgs"``\> & `SinonSpyAgent`<`SinonSpy`<`any`[], `any`\>\> & `SinonSpy`<`any`[], `any`\>
+**spy**: (`name`: `string`) => `Agent`<`SinonSpy`<`any`[], `any`\>\>
 
 Returns a new spy function, and creates an alias for the newly created spy
 
 -----
 
-**spyOnObject**: <T\>(`obj`: `T`, `method`: keyof `T`) => `Omit`<`SinonSpy`<`any`[], `any`\>, ``"withArgs"``\> & `SinonSpyAgent`<`SinonSpy`<`any`[], `any`\>\> & `SinonSpy`<`any`[], `any`\>
+**spyOnObject**: <T\>(`obj`: `T`, `method`: keyof `T`) => `Agent`<`SinonSpy`<`any`[], `any`\>\>
 
 Spy on a method and create an alias for the spy
 

diff --git a/documents/classes/CypressLitComponentHelper.md b/documents/classes/CypressLitComponentHelper.md
@@ -1,4 +1,4 @@
-[@shellygo/cypress-test-utils - v1.0.30](../README.md) / [Modules](../modules.md) / CypressLitComponentHelper
+[@shellygo/cypress-test-utils - v1.0.32](../README.md) / [Modules](../modules.md) / CypressLitComponentHelper
 
 # Class: CypressLitComponentHelper
 

diff --git a/documents/classes/CypressReactComponentHelper.md b/documents/classes/CypressReactComponentHelper.md
@@ -1,4 +1,4 @@
-[@shellygo/cypress-test-utils - v1.0.30](../README.md) / [Modules](../modules.md) / CypressReactComponentHelper
+[@shellygo/cypress-test-utils - v1.0.32](../README.md) / [Modules](../modules.md) / CypressReactComponentHelper
 
 # Class: CypressReactComponentHelper
 

diff --git a/documents/modules.md b/documents/modules.md
@@ -1,6 +1,6 @@
-[@shellygo/cypress-test-utils - v1.0.30](README.md) / Modules
+[@shellygo/cypress-test-utils - v1.0.32](README.md) / Modules
 
-# @shellygo/cypress-test-utils - v1.0.30
+# @shellygo/cypress-test-utils - v1.0.32
 
 ## Table of contents
 

diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@shellygo/cypress-test-utils",
   "description": "Test Automation Utilities",
-  "version": "1.0.31",
+  "version": "1.0.32",
   "author": "Shelly Goldblit",
   "private": false,
   "license": "MIT",

diff --git a/src/cypress-helper.ts b/src/cypress-helper.ts
@@ -104,18 +104,27 @@ export class CypressHelper {
     },
     /**
      * Replace a function, record its usage and control its behavior.
+     * @returns {Cypress.Agent<sinon.SinonStub<any[], any>>}
+
      */
-    stub: () => cy.stub(),
+    stub: (): Cypress.Agent<sinon.SinonStub<any[], any>> => cy.stub(),
     /**
      * Returns a new spy function, and creates an alias for the newly created spy
      * @param name - spy name
+     * @returns {Cypress.Agent<sinon.SinonSpy<any[], any>>}
      */
-    spy: (name: string) => cy.spy().as(`${name}Spy`),
+    spy: (name: string): Cypress.Agent<sinon.SinonSpy<any[], any>> =>
+      cy.spy().as(`${name}Spy`),
     /**
      * Spy on a method and create an alias for the spy
-     *
-     */
-    spyOnObject: <T>(obj: T, method: keyof T) =>
+     * @param obj - object containing function to spy on
+     * @param method function to spy on
+     * @returns {Cypress.Agent<sinon.SinonSpy<any[], any>>}
+     */
+    spyOnObject: <T>(
+      obj: T,
+      method: keyof T
+    ): Cypress.Agent<sinon.SinonSpy<any[], any>> =>
       cy.spy(obj, method).as(`${String(method)}Spy`)
   };