Add ApplicationWindow type for user-defined properties in Window object

cypress-io · Jun 25, 2020 · daca22a · daca22a
1 parent ed80066
commit daca22a
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/cli/types/cypress.d.ts b/cli/types/cypress.d.ts
@@ -107,6 +107,11 @@ declare namespace Cypress {
     fromAutWindow: WindowPosition & { x: number, y: number }
   }
 
+  /**
+   * The interface for user-defined properties in Window object.
+   */
+  interface ApplicationWindow {} // tslint:disable-line
+
   /**
    * Several libraries are bundled with Cypress by default.
    *
@@ -2001,7 +2006,7 @@ declare namespace Cypress {
     })
     ```
      */
-    window(options?: Partial<Loggable & Timeoutable>): Chainable<Window & typeof globalThis>
+    window(options?: Partial<Loggable & Timeoutable>): Chainable<Window & typeof globalThis & ApplicationWindow>
 
     /**
      * Scopes all subsequent cy commands to within this element.

diff --git a/cli/types/tests/kitchen-sink.ts b/cli/types/tests/kitchen-sink.ts
@@ -144,7 +144,7 @@ namespace BlobTests {
 }
 
 cy.window().then(window => {
-  window // $ExpectType Window & typeof globalThis
+  window // $ExpectType Window & typeof globalThis & ApplicationWindow
 
   window.eval('1')
 })