codeceptjs 3.5.9 → 3.5.11

package/typings/promiseBasedTypes.d.ts

@@ -458,7 +458,7 @@ declare namespace CodeceptJS {
          * Switch to the specified context.
          * @param context - the context to switch to
          */
-        _switchToContext(context: any): Promise<any>;
+        switchToContext(context: any): Promise<any>;
         /**
          * Switches to web context.
          * If no context is provided switches to the first detected web context
@@ -749,7 +749,7 @@ declare namespace CodeceptJS {
          * ```js
          * I.closeApp();
          * ```
-         * @returns Appium: support only iOS
+         * @returns Appium: support both Android and iOS
          */
         closeApp(): Promise<void>;
         /**
@@ -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.
@@ -2761,6 +2755,21 @@ declare namespace CodeceptJS {
      * * `trace`: enables trace recording for failed tests; trace are saved into `output/trace` folder
      * * `keepTraceForPassedTests`: - save trace for passed tests
      *
+     * #### HAR Recording Customization
+     *
+     * A HAR file is an HTTP Archive file that contains a record of all the network requests that are made when a page is loaded.
+     * It contains information about the request and response headers, cookies, content, timings, and more. You can use HAR files to mock network requests in your tests.
+     * HAR will be saved to `output/har`. More info could be found here https://playwright.dev/docs/api/class-browser#browser-new-context-option-record-har.
+     *
+     * ```
+     * ...
+     * recordHar: {
+     *     mode: 'minimal', // possible values: 'minimal'|'full'.
+     *     content: 'embed' // possible values:  "omit"|"embed"|"attach".
+     * }
+     * ...
+     * ```
+     *
      * #### Example #1: Wait for 0 network connections.
      *
      * ```js
@@ -2935,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>;
         /**
@@ -3020,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`.
@@ -3096,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
@@ -3104,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>;
         /**
@@ -3135,6 +3156,21 @@ declare namespace CodeceptJS {
          * ```
          */
         refreshPage(): Promise<any>;
+        /**
+         * Replaying from HAR
+         *
+         * ```js
+         *  // Replay API requests from HAR.
+         *  // Either use a matching response from the HAR,
+         *  // or abort the request if nothing matches.
+         *    I.replayFromHar('./output/har/something.har', { url: "*\/**\/api/v1/fruits" });
+         *    I.amOnPage('https://demo.playwright.dev/api-mocking');
+         *    I.see('CodeceptJS');
+         * ```
+         * @param harFilePath - Path to recorded HAR file
+         * @param [opts] - [Options for replaying from HAR](https://playwright.dev/docs/api/class-page#page-route-from-har)
+         */
+        replayFromHar(harFilePath: string, opts?: any): Promise<any>;
         /**
          * Scroll page to the top.
          *
@@ -3254,6 +3290,28 @@ declare namespace CodeceptJS {
          * ```
          */
         _locateFields(): Promise<any>;
+        /**
+         * Grab WebElements for given locator
+         * Resumes test execution, so **should be used inside an async function with `await`** operator.
+         *
+         * ```js
+         * const webElements = await I.grabWebElements('#button');
+         * ```
+         * @param locator - element located by CSS|XPath|strict locator.
+         * @returns WebElement of being used Web helper
+         */
+        grabWebElements(locator: CodeceptJS.LocatorOrString): Promise<any>;
+        /**
+         * Grab WebElement for given locator
+         * Resumes test execution, so **should be used inside an async function with `await`** operator.
+         *
+         * ```js
+         * const webElement = await I.grabWebElement('#button');
+         * ```
+         * @param locator - element located by CSS|XPath|strict locator.
+         * @returns WebElement of being used Web helper
+         */
+        grabWebElement(locator: CodeceptJS.LocatorOrString): Promise<any>;
         /**
          * Switch focus to a particular tab by its number. It waits tabs loading and then switch tab
          *
@@ -3389,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 } })
@@ -3402,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>;
         /**
@@ -3467,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.
          *
@@ -3482,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.
          *
@@ -3545,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).
@@ -3929,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.
@@ -3963,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]);
@@ -4233,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.
          *
@@ -6136,6 +6218,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`.
@@ -6305,7 +6391,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
@@ -6314,7 +6400,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 // ...
@@ -6322,13 +6408,24 @@ 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 // ...
          * ```
          */
         _locateFields(): Promise<any>;
+        /**
+         * Grab WebElements for given locator
+         * Resumes test execution, so **should be used inside an async function with `await`** operator.
+         *
+         * ```js
+         * const webElements = await I.grabWebElements('#button');
+         * ```
+         * @param locator - element located by CSS|XPath|strict locator.
+         * @returns WebElement of being used Web helper
+         */
+        grabWebElements(locator: CodeceptJS.LocatorOrString): Promise<any>;
         /**
          * Switch focus to a particular tab by its number. It waits tabs loading and then switch tab
          *
@@ -6488,7 +6585,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
@@ -6615,6 +6712,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).
@@ -6766,6 +6865,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).
@@ -7015,6 +7116,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.
@@ -7040,12 +7143,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.
          *
@@ -7069,9 +7170,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>;
         /**
@@ -7440,9 +7538,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>;
         /**
@@ -8951,6 +9049,17 @@ declare namespace CodeceptJS {
          * @param locator - element located by CSS|XPath|strict locator.
          */
         _locateFields(locator: CodeceptJS.LocatorOrString): Promise<any>;
+        /**
+         * Grab WebElements for given locator
+         * Resumes test execution, so **should be used inside an async function with `await`** operator.
+         *
+         * ```js
+         * const webElements = await I.grabWebElements('#button');
+         * ```
+         * @param locator - element located by CSS|XPath|strict locator.
+         * @returns WebElement of being used Web helper
+         */
+        grabWebElements(locator: CodeceptJS.LocatorOrString): Promise<any>;
         /**
          * Set [WebDriver timeouts](https://webdriver.io/docs/timeouts.html) in realtime.
          *
@@ -9144,6 +9253,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).
@@ -9157,6 +9268,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.
          *
@@ -9172,6 +9284,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.
          *
@@ -9404,6 +9517,7 @@ declare namespace CodeceptJS {
          */
         dontSeeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): Promise<any>;
         /**
+         * Appium: not tested
          * Verifies that the specified checkbox is checked.
          *
          * ```js
@@ -9415,6 +9529,7 @@ declare namespace CodeceptJS {
          */
         seeCheckboxIsChecked(field: CodeceptJS.LocatorOrString): Promise<any>;
         /**
+         * Appium: not tested
          * Verifies that the specified checkbox is not checked.
          *
          * ```js
@@ -9605,6 +9720,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.
@@ -9630,10 +9747,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>;
         /**
@@ -9671,9 +9784,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.
@@ -9725,6 +9838,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:
@@ -9789,7 +9903,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>;
         /**
@@ -9832,6 +9946,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).
@@ -9915,6 +10031,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`.
@@ -9955,6 +10073,7 @@ declare namespace CodeceptJS {
          */
         blur(locator: CodeceptJS.LocatorOrString, options?: any): Promise<any>;
         /**
+         * Appium: not tested
          * Drag an item to a destination element.
          *
          * ```js