codeceptjs 3.5.4 → 3.5.5

package/typings/types.d.ts

@@ -2075,12 +2075,14 @@ declare namespace CodeceptJS {
          * ```
          * @param fn - function to be executed in browser context.
          * @param args - to be passed to function.
+         * @returns script return value
+         *
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          *
          *
          * Wrapper for synchronous [evaluate](https://github.com/segmentio/nightmare#evaluatefn-arg1-arg2)
          */
-        executeScript(fn: string | ((...params: any[]) => any), ...args: any[]): void;
+        executeScript(fn: string | ((...params: any[]) => any), ...args: any[]): Promise<any>;
         /**
          * Executes async script on page.
          * Provided function should execute a passed callback (as first argument) to signal it is finished.
@@ -2104,13 +2106,15 @@ declare namespace CodeceptJS {
          * ```
          * @param fn - function to be executed in browser context.
          * @param args - to be passed to function.
+         * @returns script return value
+         *
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          *
          *
          * Wrapper for asynchronous [evaluate](https://github.com/segmentio/nightmare#evaluatefn-arg1-arg2).
          * Unlike NightmareJS implementation calling `done` will return its first argument.
          */
-        executeAsyncScript(fn: string | ((...params: any[]) => any), ...args: any[]): void;
+        executeAsyncScript(fn: string | ((...params: any[]) => any), ...args: any[]): Promise<any>;
         /**
          * Resize the current window to provided width and height.
          * First parameter can be set to `maximize`.
@@ -5648,9 +5652,11 @@ declare namespace CodeceptJS {
          * ```
          * @param fn - function to be executed in browser context.
          * @param args - to be passed to function.
+         * @returns script return value
+         *
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          */
-        executeScript(fn: string | ((...params: any[]) => any), ...args: any[]): void;
+        executeScript(fn: string | ((...params: any[]) => any), ...args: any[]): Promise<any>;
         /**
          * Executes async script on page.
          * Provided function should execute a passed callback (as first argument) to signal it is finished.
@@ -5674,9 +5680,11 @@ declare namespace CodeceptJS {
          * ```
          * @param fn - function to be executed in browser context.
          * @param args - to be passed to function.
+         * @returns script return value
+         *
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          */
-        executeAsyncScript(fn: string | ((...params: any[]) => any), ...args: any[]): void;
+        executeAsyncScript(fn: string | ((...params: any[]) => any), ...args: any[]): Promise<any>;
         /**
          * Checks that current url contains a provided fragment.
          *
@@ -7446,12 +7454,14 @@ declare namespace CodeceptJS {
          * ```
          * @param fn - function to be executed in browser context.
          * @param args - to be passed to function.
+         * @returns script return value
+         *
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          *
          *
          * If a function returns a Promise It will wait for it resolution.
          */
-        executeScript(fn: string | ((...params: any[]) => any), ...args: any[]): void;
+        executeScript(fn: string | ((...params: any[]) => any), ...args: any[]): Promise<any>;
         /**
          * Executes async script on page.
          * Provided function should execute a passed callback (as first argument) to signal it is finished.
@@ -7475,12 +7485,14 @@ declare namespace CodeceptJS {
          * ```
          * @param fn - function to be executed in browser context.
          * @param args - to be passed to function.
+         * @returns script return value
+         *
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          *
          *
          * Asynchronous scripts can also be executed with `executeScript` if a function returns a Promise.
          */
-        executeAsyncScript(fn: string | ((...params: any[]) => any), ...args: any[]): void;
+        executeAsyncScript(fn: string | ((...params: any[]) => any), ...args: any[]): Promise<any>;
         /**
          * Retrieves all texts from an element located by CSS or XPath and returns it to test.
          * Resumes test execution, so **should be used inside async with `await`** operator.
@@ -8748,12 +8760,14 @@ declare namespace CodeceptJS {
          * ```
          * @param fn - function to be executed in browser context.
          * @param args - to be passed to function.
+         * @returns script return value
+         *
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          *
          *
          * If a function returns a Promise It will wait for its resolution.
          */
-        executeScript(fn: string | ((...params: any[]) => any), ...args: any[]): void;
+        executeScript(fn: string | ((...params: any[]) => any), ...args: any[]): Promise<any>;
         /**
          * Retrieves all texts from an element located by CSS or XPath and returns it to test.
          * Resumes test execution, so **should be used inside async with `await`** operator.
@@ -10276,13 +10290,15 @@ declare namespace CodeceptJS {
          * ```
          * @param fn - function to be executed in browser context.
          * @param args - to be passed to function.
+         * @returns script return value
+         *
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          *
          *
          *
          * Wraps [execute](http://webdriver.io/api/protocol/execute.html) command.
          */
-        executeScript(fn: string | ((...params: any[]) => any), ...args: any[]): void;
+        executeScript(fn: string | ((...params: any[]) => any), ...args: any[]): Promise<any>;
         /**
          * Executes async script on page.
          * Provided function should execute a passed callback (as first argument) to signal it is finished.
@@ -10306,9 +10322,11 @@ declare namespace CodeceptJS {
          * ```
          * @param fn - function to be executed in browser context.
          * @param args - to be passed to function.
+         * @returns script return value
+         *
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          */
-        executeAsyncScript(fn: string | ((...params: any[]) => any), ...args: any[]): void;
+        executeAsyncScript(fn: string | ((...params: any[]) => any), ...args: any[]): Promise<any>;
         /**
          * Scroll element into viewport.
          *
@@ -11075,7 +11093,7 @@ declare namespace CodeceptJS {
         /**
          * Run a specific test or all loaded tests.
          */
-        run(test?: string): void;
+        run(test?: string): Promise<void>;
     }
     /**
      * Current configuration
@@ -11449,7 +11467,9 @@ declare namespace CodeceptJS {
     /**
      * Pauses test execution and starts interactive shell
      */
-    function pause(): void;
+    function pause(passedObject?: {
+        [key: string]: any;
+    }): void;
     /**
      * Singleton object to record all test steps as promises and run them in chain.
      */