codeceptjs 3.2.2 → 3.2.3

package/typings/types.d.ts

@@ -249,7 +249,7 @@ declare namespace CodeceptJS {
          * });
          * ```
          */
-        runOnIOS(caps: any, fn: any): void;
+        runOnIOS(caps: any, fn: any): Promise<any>;
         /**
          * Execute code only on Android
          *
@@ -281,7 +281,7 @@ declare namespace CodeceptJS {
          * });
          * ```
          */
-        runOnAndroid(caps: any, fn: any): void;
+        runOnAndroid(caps: any, fn: any): Promise<any>;
         /**
          * Check if an app is installed.
          *
@@ -289,10 +289,9 @@ declare namespace CodeceptJS {
          * I.seeAppIsInstalled("com.example.android.apis");
          * ```
          * @param bundleId - String  ID of bundled app
-         *
-         * Appium: support only Android
+         * @returns Appium: support only Android
          */
-        seeAppIsInstalled(bundleId: string): void;
+        seeAppIsInstalled(bundleId: string): Promise<void>;
         /**
          * Check if an app is not installed.
          *
@@ -300,10 +299,9 @@ declare namespace CodeceptJS {
          * I.seeAppIsNotInstalled("com.example.android.apis");
          * ```
          * @param bundleId - String  ID of bundled app
-         *
-         * Appium: support only Android
+         * @returns Appium: support only Android
          */
-        seeAppIsNotInstalled(bundleId: string): void;
+        seeAppIsNotInstalled(bundleId: string): Promise<void>;
         /**
          * Install an app on device.
          *
@@ -311,10 +309,9 @@ declare namespace CodeceptJS {
          * I.installApp('/path/to/file.apk');
          * ```
          * @param path - path to apk file
-         *
-         * Appium: support only Android
+         * @returns Appium: support only Android
          */
-        installApp(path: string): void;
+        installApp(path: string): Promise<void>;
         /**
          * Remove an app from the device.
          *
@@ -332,29 +329,27 @@ declare namespace CodeceptJS {
          * ```js
          * I.seeCurrentActivityIs(".HomeScreenActivity")
          * ```
-         * @param currentActivity - Appium: support only Android
+         * @returns Appium: support only Android
          */
-        seeCurrentActivityIs(currentActivity: string): void;
+        seeCurrentActivityIs(currentActivity: string): Promise<void>;
         /**
          * Check whether the device is locked.
          *
          * ```js
          * I.seeDeviceIsLocked();
          * ```
-         *
-         * Appium: support only Android
+         * @returns Appium: support only Android
          */
-        seeDeviceIsLocked(): void;
+        seeDeviceIsLocked(): Promise<void>;
         /**
          * Check whether the device is not locked.
          *
          * ```js
          * I.seeDeviceIsUnlocked();
          * ```
-         *
-         * Appium: support only Android
+         * @returns Appium: support only Android
          */
-        seeDeviceIsUnlocked(): void;
+        seeDeviceIsUnlocked(): Promise<void>;
         /**
          * Check the device orientation
          *
@@ -366,7 +361,7 @@ declare namespace CodeceptJS {
          *
          * Appium: support Android and iOS
          */
-        seeOrientationIs(orientation: 'LANDSCAPE' | 'PORTRAIT'): void;
+        seeOrientationIs(orientation: 'LANDSCAPE' | 'PORTRAIT'): Promise<void>;
         /**
          * Set a device orientation. Will fail, if app will not set orientation
          *
@@ -375,40 +370,36 @@ declare namespace CodeceptJS {
          * I.setOrientation('LANDSCAPE')
          * ```
          * @param orientation - LANDSCAPE or PORTRAIT
-         *
-         * Appium: support Android and iOS
+         * @returns Appium: support Android and iOS
          */
-        setOrientation(orientation: 'LANDSCAPE' | 'PORTRAIT'): void;
+        setOrientation(orientation: 'LANDSCAPE' | 'PORTRAIT'): Promise<any>;
         /**
          * Get list of all available contexts
          *
          * ```
          * let contexts = await I.grabAllContexts();
          * ```
-         *
-         * Appium: support Android and iOS
+         * @returns Appium: support Android and iOS
          */
-        grabAllContexts(): void;
+        grabAllContexts(): Promise<string[]>;
         /**
          * Retrieve current context
          *
          * ```js
          * let context = await I.grabContext();
          * ```
-         *
-         * Appium: support Android and iOS
+         * @returns Appium: support Android and iOS
          */
-        grabContext(): void;
+        grabContext(): Promise<string | null>;
         /**
          * Get current device activity.
          *
          * ```js
          * let activity = await I.grabCurrentActivity();
          * ```
-         *
-         * Appium: support only Android
+         * @returns Appium: support only Android
          */
-        grabCurrentActivity(): void;
+        grabCurrentActivity(): Promise<string>;
         /**
          * Get information about the current network connection (Data/WIFI/Airplane).
          * The actual server value will be a number. However WebdriverIO additional
@@ -417,30 +408,27 @@ declare namespace CodeceptJS {
          * ```js
          * let con = await I.grabNetworkConnection();
          * ```
-         *
-         * Appium: support only Android
+         * @returns Appium: support only Android
          */
-        grabNetworkConnection(): void;
+        grabNetworkConnection(): Promise<{}>;
         /**
          * Get current orientation.
          *
          * ```js
          * let orientation = await I.grabOrientation();
          * ```
-         *
-         * Appium: support Android and iOS
+         * @returns Appium: support Android and iOS
          */
-        grabOrientation(): void;
+        grabOrientation(): Promise<string>;
         /**
          * Get all the currently specified settings.
          *
          * ```js
          * let settings = await I.grabSettings();
          * ```
-         *
-         * Appium: support Android and iOS
+         * @returns Appium: support Android and iOS
          */
-        grabSettings(): void;
+        grabSettings(): Promise<string>;
         /**
          * Switch to the specified context.
          * @param context - the context to switch to
@@ -458,7 +446,7 @@ declare namespace CodeceptJS {
          * I.switchToWeb('WEBVIEW_io.selendroid.testapp');
          * ```
          */
-        switchToWeb(context?: string): void;
+        switchToWeb(context?: string): Promise<void>;
         /**
          * Switches to native context.
          * By default switches to NATIVE_APP context unless other specified.
@@ -470,17 +458,16 @@ declare namespace CodeceptJS {
          * I.switchToNative('SOME_OTHER_CONTEXT');
          * ```
          */
-        switchToNative(context: any): void;
+        switchToNative(context: any): Promise<void>;
         /**
          * Start an arbitrary Android activity during a session.
          *
          * ```js
          * I.startActivity('io.selendroid.testapp', '.RegisterUserActivity');
          * ```
-         *
-         * Appium: support only Android
+         * @returns Appium: support only Android
          */
-        startActivity(): void;
+        startActivity(): Promise<void>;
         /**
          * Set network connection mode.
          *
@@ -496,10 +483,9 @@ declare namespace CodeceptJS {
          * I.setNetworkConnection(6) // airplane mode off, wifi on, data on
          * ```
          * See corresponding [webdriverio reference](http://webdriver.io/api/mobile/setNetworkConnection.html).
-         *
-         * Appium: support only Android
+         * @returns Appium: support only Android
          */
-        setNetworkConnection(): void;
+        setNetworkConnection(): Promise<{}>;
         /**
          * Update the current setting on the device
          *
@@ -507,10 +493,9 @@ declare namespace CodeceptJS {
          * I.setSettings({cyberdelia: 'open'});
          * ```
          * @param settings - object
-         *
-         * Appium: support Android and iOS
+         * @returns Appium: support Android and iOS
          */
-        setSettings(settings: any): void;
+        setSettings(settings: any): Promise<any>;
         /**
          * Hide the keyboard.
          *
@@ -536,20 +521,18 @@ declare namespace CodeceptJS {
          * I.sendDeviceKeyEvent(3);
          * ```
          * @param keyValue - Device specific key value
-         *
-         * Appium: support only Android
+         * @returns Appium: support only Android
          */
-        sendDeviceKeyEvent(keyValue: number): void;
+        sendDeviceKeyEvent(keyValue: number): Promise<void>;
         /**
          * Open the notifications panel on the device.
          *
          * ```js
          * I.openNotifications();
          * ```
-         *
-         * Appium: support only Android
+         * @returns Appium: support only Android
          */
-        openNotifications(): void;
+        openNotifications(): Promise<void>;
         /**
          * The Touch Action API provides the basis of all gestures that can be
          * automated in Appium. At its core is the ability to chain together ad hoc
@@ -560,10 +543,9 @@ declare namespace CodeceptJS {
          * ```js
          * I.makeTouchAction("~buttonStartWebviewCD", 'tap');
          * ```
-         *
-         * Appium: support Android and iOS
+         * @returns Appium: support Android and iOS
          */
-        makeTouchAction(): void;
+        makeTouchAction(): Promise<void>;
         /**
          * Taps on element.
          *
@@ -573,7 +555,7 @@ declare namespace CodeceptJS {
          *
          * Shortcut for `makeTouchAction`
          */
-        tap(locator: any): void;
+        tap(locator: any): Promise<void>;
         /**
          * Perform a swipe on the screen.
          *
@@ -594,10 +576,9 @@ declare namespace CodeceptJS {
          * ```
          * @param [yoffset = 1000] - (optional)
          * @param [speed = 1000] - (optional), 1000 by default
-         *
-         * Appium: support Android and iOS
+         * @returns Appium: support Android and iOS
          */
-        swipeDown(locator: CodeceptJS.LocatorOrString, yoffset?: number, speed?: number): void;
+        swipeDown(locator: CodeceptJS.LocatorOrString, yoffset?: number, speed?: number): Promise<void>;
         /**
          * Perform a swipe left on an element.
          *
@@ -609,10 +590,9 @@ declare namespace CodeceptJS {
          * ```
          * @param [xoffset = 1000] - (optional)
          * @param [speed = 1000] - (optional), 1000 by default
-         *
-         * Appium: support Android and iOS
+         * @returns Appium: support Android and iOS
          */
-        swipeLeft(locator: CodeceptJS.LocatorOrString, xoffset?: number, speed?: number): void;
+        swipeLeft(locator: CodeceptJS.LocatorOrString, xoffset?: number, speed?: number): Promise<void>;
         /**
          * Perform a swipe right on an element.
          *
@@ -624,10 +604,9 @@ declare namespace CodeceptJS {
          * ```
          * @param [xoffset = 1000] - (optional)
          * @param [speed = 1000] - (optional), 1000 by default
-         *
-         * Appium: support Android and iOS
+         * @returns Appium: support Android and iOS
          */
-        swipeRight(locator: CodeceptJS.LocatorOrString, xoffset?: number, speed?: number): void;
+        swipeRight(locator: CodeceptJS.LocatorOrString, xoffset?: number, speed?: number): Promise<void>;
         /**
          * Perform a swipe up on an element.
          *
@@ -639,10 +618,9 @@ declare namespace CodeceptJS {
          * ```
          * @param [yoffset = 1000] - (optional)
          * @param [speed = 1000] - (optional), 1000 by default
-         *
-         * Appium: support Android and iOS
+         * @returns Appium: support Android and iOS
          */
-        swipeUp(locator: CodeceptJS.LocatorOrString, yoffset?: number, speed?: number): void;
+        swipeUp(locator: CodeceptJS.LocatorOrString, yoffset?: number, speed?: number): Promise<void>;
         /**
          * Perform a swipe in selected direction on an element to searchable element.
          *
@@ -655,9 +633,9 @@ declare namespace CodeceptJS {
          *    100,
          *    500);
          * ```
-         * @param speed - Appium: support Android and iOS
+         * @returns Appium: support Android and iOS
          */
-        swipeTo(searchableLocator: string, scrollLocator: string, direction: string, timeout: number, offset: number, speed: number): void;
+        swipeTo(searchableLocator: string, scrollLocator: string, direction: string, timeout: number, offset: number, speed: number): Promise<void>;
         /**
          * Performs a specific touch action.
          * The action object need to contain the action name, x/y coordinates
@@ -694,20 +672,18 @@ declare namespace CodeceptJS {
          * // save file to output dir
          * I.pullFile('/storage/emulated/0/DCIM/logo.png', output_dir);
          * ```
-         *
-         * Appium: support Android and iOS
+         * @returns Appium: support Android and iOS
          */
-        pullFile(): void;
+        pullFile(path: string, dest: string): Promise<string>;
         /**
          * Perform a shake action on the device.
          *
          * ```js
          * I.shakeDevice();
          * ```
-         *
-         * Appium: support only iOS
+         * @returns Appium: support only iOS
          */
-        shakeDevice(): void;
+        shakeDevice(): Promise<void>;
         /**
          * Perform a rotation gesture centered on the specified element.
          *
@@ -716,18 +692,16 @@ declare namespace CodeceptJS {
          * ```
          *
          * See corresponding [webdriverio reference](http://webdriver.io/api/mobile/rotate.html).
-         *
-         * Appium: support only iOS
+         * @returns Appium: support only iOS
          */
-        rotate(): void;
+        rotate(): Promise<void>;
         /**
          * Set immediate value in app.
          *
          * See corresponding [webdriverio reference](http://webdriver.io/api/mobile/setImmediateValue.html).
-         *
-         * Appium: support only iOS
+         * @returns Appium: support only iOS
          */
-        setImmediateValue(): void;
+        setImmediateValue(): Promise<void>;
         /**
          * Simulate Touch ID with either valid (match == true) or invalid (match == false) fingerprint.
          *
@@ -736,21 +710,19 @@ declare namespace CodeceptJS {
          * I.touchId(true); // simulates valid fingerprint
          * I.touchId(false); // simulates invalid fingerprint
          * ```
-         *
-         * Appium: support only iOS
+         * @returns Appium: support only iOS
          * TODO: not tested
          */
-        simulateTouchId(): void;
+        simulateTouchId(): Promise<void>;
         /**
          * Close the given application.
          *
          * ```js
          * I.closeApp();
          * ```
-         *
-         * Appium: support only iOS
+         * @returns Appium: support only iOS
          */
-        closeApp(): void;
+        closeApp(): Promise<void>;
         /**
          * Appends text to a input field or textarea.
          * Field is located by name, label, CSS or XPath
@@ -959,7 +931,7 @@ declare namespace CodeceptJS {
          * ```
          * @param fileName - file name to save.
          */
-        saveScreenshot(fileName: string): void;
+        saveScreenshot(fileName: string): Promise<void>;
         /**
          * Scroll element into viewport.
          *
@@ -1106,7 +1078,17 @@ declare namespace CodeceptJS {
      * I.amInPath('test');
      * I.seeFile('codecept.json');
      * I.seeInThisFile('FileSystem');
-     * I.dontSeeInThisFile("WebDriverIO");
+     * I.dontSeeInThisFile("WebDriver");
+     * ```
+     *
+     * ## Configuration
+     *
+     * Enable helper in config file:
+     *
+     * ```js
+     * helpers: {
+     *     FileSystem: {},
+     * }
      * ```
      *
      * ## Methods
@@ -2426,7 +2408,7 @@ declare namespace CodeceptJS {
      * * `keepBrowserState`: (optional, default: false) - keep browser state between tests when `restart` is set to false.
      * * `keepCookies`: (optional, default: false) - keep cookies between tests when `restart` is set to false.
      * * `waitForAction`: (optional) how long to wait after click, doubleClick or PressKey actions in ms. Default: 100.
-     * * `waitForNavigation`: (optional, default: 'load'). When to consider navigation succeeded. Possible options: `load`, `domcontentloaded`, `networkidle`. Choose one of those options is possible. See [Playwright API](https://github.com/microsoft/playwright/blob/master/docs/api.md#pagewaitfornavigationoptions).
+     * * `waitForNavigation`: (optional, default: 'load'). When to consider navigation succeeded. Possible options: `load`, `domcontentloaded`, `networkidle`. Choose one of those options is possible. See [Playwright API](https://github.com/microsoft/playwright/blob/main/docs/api.md#pagewaitfornavigationoptions).
      * * `pressKeyDelay`: (optional, default: '10'). Delay between key presses in ms. Used when calling Playwrights page.type(...) in fillField/appendField
      * * `getPageTimeout` (optional, default: '0') config option to set maximum navigation time in milliseconds.
      * * `waitForTimeout`: (optional) default wait* timeout in ms. Default: 1000.
@@ -2437,6 +2419,7 @@ declare namespace CodeceptJS {
      * * `manualStart`: (optional, default: false) - do not start browser before a test, start it manually inside a helper with `this.helpers["Playwright"]._startBrowser()`.
      * * `chromium`: (optional) pass additional chromium options
      * * `electron`: (optional) pass additional electron options
+     * * `channel`: (optional) While Playwright can operate against the stock Google Chrome and Microsoft Edge browsers available on the machine. In particular, current Playwright version will support Stable and Beta channels of these browsers. See [Google Chrome & Microsoft Edge](https://playwright.dev/docs/browsers/#google-chrome--microsoft-edge).
      *
      * #### Video Recording Customization
      *
@@ -2591,10 +2574,10 @@ declare namespace CodeceptJS {
          * First argument is a description of an action.
          * Second argument is async function that gets this helper as parameter.
          *
-         * { [`page`](https://github.com/microsoft/playwright/blob/master/docs/api.md#class-page), [`context`](https://github.com/microsoft/playwright/blob/master/docs/api.md#class-context) [`browser`](https://github.com/microsoft/playwright/blob/master/docs/api.md#class-browser) } objects from Playwright API are available.
+         * { [`page`](https://github.com/microsoft/playwright/blob/main/docs/src/api/class-page.md), [`context`](https://github.com/microsoft/playwright/blob/main/docs/src/api/class-browsercontext.md) [`browser`](https://github.com/microsoft/playwright/blob/main/docs/src/api/class-browser.md) } objects from Playwright API are available.
          *
          * ```js
-         * I.usePlaywrightTo('emulate offline mode', async ({ context }) {
+         * I.usePlaywrightTo('emulate offline mode', async ({ context }) => {
          *   await context.setOffline(true);
          * });
          * ```
@@ -2889,7 +2872,7 @@ declare namespace CodeceptJS {
          * I.openNewTab();
          * ```
          *
-         * You can pass in [page options](https://github.com/microsoft/playwright/blob/master/docs/api.md#browsernewpageoptions) to emulate device on this page
+         * You can pass in [page options](https://github.com/microsoft/playwright/blob/main/docs/api.md#browsernewpageoptions) to emulate device on this page
          *
          * ```js
          * // enable mobile