types: add failures and message to npm module result (#5337)

* types: add failures and message to npm module result * remove memberof in comments
cypress-io · Oct 22, 2019 · bd54e3d · bd54e3d · cypress-bot · Oct 22, 2019
1 parent dd70563
commit bd54e3d
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 0 deletions.
diff --git a/cli/types/cypress-npm-api.d.ts b/cli/types/cypress-npm-api.d.ts
@@ -445,6 +445,7 @@ declare module 'cypress' {
 
   /**
    * Results returned by the test run.
+   * @see https://on.cypress.io/module-api
    */
   interface CypressRunResult {
     startedTestsAt: dateTimeISO
@@ -465,6 +466,29 @@ declare module 'cypress' {
     cypressVersion: string
     // TODO add resolved object to the configuration
     config: CypressConfiguration
+    /**
+     * If Cypress fails to run at all (for example, if there are no spec files to run),
+     * then it will set failures to 1 and will have actual error message in the
+     * property "message". Check this property before checking other properties.
+     *
+     * @type {number}
+     * @example
+      ```
+      const result = await cypress.run()
+      if (result.failures) {
+        console.error(result.message)
+        process.exit(result.failures)
+      }
+      ```
+     */
+    failures?: number
+    /**
+     * If returned result has "failures" set, then this property gives
+     * the error message.
+     *
+     * @type {string}
+     */
+    message?: string
   }
 
   /**

diff --git a/cli/types/tests/cypress-npm-api-test.ts b/cli/types/tests/cypress-npm-api-test.ts
@@ -1,3 +1,5 @@
+// type tests for Cypress NPM module
+// https://on.cypress.io/module-api
 import cypress from 'cypress'
 
 cypress.run // $ExpectType (options?: Partial<CypressRunOptions> | undefined) => Promise<CypressRunResult>
@@ -7,6 +9,8 @@ cypress.run({}).then(results => {
 })
 cypress.run().then(results => {
   results // $ExpectType CypressRunResult
+  results.failures // $ExpectType number | undefined
+  results.message // $ExpectType string | undefined
 })
 cypress.open() // $ExpectType Promise<void>
 cypress.run() // $ExpectType Promise<CypressRunResult>