feat: Add Cypress.stop types to document its availability more publicly

cli/CHANGELOG.md

@@ -1,8 +1,12 @@
 <!-- See the ../guides/writing-the-cypress-changelog.md for details on writing the changelog. -->
-## 14.1.1
+## 14.2.0
 
 _Released 3/11/2025 (PENDING)_
 
+**Feature:**
+
+- [`Cypress.stop()`](https://on.cypress.io/cypress-stop) is now available to stop the Cypress App on the current machine while tests are running. This can be useful for stopping test execution upon failures or other predefined conditions. Addresses [#518](https://github.com/cypress-io/cypress/issues/518). Addressed in [#31225](https://github.com/cypress-io/cypress/pull/31225).
+
 **Misc:**
 
 - Additional CLI options will be displayed in the terminal for some Cloud error messages. Addressed in [#31211](https://github.com/cypress-io/cypress/pull/31211).

cli/types/cypress.d.ts

@@ -570,6 +570,14 @@ declare namespace Cypress {
      */
     log(options: Partial<LogConfig>): Log
 
+    /**
+     * Stop the Cypress App on the current machine while tests are running
+     * @see https://on.cypress.io/cypress-stop
+     * @example
+     *    Cypress.stop()
+     */
+    stop(): void
+
     Commands: {
       /**
        * Add a custom command

cli/types/tests/cypress-tests.ts

@@ -55,6 +55,11 @@ namespace CypressEnvTests {
   })
 }
 
+namespace CypressStopTests {
+  Cypress.stop()       // $ExpectType void
+  Cypress.stop('foo')  // $ExpectError
+}
+
 namespace CypressIsCyTests {
   Cypress.isCy(cy) // $ExpectType boolean
   Cypress.isCy(undefined) // $ExpectType boolean

packages/driver/types/internal-types.d.ts

@@ -47,7 +47,6 @@ declare namespace Cypress {
       [routeId: string]: any
     }
     sinon: sinon.SinonApi
-    stop: () => void
     utils: CypressUtils
     state: State
     events: Events