fix: Fix Typescript types for screenshot command. (#27130)

Co-authored-by: Mike Plummer <[email protected]> Co-authored-by: Mike Plummer <[email protected]>
cypress-io · Jul 7, 2023 · d56b628 · d56b628 · cypress-bot · Jul 7, 2023
1 parent 213afde
commit d56b628
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 2 deletions.
diff --git a/cli/CHANGELOG.md b/cli/CHANGELOG.md
@@ -1,4 +1,12 @@
 <!-- See the ../guides/writing-the-cypress-changelog.md for details on writing the changelog. -->
+## 12.17.1
+
+_Released 07/18/2023 (PENDING)_
+
+**Bugfixes:**
+
+- Fixed an issue with the Typescript types of [`cy.screenshot()`](https://docs.cypress.io/api/commands/screenshot). Fixed in [#27130](https://github.com/cypress-io/cypress/pull/27130).
+
 ## 12.17.0
 
 _Released 07/05/2023_

diff --git a/cli/types/cypress.d.ts b/cli/types/cypress.d.ts
@@ -1901,15 +1901,17 @@ declare namespace Cypress {
      *    cy.screenshot()
      *    cy.get(".post").screenshot()
      */
-    screenshot(options?: Partial<Loggable & Timeoutable & ScreenshotOptions>): Chainable<null>
+    screenshot(options?: Partial<Loggable & Timeoutable & ScreenshotOptions>): Chainable<Subject>
+
     /**
      * Take a screenshot of the application under test and the Cypress Command Log and save under given filename.
      *
      * @see https://on.cypress.io/screenshot
      * @example
+     *    cy.screenshot("post-element")
      *    cy.get(".post").screenshot("post-element")
      */
-    screenshot(fileName: string, options?: Partial<Loggable & Timeoutable & ScreenshotOptions>): Chainable<null>
+    screenshot(fileName: string, options?: Partial<Loggable & Timeoutable & ScreenshotOptions>): Chainable<Subject>
 
     /**
      * Scroll an element into view.

diff --git a/cli/types/tests/cypress-tests.ts b/cli/types/tests/cypress-tests.ts
@@ -292,6 +292,11 @@ namespace CypressCommandsTests {
 
     return originalFn(element, text, options)
   })
+  Cypress.Commands.overwrite<'screenshot', 'element'>('screenshot', (originalFn, subject, fileName, options) => {
+    subject // $ExpectType JQueryWithSelector<HTMLElement>
+    fileName // $ExpectType string
+    options // $ExpectType Partial<Loggable & Timeoutable & ScreenshotOptions> | undefined
+  })
 
   Cypress.Commands.addQuery('newQuery', function(arg) {
     this // $ExpectType Command
@@ -661,6 +666,9 @@ namespace CypressFilterTests {
 }
 
 namespace CypressScreenshotTests {
+  cy.screenshot().then((result) => {
+    result // $ExpectType undefined
+  })
   cy.screenshot('example-name')
   cy.screenshot('example', { log: false })
   cy.screenshot({ log: false })
@@ -672,6 +680,10 @@ namespace CypressScreenshotTests {
     log: true,
     blackout: []
   })
+  cy.get<HTMLDivElement>('#id').screenshot('example-name', { log: false })
+  cy.get<HTMLDivElement>('#id').screenshot().then((result) => {
+    result // $ExpectType JQuery<HTMLDivElement>
+  })
 }
 
 namespace CypressShadowDomTests {