fix: Introduce CypressCommandLine namespace to type NPM module api

cypress-io · Jul 29, 2020 · 15c71c5 · 15c71c5 · cypress-bot · Jul 29, 2020
1 parent b5b92a4
commit 15c71c5
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 4 deletions.
diff --git a/cli/types/cypress-npm-api.d.ts b/cli/types/cypress-npm-api.d.ts
@@ -6,7 +6,7 @@
 // in the future the NPM module itself will be in TypeScript
 // but for now describe it as an ambient module
 
-declare module 'cypress' {
+declare namespace CypressCommandLine {
   /**
    * All options that one can pass to "cypress.run"
    * @see https://on.cypress.io/module-api#cypress-run
@@ -324,7 +324,9 @@ declare module 'cypress' {
      */
     parseRunArguments(args: string[]): Promise<Partial<CypressRunOptions>>
   }
+}
 
+declare module 'cypress' {
   /**
    * Cypress NPM module interface.
    * @see https://on.cypress.io/module-api
@@ -349,19 +351,19 @@ declare module 'cypress' {
      })
      ```
      */
-    run(options?: Partial<CypressRunOptions>): Promise<CypressRunResult | CypressFailedRunResult>,
+    run(options?: Partial<CypressCommandLine.CypressRunOptions>): Promise<CypressCommandLine.CypressRunResult | CypressCommandLine.CypressFailedRunResult>,
     /**
      * Opens Cypress GUI. Resolves with void when the
      * GUI is closed.
      * @see https://on.cypress.io/module-api#cypress-open
      */
-    open(options?: Partial<CypressOpenOptions>): Promise<void>
+    open(options?: Partial<CypressCommandLine.CypressOpenOptions>): Promise<void>
 
     /**
      * Utility functions for parsing CLI arguments the same way
      * Cypress does
      */
-    cli: CypressCliParser
+    cli: CypressCommandLine.CypressCliParser
   }
 
   // export Cypress NPM module interface

diff --git a/cli/types/tests/cypress-npm-api-test.ts b/cli/types/tests/cypress-npm-api-test.ts
@@ -38,3 +38,7 @@ const runConfig: Cypress.ConfigOptions = {
   },
 }
 cypress.run({ config: runConfig })
+
+cypress.run({}).then((results) => {
+  results as CypressCommandLine.CypressRunResult // $ExpectType CypressRunResult
+})