TypeScript: strict parameter type for location (#5574)

* TypeScript: strict parameter type for `location` * extend Location, return correct type * add type tests Co-authored-by: Zach Bloomquist <github@chary.us>
cypress-io · Dec 19, 2019 · 78d0536 · 78d0536 · cypress-bot · Dec 19, 2019
1 parent 720bc47
commit 78d0536
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/cli/types/index.d.ts b/cli/types/index.d.ts
@@ -930,7 +930,7 @@ declare namespace Cypress {
      *    // Assert on the href of the location
      *    cy.location('href').should('contain', '/tag/tutorials')
      */
-    location(key: string, options?: Partial<Loggable & Timeoutable>): Chainable<Location>
+    location<K extends keyof Location>(key: K, options?: Partial<Loggable & Timeoutable>): Chainable<Location[K]>
 
     /**
      * Print a message to the Cypress Command Log.

diff --git a/cli/types/tests/cypress-tests.ts b/cli/types/tests/cypress-tests.ts
@@ -332,3 +332,9 @@ namespace CypressContainsTests {
   cy.contains('#app', 'my text to find', {log: false, timeout: 100})
   cy.contains('my text to find', {log: false, timeout: 100})
 }
+
+// https://github.com/cypress-io/cypress/pull/5574
+namespace CypressLocationTests {
+  cy.location('path') // $ExpectError
+  cy.location('pathname') // $ExpectType Chainable<string>
+}