codeceptjs 3.5.10 → 3.5.12-beta.1

package/typings/promiseBasedTypes.d.ts

@@ -972,9 +972,9 @@ declare namespace CodeceptJS {
          * I.scrollIntoView('#submit', { behavior: "smooth", block: "center", inline: "center" });
          * ```
          * @param locator - located by CSS|XPath|strict locator.
-         * @param scrollIntoViewOptions - see https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView.
+         * @param scrollIntoViewOptions - either alignToTop=true|false or scrollIntoViewOptions. See https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView.
          */
-        scrollIntoView(locator: LocatorOrString, scrollIntoViewOptions: ScrollIntoViewOptions): Promise<any>;
+        scrollIntoView(locator: LocatorOrString, scrollIntoViewOptions: ScrollIntoViewOptions | boolean): Promise<any>;
         /**
          * Verifies that the specified checkbox is checked.
          *
@@ -1107,7 +1107,7 @@ declare namespace CodeceptJS {
      * {
      *   helpers: {
      *     Playwright: {...},
-     *     ExpectHelper: {},
+     *     Expect: {},
      *   }
      * }
      * ```
@@ -1115,57 +1115,51 @@ declare namespace CodeceptJS {
      * ## Methods
      */
     class ExpectHelper {
-        expectEqual(actualValue: any, expectedValue: any, customErrorMsg: any): Promise<any>;
-        expectNotEqual(actualValue: any, expectedValue: any, customErrorMsg: any): Promise<any>;
-        expectDeepEqual(actualValue: any, expectedValue: any, customErrorMsg: any): Promise<any>;
-        expectNotDeepEqual(actualValue: any, expectedValue: any, customErrorMsg: any): Promise<any>;
-        expectContain(actualValue: any, expectedValueToContain: any, customErrorMsg: any): Promise<any>;
-        expectNotContain(actualValue: any, expectedValueToNotContain: any, customErrorMsg: any): Promise<any>;
-        expectStartsWith(actualValue: any, expectedValueToStartWith: any, customErrorMsg: any): Promise<any>;
-        expectNotStartsWith(actualValue: any, expectedValueToNotStartWith: any, customErrorMsg: any): Promise<any>;
-        expectEndsWith(actualValue: any, expectedValueToEndWith: any, customErrorMsg: any): Promise<any>;
-        expectNotEndsWith(actualValue: any, expectedValueToNotEndWith: any, customErrorMsg: any): Promise<any>;
-        expectJsonSchema(targetData: any, jsonSchema: any, customErrorMsg: any): Promise<any>;
+        expectEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): Promise<any>;
+        expectNotEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): Promise<any>;
+        expectDeepEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): Promise<any>;
+        expectNotDeepEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): Promise<any>;
+        expectContain(actualValue: any, expectedValueToContain: any, customErrorMsg?: any): Promise<any>;
+        expectNotContain(actualValue: any, expectedValueToNotContain: any, customErrorMsg?: any): Promise<any>;
+        expectStartsWith(actualValue: any, expectedValueToStartWith: any, customErrorMsg?: any): Promise<any>;
+        expectNotStartsWith(actualValue: any, expectedValueToNotStartWith: any, customErrorMsg?: any): Promise<any>;
+        expectEndsWith(actualValue: any, expectedValueToEndWith: any, customErrorMsg?: any): Promise<any>;
+        expectNotEndsWith(actualValue: any, expectedValueToNotEndWith: any, customErrorMsg?: any): Promise<any>;
+        expectJsonSchema(targetData: any, jsonSchema: any, customErrorMsg?: any): Promise<any>;
         /**
          * @param ajvOptions - Pass AJV options
          */
-        expectJsonSchemaUsingAJV(targetData: any, jsonSchema: any, customErrorMsg: any, ajvOptions: any): Promise<any>;
-        expectHasProperty(targetData: any, propertyName: any, customErrorMsg: any): Promise<any>;
-        expectHasAProperty(targetData: any, propertyName: any, customErrorMsg: any): Promise<any>;
-        expectToBeA(targetData: any, type: any, customErrorMsg: any): Promise<any>;
-        expectToBeAn(targetData: any, type: any, customErrorMsg: any): Promise<any>;
-        expectMatchRegex(targetData: any, regex: any, customErrorMsg: any): Promise<any>;
-        expectLengthOf(targetData: any, length: any, customErrorMsg: any): Promise<any>;
-        expectEmpty(targetData: any, customErrorMsg: any): Promise<any>;
-        expectTrue(targetData: any, customErrorMsg: any): Promise<any>;
-        expectFalse(targetData: any, customErrorMsg: any): Promise<any>;
-        /**
-         * @param aboveThan - number | Date
-         */
-        expectAbove(targetData: any, aboveThan: any, customErrorMsg: any): Promise<any>;
-        /**
-         * @param belowThan - number | Date
-         */
-        expectBelow(targetData: any, belowThan: any, customErrorMsg: any): Promise<any>;
-        expectLengthAboveThan(targetData: any, lengthAboveThan: any, customErrorMsg: any): Promise<any>;
-        expectLengthBelowThan(targetData: any, lengthBelowThan: any, customErrorMsg: any): Promise<any>;
-        expectEqualIgnoreCase(actualValue: any, expectedValue: any, customErrorMsg: any): Promise<any>;
+        expectJsonSchemaUsingAJV(targetData: any, jsonSchema: any, customErrorMsg?: any, ajvOptions: any): Promise<any>;
+        expectHasProperty(targetData: any, propertyName: any, customErrorMsg?: any): Promise<any>;
+        expectHasAProperty(targetData: any, propertyName: any, customErrorMsg?: any): Promise<any>;
+        expectToBeA(targetData: any, type: any, customErrorMsg?: any): Promise<any>;
+        expectToBeAn(targetData: any, type: any, customErrorMsg?: any): Promise<any>;
+        expectMatchRegex(targetData: any, regex: any, customErrorMsg?: any): Promise<any>;
+        expectLengthOf(targetData: any, length: any, customErrorMsg?: any): Promise<any>;
+        expectEmpty(targetData: any, customErrorMsg?: any): Promise<any>;
+        expectTrue(targetData: any, customErrorMsg?: any): Promise<any>;
+        expectFalse(targetData: any, customErrorMsg?: any): Promise<any>;
+        expectAbove(targetData: any, aboveThan: any, customErrorMsg?: any): Promise<any>;
+        expectBelow(targetData: any, belowThan: any, customErrorMsg?: any): Promise<any>;
+        expectLengthAboveThan(targetData: any, lengthAboveThan: any, customErrorMsg?: any): Promise<any>;
+        expectLengthBelowThan(targetData: any, lengthBelowThan: any, customErrorMsg?: any): Promise<any>;
+        expectEqualIgnoreCase(actualValue: any, expectedValue: any, customErrorMsg?: any): Promise<any>;
         /**
          * expects members of two arrays are deeply equal
          */
-        expectDeepMembers(actualValue: any, expectedValue: any, customErrorMsg: any): Promise<any>;
+        expectDeepMembers(actualValue: any, expectedValue: any, customErrorMsg?: any): Promise<any>;
         /**
          * expects an array to be a superset of another array
          */
-        expectDeepIncludeMembers(superset: any, set: any, customErrorMsg: any): Promise<any>;
+        expectDeepIncludeMembers(superset: any, set: any, customErrorMsg?: any): Promise<any>;
         /**
          * expects members of two JSON objects are deeply equal excluding some properties
          */
-        expectDeepEqualExcluding(actualValue: any, expectedValue: any, fieldsToExclude: any, customErrorMsg: any): Promise<any>;
+        expectDeepEqualExcluding(actualValue: any, expectedValue: any, fieldsToExclude: any, customErrorMsg?: any): Promise<any>;
         /**
          * expects a JSON object matches a provided pattern
          */
-        expectMatchesPattern(actualValue: any, expectedPattern: any, customErrorMsg: any): Promise<any>;
+        expectMatchesPattern(actualValue: any, expectedPattern: any, customErrorMsg?: any): Promise<any>;
     }
     /**
      * Helper for testing filesystem.
@@ -2950,7 +2944,7 @@ declare namespace CodeceptJS {
          * });
          * ```
          * @param description - used to show in logs.
-         * @param fn - async function that executed with Playwright helper as argumen
+         * @param fn - async function that executed with Playwright helper as arguments
          */
         usePlaywrightTo(description: string, fn: (...params: any[]) => any): Promise<any>;
         /**
@@ -3035,6 +3029,18 @@ declare namespace CodeceptJS {
          */
         amOnPage(url: string): Promise<any>;
         /**
+         * Unlike other drivers Playwright changes the size of a viewport, not the window!
+         * Playwright does not control the window of a browser, so it can't adjust its real size.
+         * It also can't maximize a window.
+         *
+         * Update configuration to change real window size on start:
+         *
+         * ```js
+         * // inside codecept.conf.js
+         * // @codeceptjs/configure package must be installed
+         * { setWindowSize } = require('@codeceptjs/configure');
+         * ````
+         *
          * Resize the current window to provided width and height.
          * First parameter can be set to `maximize`.
          * @param width - width in pixels or `maximize`.
@@ -3111,6 +3117,13 @@ declare namespace CodeceptJS {
          */
         grabDisabledElementStatus(locator: CodeceptJS.LocatorOrString, options?: any): Promise<boolean>;
         /**
+         * ```js
+         * // specify coordinates for source position
+         * I.dragAndDrop('img.src', 'img.dst', { sourcePosition: {x: 10, y: 10} })
+         * ```
+         *
+         * > When no option is set, custom drag and drop would be used, to use the dragAndDrop API from Playwright, please set options, for example `force: true`
+         *
          * Drag an item to a destination element.
          *
          * ```js
@@ -3119,13 +3132,6 @@ declare namespace CodeceptJS {
          * @param srcElement - located by CSS|XPath|strict locator.
          * @param destElement - located by CSS|XPath|strict locator.
          * @param [options] - [Additional options](https://playwright.dev/docs/api/class-page#page-drag-and-drop) can be passed as 3rd argument.
-         *
-         * ```js
-         * // specify coordinates for source position
-         * I.dragAndDrop('img.src', 'img.dst', { sourcePosition: {x: 10, y: 10} })
-         * ```
-         *
-         * > When no option is set, custom drag and drop would be used, to use the dragAndDrop API from Playwright, please set options, for example `force: true`
          */
         dragAndDrop(srcElement: LocatorOrString, destElement: LocatorOrString, options?: any): Promise<any>;
         /**
@@ -3441,12 +3447,7 @@ declare namespace CodeceptJS {
          * // using strict locator
          * I.click({css: 'nav a.login'});
          * ```
-         * @param locator - clickable link or button located by text, or any element located by CSS|XPath|strict locator.
-         * @param [context = null] - (optional, `null` by default) element to search in CSS|XPath|Strict locator.
-         * @param [options] - [Additional options](https://playwright.dev/docs/api/class-page#page-click) for click available as 3rd argument.
-         *
-         * Examples:
-         *
+         * @example
          * ```js
          * // click on element at position
          * I.click('canvas', '.model', { position: { x: 20, y: 40 } })
@@ -3454,6 +3455,9 @@ declare namespace CodeceptJS {
          * // make ctrl-click
          * I.click('.edit', null, { modifiers: ['Ctrl'] } )
          * ```
+         * @param locator - clickable link or button located by text, or any element located by CSS|XPath|strict locator.
+         * @param [context = null] - (optional, `null` by default) element to search in CSS|XPath|Strict locator.
+         * @param [options] - [Additional options](https://playwright.dev/docs/api/class-page#page-click) for click available as 3rd argument.
          */
         click(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString | null, options?: any): Promise<any>;
         /**
@@ -3519,6 +3523,16 @@ declare namespace CodeceptJS {
          */
         rightClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<any>;
         /**
+         * [Additional options](https://playwright.dev/docs/api/class-elementhandle#element-handle-check) for check available as 3rd argument.
+         *
+         * Examples:
+         *
+         * ```js
+         * // click on element at position
+         * I.checkOption('Agree', '.signup', { position: { x: 5, y: 5 } })
+         * ```
+         * > ⚠️ To avoid flakiness, option `force: true` is set by default
+         *
          * Selects a checkbox or radio button.
          * Element is located by label or name or CSS or XPath.
          *
@@ -3534,6 +3548,16 @@ declare namespace CodeceptJS {
          */
         checkOption(field: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<any>;
         /**
+         * [Additional options](https://playwright.dev/docs/api/class-elementhandle#element-handle-uncheck) for uncheck available as 3rd argument.
+         *
+         * Examples:
+         *
+         * ```js
+         * // click on element at position
+         * I.uncheckOption('Agree', '.signup', { position: { x: 5, y: 5 } })
+         * ```
+         * > ⚠️ To avoid flakiness, option `force: true` is set by default
+         *
          * Unselects a checkbox or radio button.
          * Element is located by label or name or CSS or XPath.
          *
@@ -3597,6 +3621,8 @@ declare namespace CodeceptJS {
          */
         pressKeyUp(key: string): Promise<any>;
         /**
+         * _Note:_ Shortcuts like `'Meta'` + `'A'` do not work on macOS ([GoogleChrome/Puppeteer#1313](https://github.com/GoogleChrome/puppeteer/issues/1313)).
+         *
          * Presses a key in the browser (on a focused element).
          *
          * _Hint:_ For populating text field or textarea, it is recommended to use [`fillField`](#fillfield).
@@ -3981,6 +4007,8 @@ declare namespace CodeceptJS {
          */
         dontSeeCookie(name: string): Promise<any>;
         /**
+         * Returns cookie in JSON format. If name not passed returns all cookies for this domain.
+         *
          * Gets a cookie object by name.
          * If none provided gets all cookies.
          * Resumes test execution, so **should be used inside async function with `await`** operator.
@@ -4015,8 +4043,8 @@ declare namespace CodeceptJS {
          * ```js
          * I.executeScript(({x, y}) => x + y, {x, y});
          * ```
-         * You can pass only one parameter into a function
-         * but you can pass in array or object.
+         * You can pass only one parameter into a function,
+         * or you can pass in array or object.
          *
          * ```js
          * I.executeScript(([x, y]) => x + y, [x, y]);
@@ -4285,6 +4313,8 @@ declare namespace CodeceptJS {
          */
         waitForElement(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<any>;
         /**
+         * This method accepts [React selectors](https://codecept.io/react).
+         *
          * Waits for an element to become visible on a page (by default waits for 1sec).
          * Element can be located by CSS or XPath.
          *
@@ -4317,6 +4347,16 @@ declare namespace CodeceptJS {
          * @param [sec = 1] - (optional, `1` by default) time in seconds to wait
          */
         waitToHide(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<any>;
+        /**
+         * Waits for number of tabs.
+         *
+         * ```js
+         * I.waitForNumberOfTabs(2);
+         * ```
+         * @param expectedTabs - expecting the number of tabs.
+         * @param sec - number of secs to wait.
+         */
+        waitForNumberOfTabs(expectedTabs: number, sec: number): Promise<any>;
         /**
          * Waiting for the part of the URL to match the expected. Useful for SPA to understand that page was changed.
          *
@@ -6188,6 +6228,10 @@ declare namespace CodeceptJS {
          */
         amOnPage(url: string): Promise<any>;
         /**
+         * Unlike other drivers Puppeteer changes the size of a viewport, not the window!
+         * Puppeteer does not control the window of a browser, so it can't adjust its real size.
+         * It also can't maximize a window.
+         *
          * Resize the current window to provided width and height.
          * First parameter can be set to `maximize`.
          * @param width - width in pixels or `maximize`.
@@ -6357,7 +6401,7 @@ declare namespace CodeceptJS {
          */
         _locate(): Promise<any>;
         /**
-         * Find a checkbox by providing human readable text:
+         * Find a checkbox by providing human-readable text:
          * NOTE: Assumes the checkable element exists
          *
          * ```js
@@ -6366,7 +6410,7 @@ declare namespace CodeceptJS {
          */
         _locateCheckable(): Promise<any>;
         /**
-         * Find a clickable element by providing human readable text:
+         * Find a clickable element by providing human-readable text:
          *
          * ```js
          * this.helpers['Puppeteer']._locateClickable('Next page').then // ...
@@ -6374,7 +6418,7 @@ declare namespace CodeceptJS {
          */
         _locateClickable(): Promise<any>;
         /**
-         * Find field elements by providing human readable text:
+         * Find field elements by providing human-readable text:
          *
          * ```js
          * this.helpers['Puppeteer']._locateFields('Your email').then // ...
@@ -6551,7 +6595,7 @@ declare namespace CodeceptJS {
          * Sets a directory to where save files. Allows to test file downloads.
          * Should be used with [FileSystem helper](https://codecept.io/helpers/FileSystem) to check that file were downloaded correctly.
          *
-         * By default files are saved to `output/downloads`.
+         * By default, files are saved to `output/downloads`.
          * This directory is cleaned on every `handleDownloads` call, to ensure no old files are kept.
          *
          * ```js
@@ -6678,6 +6722,8 @@ declare namespace CodeceptJS {
          */
         pressKeyUp(key: string): Promise<any>;
         /**
+         * _Note:_ Shortcuts like `'Meta'` + `'A'` do not work on macOS ([GoogleChrome/puppeteer#1313](https://github.com/GoogleChrome/puppeteer/issues/1313)).
+         *
          * Presses a key in the browser (on a focused element).
          *
          * _Hint:_ For populating text field or textarea, it is recommended to use [`fillField`](#fillfield).
@@ -6829,6 +6875,8 @@ declare namespace CodeceptJS {
          */
         dontSeeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): Promise<any>;
         /**
+         * > ⚠ There is an [issue with file upload in Puppeteer 2.1.0 & 2.1.1](https://github.com/puppeteer/puppeteer/issues/5420), downgrade to 2.0.0 if you face it.
+         *
          * Attaches a file to element located by label, name, CSS or XPath
          * Path to file is relative current codecept directory (where codecept.conf.ts or codecept.conf.js is located).
          * File will be uploaded to remote system (if tests are running remotely).
@@ -7078,6 +7126,8 @@ declare namespace CodeceptJS {
          */
         clearCookie(cookie?: string): Promise<any>;
         /**
+         * If a function returns a Promise, tt will wait for its resolution.
+         *
          * Executes sync script on a page.
          * Pass arguments to function as additional parameters.
          * Will return execution result to a test.
@@ -7103,12 +7153,10 @@ declare namespace CodeceptJS {
          * @param fn - function to be executed in browser context.
          * @param args - to be passed to function.
          * @returns script return value
-         *
-         *
-         * If a function returns a Promise It will wait for it resolution.
          */
         executeScript(fn: string | ((...params: any[]) => any), ...args: any[]): Promise<any>;
         /**
+         * Asynchronous scripts can also be executed with `executeScript` if a function returns a Promise.
          * Executes async script on page.
          * Provided function should execute a passed callback (as first argument) to signal it is finished.
          *
@@ -7132,9 +7180,6 @@ declare namespace CodeceptJS {
          * @param fn - function to be executed in browser context.
          * @param args - to be passed to function.
          * @returns script return value
-         *
-         *
-         * Asynchronous scripts can also be executed with `executeScript` if a function returns a Promise.
          */
         executeAsyncScript(fn: string | ((...params: any[]) => any), ...args: any[]): Promise<any>;
         /**
@@ -7419,6 +7464,16 @@ declare namespace CodeceptJS {
          * @param [sec = 1] - (optional, `1` by default) time in seconds to wait
          */
         waitToHide(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<any>;
+        /**
+         * Waits for number of tabs.
+         *
+         * ```js
+         * I.waitForNumberOfTabs(2);
+         * ```
+         * @param expectedTabs - expecting the number of tabs.
+         * @param sec - number of secs to wait.
+         */
+        waitForNumberOfTabs(expectedTabs: number, sec: number): Promise<any>;
         /**
          * Waiting for the part of the URL to match the expected. Useful for SPA to understand that page was changed.
          *
@@ -7503,9 +7558,9 @@ declare namespace CodeceptJS {
          */
         waitForFunction(fn: string | ((...params: any[]) => any), argsOrSec?: any[] | number, sec?: number): Promise<any>;
         /**
-         * Waits for navigation to finish. By default takes configured `waitForNavigation` option.
+         * Waits for navigation to finish. By default, takes configured `waitForNavigation` option.
          *
-         * See [Pupeteer's reference](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pagewaitfornavigationoptions)
+         * See [Puppeteer's reference](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pagewaitfornavigationoptions)
          */
         waitForNavigation(opts: any): Promise<any>;
         /**
@@ -8632,6 +8687,13 @@ declare namespace CodeceptJS {
      *
      * WebDriver requires Selenium Server and ChromeDriver/GeckoDriver to be installed. Those tools can be easily installed via NPM. Please check [Testing with WebDriver](https://codecept.io/webdriver/#testing-with-webdriver) for more details.
      *
+     * With the release of WebdriverIO version v8.14.0, and onwards, all driver management hassles are now a thing of the past 🙌. Read more [here](https://webdriver.io/blog/2023/07/31/driver-management/).
+     * One of the significant advantages of this update is that you can now get rid of any driver services you previously had to manage, such as
+     * `wdio-chromedriver-service`, `wdio-geckodriver-service`, `wdio-edgedriver-service`, `wdio-safaridriver-service`, and even `@wdio/selenium-standalone-service`.
+     *
+     * For those who require custom driver options, fear not; WebDriver Helper allows you to pass in driver options through custom WebDriver configuration.
+     * If you have a custom grid, use a cloud service, or prefer to run your own driver, there's no need to worry since WebDriver Helper will only start a driver when there are no other connection information settings like hostname or port specified.
+     *
      * <!-- configuration -->
      *
      * Example:
@@ -8653,6 +8715,28 @@ declare namespace CodeceptJS {
      * }
      * ```
      *
+     * Testing Chrome locally is now more convenient than ever. You can define a browser channel, and WebDriver Helper will take care of downloading the specified browser version for you.
+     * For example:
+     *
+     * ```js
+     * {
+     *    helpers: {
+     *      WebDriver : {
+     *        smartWait: 5000,
+     *        browser: "chrome",
+     *        browserVersion: '116.0.5793.0', // or 'stable', 'beta', 'dev' or 'canary'
+     *        restart: false,
+     *        windowSize: "maximize",
+     *        timeouts: {
+     *          "script": 60000,
+     *          "page load": 10000
+     *        }
+     *      }
+     *    }
+     * }
+     * ```
+     *
+     *
      * Example with basic authentication
      * ```js
      * {
@@ -8693,6 +8777,25 @@ declare namespace CodeceptJS {
      * }
      * ```
      *
+     * ### Running with devtools protocol
+     *
+     * ```js
+     * {
+     *    helpers: {
+     *      WebDriver : {
+     *        url: "http://localhost",
+     *        browser: "chrome",
+     *        devtoolsProtocol: true,
+     *        desiredCapabilities: {
+     *          chromeOptions: {
+     *            args: [ "--headless", "--disable-gpu", "--no-sandbox" ]
+     *          }
+     *        }
+     *      }
+     *    }
+     * }
+     * ```
+     *
      * ### Internet Explorer
      *
      * Additional configuration params can be used from [IE options](https://seleniumhq.github.io/selenium/docs/api/rb/Selenium/WebDriver/IE/Options.html)
@@ -9218,6 +9321,8 @@ declare namespace CodeceptJS {
          */
         selectOption(select: LocatorOrString, option: string | any[]): Promise<any>;
         /**
+         * Appium: not tested
+         *
          * Attaches a file to element located by label, name, CSS or XPath
          * Path to file is relative current codecept directory (where codecept.conf.ts or codecept.conf.js is located).
          * File will be uploaded to remote system (if tests are running remotely).
@@ -9231,6 +9336,7 @@ declare namespace CodeceptJS {
          */
         attachFile(locator: CodeceptJS.LocatorOrString, pathToFile: string): Promise<any>;
         /**
+         * Appium: not tested
          * Selects a checkbox or radio button.
          * Element is located by label or name or CSS or XPath.
          *
@@ -9246,6 +9352,7 @@ declare namespace CodeceptJS {
          */
         checkOption(field: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<any>;
         /**
+         * Appium: not tested
          * Unselects a checkbox or radio button.
          * Element is located by label or name or CSS or XPath.
          *
@@ -9478,6 +9585,7 @@ declare namespace CodeceptJS {
          */
         dontSeeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): Promise<any>;
         /**
+         * Appium: not tested
          * Verifies that the specified checkbox is checked.
          *
          * ```js
@@ -9489,6 +9597,7 @@ declare namespace CodeceptJS {
          */
         seeCheckboxIsChecked(field: CodeceptJS.LocatorOrString): Promise<any>;
         /**
+         * Appium: not tested
          * Verifies that the specified checkbox is not checked.
          *
          * ```js
@@ -9679,6 +9788,8 @@ declare namespace CodeceptJS {
          */
         dontSeeCurrentUrlEquals(url: string): Promise<any>;
         /**
+         * Wraps [execute](http://webdriver.io/api/protocol/execute.html) command.
+         *
          * Executes sync script on a page.
          * Pass arguments to function as additional parameters.
          * Will return execution result to a test.
@@ -9704,10 +9815,6 @@ declare namespace CodeceptJS {
          * @param fn - function to be executed in browser context.
          * @param args - to be passed to function.
          * @returns script return value
-         *
-         *
-         *
-         * Wraps [execute](http://webdriver.io/api/protocol/execute.html) command.
          */
         executeScript(fn: string | ((...params: any[]) => any), ...args: any[]): Promise<any>;
         /**
@@ -9745,9 +9852,9 @@ declare namespace CodeceptJS {
          * I.scrollIntoView('#submit', { behavior: "smooth", block: "center", inline: "center" });
          * ```
          * @param locator - located by CSS|XPath|strict locator.
-         * @param scrollIntoViewOptions - see https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView.
+         * @param scrollIntoViewOptions - either alignToTop=true|false or scrollIntoViewOptions. See https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView.
          */
-        scrollIntoView(locator: LocatorOrString, scrollIntoViewOptions: ScrollIntoViewOptions): Promise<any>;
+        scrollIntoView(locator: LocatorOrString, scrollIntoViewOptions: ScrollIntoViewOptions | boolean): Promise<any>;
         /**
          * Scrolls to element matched by locator.
          * Extra shift can be set with offsetX and offsetY options.
@@ -9799,6 +9906,7 @@ declare namespace CodeceptJS {
          */
         saveScreenshot(fileName: string, fullPage?: boolean): Promise<any>;
         /**
+         * Uses Selenium's JSON [cookie format](https://code.google.com/p/selenium/wiki/JsonWireProtocol#Cookie_JSON_Object).
          * Sets cookie(s).
          *
          * Can be a single cookie object or an array of cookies:
@@ -9863,7 +9971,7 @@ declare namespace CodeceptJS {
          */
         acceptPopup(): Promise<any>;
         /**
-         * Dismisses the active JavaScript popup, as created by window.alert|window.confirm|window.prompt.
+         * Dismisses the active JavaScript popup, as created by `window.alert|window.confirm|window.prompt`.
          */
         cancelPopup(): Promise<any>;
         /**
@@ -9906,6 +10014,8 @@ declare namespace CodeceptJS {
          */
         pressKeyUp(key: string): Promise<any>;
         /**
+         * _Note:_ In case a text field or textarea is focused be aware that some browsers do not respect active modifier when combining modifier keys with other keys.
+         *
          * Presses a key in the browser (on a focused element).
          *
          * _Hint:_ For populating text field or textarea, it is recommended to use [`fillField`](#fillfield).
@@ -9989,6 +10099,8 @@ declare namespace CodeceptJS {
          */
         type(key: string | string[], delay?: number): Promise<any>;
         /**
+         * Appium: not tested in web, in apps doesn't work
+         *
          * Resize the current window to provided width and height.
          * First parameter can be set to `maximize`.
          * @param width - width in pixels or `maximize`.
@@ -10029,6 +10141,7 @@ declare namespace CodeceptJS {
          */
         blur(locator: CodeceptJS.LocatorOrString, options?: any): Promise<any>;
         /**
+         * Appium: not tested
          * Drag an item to a destination element.
          *
          * ```js
@@ -10250,6 +10363,16 @@ declare namespace CodeceptJS {
          * @param [sec = null] - (optional, `1` by default) time in seconds to wait
          */
         waitForFunction(fn: string | ((...params: any[]) => any), argsOrSec?: any[] | number, sec?: number): Promise<any>;
+        /**
+         * Waits for number of tabs.
+         *
+         * ```js
+         * I.waitForNumberOfTabs(2);
+         * ```
+         * @param expectedTabs - expecting the number of tabs.
+         * @param sec - number of secs to wait.
+         */
+        waitForNumberOfTabs(expectedTabs: number, sec: number): Promise<any>;
         /**
          * Switches frame or in case of null locator reverts to parent.
          *
@@ -10343,6 +10466,9 @@ declare namespace CodeceptJS {
          */
         grabPageScrollPosition(): Promise<PageScrollPosition>;
         /**
+         * This method is **deprecated**.
+         *
+         *
          * Set the current geo location
          *
          *
@@ -10352,10 +10478,12 @@ declare namespace CodeceptJS {
          * ```
          * @param latitude - to set.
          * @param longitude - to set
-         * @param [altitude = null] - (optional, null by default) to set
+         * @param [altitude] - (optional, null by default) to set
          */
         setGeoLocation(latitude: number, longitude: number, altitude?: number): Promise<any>;
         /**
+         * This method is **deprecated**.
+         *
          * Return the current geo location
          * Resumes test execution, so **should be used inside async function with `await`** operator.
          *