codeceptjs 3.5.10 → 3.5.12-beta.1

package/typings/types.d.ts

@@ -980,13 +980,13 @@ 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.
          * @returns automatically synchronized promise through #recorder
          *
          *
          * Supported only for web testing
          */
-        scrollIntoView(locator: LocatorOrString, scrollIntoViewOptions: ScrollIntoViewOptions): void;
+        scrollIntoView(locator: LocatorOrString, scrollIntoViewOptions: ScrollIntoViewOptions | boolean): void;
         /**
          * Verifies that the specified checkbox is checked.
          *
@@ -1131,7 +1131,7 @@ declare namespace CodeceptJS {
      * {
      *   helpers: {
      *     Playwright: {...},
-     *     ExpectHelper: {},
+     *     Expect: {},
      *   }
      * }
      * ```
@@ -1139,57 +1139,51 @@ declare namespace CodeceptJS {
      * ## Methods
      */
     class ExpectHelper {
-        expectEqual(actualValue: any, expectedValue: any, customErrorMsg: any): void;
-        expectNotEqual(actualValue: any, expectedValue: any, customErrorMsg: any): void;
-        expectDeepEqual(actualValue: any, expectedValue: any, customErrorMsg: any): void;
-        expectNotDeepEqual(actualValue: any, expectedValue: any, customErrorMsg: any): void;
-        expectContain(actualValue: any, expectedValueToContain: any, customErrorMsg: any): void;
-        expectNotContain(actualValue: any, expectedValueToNotContain: any, customErrorMsg: any): void;
-        expectStartsWith(actualValue: any, expectedValueToStartWith: any, customErrorMsg: any): void;
-        expectNotStartsWith(actualValue: any, expectedValueToNotStartWith: any, customErrorMsg: any): void;
-        expectEndsWith(actualValue: any, expectedValueToEndWith: any, customErrorMsg: any): void;
-        expectNotEndsWith(actualValue: any, expectedValueToNotEndWith: any, customErrorMsg: any): void;
-        expectJsonSchema(targetData: any, jsonSchema: any, customErrorMsg: any): void;
+        expectEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
+        expectNotEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
+        expectDeepEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
+        expectNotDeepEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
+        expectContain(actualValue: any, expectedValueToContain: any, customErrorMsg?: any): void;
+        expectNotContain(actualValue: any, expectedValueToNotContain: any, customErrorMsg?: any): void;
+        expectStartsWith(actualValue: any, expectedValueToStartWith: any, customErrorMsg?: any): void;
+        expectNotStartsWith(actualValue: any, expectedValueToNotStartWith: any, customErrorMsg?: any): void;
+        expectEndsWith(actualValue: any, expectedValueToEndWith: any, customErrorMsg?: any): void;
+        expectNotEndsWith(actualValue: any, expectedValueToNotEndWith: any, customErrorMsg?: any): void;
+        expectJsonSchema(targetData: any, jsonSchema: any, customErrorMsg?: any): void;
         /**
          * @param ajvOptions - Pass AJV options
          */
-        expectJsonSchemaUsingAJV(targetData: any, jsonSchema: any, customErrorMsg: any, ajvOptions: any): void;
-        expectHasProperty(targetData: any, propertyName: any, customErrorMsg: any): void;
-        expectHasAProperty(targetData: any, propertyName: any, customErrorMsg: any): void;
-        expectToBeA(targetData: any, type: any, customErrorMsg: any): void;
-        expectToBeAn(targetData: any, type: any, customErrorMsg: any): void;
-        expectMatchRegex(targetData: any, regex: any, customErrorMsg: any): void;
-        expectLengthOf(targetData: any, length: any, customErrorMsg: any): void;
-        expectEmpty(targetData: any, customErrorMsg: any): void;
-        expectTrue(targetData: any, customErrorMsg: any): void;
-        expectFalse(targetData: any, customErrorMsg: any): void;
-        /**
-         * @param aboveThan - number | Date
-         */
-        expectAbove(targetData: any, aboveThan: any, customErrorMsg: any): void;
-        /**
-         * @param belowThan - number | Date
-         */
-        expectBelow(targetData: any, belowThan: any, customErrorMsg: any): void;
-        expectLengthAboveThan(targetData: any, lengthAboveThan: any, customErrorMsg: any): void;
-        expectLengthBelowThan(targetData: any, lengthBelowThan: any, customErrorMsg: any): void;
-        expectEqualIgnoreCase(actualValue: any, expectedValue: any, customErrorMsg: any): void;
+        expectJsonSchemaUsingAJV(targetData: any, jsonSchema: any, customErrorMsg?: any, ajvOptions: any): void;
+        expectHasProperty(targetData: any, propertyName: any, customErrorMsg?: any): void;
+        expectHasAProperty(targetData: any, propertyName: any, customErrorMsg?: any): void;
+        expectToBeA(targetData: any, type: any, customErrorMsg?: any): void;
+        expectToBeAn(targetData: any, type: any, customErrorMsg?: any): void;
+        expectMatchRegex(targetData: any, regex: any, customErrorMsg?: any): void;
+        expectLengthOf(targetData: any, length: any, customErrorMsg?: any): void;
+        expectEmpty(targetData: any, customErrorMsg?: any): void;
+        expectTrue(targetData: any, customErrorMsg?: any): void;
+        expectFalse(targetData: any, customErrorMsg?: any): void;
+        expectAbove(targetData: any, aboveThan: any, customErrorMsg?: any): void;
+        expectBelow(targetData: any, belowThan: any, customErrorMsg?: any): void;
+        expectLengthAboveThan(targetData: any, lengthAboveThan: any, customErrorMsg?: any): void;
+        expectLengthBelowThan(targetData: any, lengthBelowThan: any, customErrorMsg?: any): void;
+        expectEqualIgnoreCase(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
         /**
          * expects members of two arrays are deeply equal
          */
-        expectDeepMembers(actualValue: any, expectedValue: any, customErrorMsg: any): void;
+        expectDeepMembers(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
         /**
          * expects an array to be a superset of another array
          */
-        expectDeepIncludeMembers(superset: any, set: any, customErrorMsg: any): void;
+        expectDeepIncludeMembers(superset: any, set: any, customErrorMsg?: any): void;
         /**
          * expects members of two JSON objects are deeply equal excluding some properties
          */
-        expectDeepEqualExcluding(actualValue: any, expectedValue: any, fieldsToExclude: any, customErrorMsg: any): void;
+        expectDeepEqualExcluding(actualValue: any, expectedValue: any, fieldsToExclude: any, customErrorMsg?: any): void;
         /**
          * expects a JSON object matches a provided pattern
          */
-        expectMatchesPattern(actualValue: any, expectedPattern: any, customErrorMsg: any): void;
+        expectMatchesPattern(actualValue: any, expectedPattern: any, customErrorMsg?: any): void;
     }
     /**
      * Helper for testing filesystem.
@@ -3120,7 +3114,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): void;
         /**
@@ -3207,15 +3201,8 @@ declare namespace CodeceptJS {
          */
         amOnPage(url: string): void;
         /**
-         * Resize the current window to provided width and height.
-         * First parameter can be set to `maximize`.
-         * @param width - width in pixels or `maximize`.
-         * @param height - height in pixels.
-         * @returns automatically synchronized promise through #recorder
-         *
-         *
          * 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.
+         * 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:
@@ -3225,6 +3212,12 @@ declare namespace CodeceptJS {
          * // @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`.
+         * @param height - height in pixels.
+         * @returns automatically synchronized promise through #recorder
          */
         resizeWindow(width: number, height: number): void;
         /**
@@ -3300,6 +3293,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
@@ -3308,13 +3308,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`
          * @returns automatically synchronized promise through #recorder
          */
         dragAndDrop(srcElement: LocatorOrString, destElement: LocatorOrString, options?: any): void;
@@ -3643,12 +3636,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 } })
@@ -3656,6 +3644,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.
          * @returns automatically synchronized promise through #recorder
          */
         click(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString | null, options?: any): void;
@@ -3725,6 +3716,16 @@ declare namespace CodeceptJS {
          */
         rightClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): void;
         /**
+         * [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.
          *
@@ -3738,20 +3739,19 @@ declare namespace CodeceptJS {
          * @param field - checkbox located by label | name | CSS | XPath | strict locator.
          * @param [context = null] - (optional, `null` by default) element located by CSS | XPath | strict locator.
          * @returns automatically synchronized promise through #recorder
-         *
-         *
-         * [Additional options](https://playwright.dev/docs/api/class-elementhandle#element-handle-check) for check available as 3rd argument.
+         */
+        checkOption(field: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): void;
+        /**
+         * [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.checkOption('Agree', '.signup', { position: { x: 5, y: 5 } })
+         * I.uncheckOption('Agree', '.signup', { position: { x: 5, y: 5 } })
          * ```
          * > ⚠️ To avoid flakiness, option `force: true` is set by default
-         */
-        checkOption(field: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): void;
-        /**
+         *
          * Unselects a checkbox or radio button.
          * Element is located by label or name or CSS or XPath.
          *
@@ -3765,17 +3765,6 @@ declare namespace CodeceptJS {
          * @param field - checkbox located by label | name | CSS | XPath | strict locator.
          * @param [context = null] - (optional, `null` by default) element located by CSS | XPath | strict locator.
          * @returns automatically synchronized promise through #recorder
-         *
-         *
-         * [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
          */
         uncheckOption(field: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): void;
         /**
@@ -3831,6 +3820,8 @@ declare namespace CodeceptJS {
          */
         pressKeyUp(key: string): void;
         /**
+         * _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).
@@ -3890,9 +3881,6 @@ declare namespace CodeceptJS {
          * - `'Tab'`
          * @param key - key or array of keys to press.
          * @returns automatically synchronized promise through #recorder
-         *
-         *
-         * _Note:_ Shortcuts like `'Meta'` + `'A'` do not work on macOS ([GoogleChrome/Puppeteer#1313](https://github.com/GoogleChrome/puppeteer/issues/1313)).
          */
         pressKey(key: string | string[]): void;
         /**
@@ -4240,6 +4228,8 @@ declare namespace CodeceptJS {
          */
         dontSeeCookie(name: string): void;
         /**
+         * 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.
@@ -4250,9 +4240,6 @@ declare namespace CodeceptJS {
          * ```
          * @param [name = null] - cookie name.
          * @returns attribute value
-         *
-         *
-         * Returns cookie in JSON format. If name not passed returns all cookies for this domain.
          */
         grabCookie(name?: string): any;
         /**
@@ -4278,8 +4265,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]);
@@ -4559,6 +4546,8 @@ declare namespace CodeceptJS {
          */
         waitForElement(locator: CodeceptJS.LocatorOrString, sec?: number): void;
         /**
+         * 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.
          *
@@ -4568,9 +4557,6 @@ declare namespace CodeceptJS {
          * @param locator - element located by CSS|XPath|strict locator.
          * @param [sec = 1] - (optional, `1` by default) time in seconds to wait
          * @returns automatically synchronized promise through #recorder
-         *
-         *
-         * This method accepts [React selectors](https://codecept.io/react).
          */
         waitForVisible(locator: CodeceptJS.LocatorOrString, sec?: number): void;
         /**
@@ -4597,6 +4583,17 @@ declare namespace CodeceptJS {
          * @returns automatically synchronized promise through #recorder
          */
         waitToHide(locator: CodeceptJS.LocatorOrString, sec?: number): void;
+        /**
+         * Waits for number of tabs.
+         *
+         * ```js
+         * I.waitForNumberOfTabs(2);
+         * ```
+         * @param expectedTabs - expecting the number of tabs.
+         * @param sec - number of secs to wait.
+         * @returns automatically synchronized promise through #recorder
+         */
+        waitForNumberOfTabs(expectedTabs: number, sec: number): void;
         /**
          * Waiting for the part of the URL to match the expected. Useful for SPA to understand that page was changed.
          *
@@ -6597,16 +6594,15 @@ declare namespace CodeceptJS {
          */
         amOnPage(url: string): void;
         /**
+         * 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`.
          * @param height - height in pixels.
          * @returns automatically synchronized promise through #recorder
-         *
-         *
-         * 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.
          */
         resizeWindow(width: number, height: number): void;
         /**
@@ -6785,7 +6781,7 @@ declare namespace CodeceptJS {
          */
         _locate(): void;
         /**
-         * Find a checkbox by providing human readable text:
+         * Find a checkbox by providing human-readable text:
          * NOTE: Assumes the checkable element exists
          *
          * ```js
@@ -6794,7 +6790,7 @@ declare namespace CodeceptJS {
          */
         _locateCheckable(): void;
         /**
-         * 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 // ...
@@ -6802,7 +6798,7 @@ declare namespace CodeceptJS {
          */
         _locateClickable(): void;
         /**
-         * Find field elements by providing human readable text:
+         * Find field elements by providing human-readable text:
          *
          * ```js
          * this.helpers['Puppeteer']._locateFields('Your email').then // ...
@@ -6999,7 +6995,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
@@ -7140,6 +7136,8 @@ declare namespace CodeceptJS {
          */
         pressKeyUp(key: string): void;
         /**
+         * _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).
@@ -7199,9 +7197,6 @@ declare namespace CodeceptJS {
          * - `'Tab'`
          * @param key - key or array of keys to press.
          * @returns automatically synchronized promise through #recorder
-         *
-         *
-         * _Note:_ Shortcuts like `'Meta'` + `'A'` do not work on macOS ([GoogleChrome/puppeteer#1313](https://github.com/GoogleChrome/puppeteer/issues/1313)).
          */
         pressKey(key: string | string[]): void;
         /**
@@ -7306,6 +7301,8 @@ declare namespace CodeceptJS {
          */
         dontSeeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): void;
         /**
+         * > ⚠ 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).
@@ -7317,9 +7314,6 @@ declare namespace CodeceptJS {
          * @param locator - field located by label|name|CSS|XPath|strict locator.
          * @param pathToFile - local file path relative to codecept.conf.ts or codecept.conf.js config file.
          * @returns automatically synchronized promise through #recorder
-         *
-         *
-         * > ⚠ 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.
          */
         attachFile(locator: CodeceptJS.LocatorOrString, pathToFile: string): void;
         /**
@@ -7590,6 +7584,8 @@ declare namespace CodeceptJS {
          */
         clearCookie(cookie?: string): void;
         /**
+         * 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.
@@ -7615,12 +7611,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.
          *
@@ -7644,9 +7638,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>;
         /**
@@ -7931,7 +7922,7 @@ declare namespace CodeceptJS {
          * @returns automatically synchronized promise through #recorder
          *
          *
-         * This method accepts [React selectors](https://codecept.io/react).
+         * {{ react }}
          */
         waitForVisible(locator: CodeceptJS.LocatorOrString, sec?: number): void;
         /**
@@ -7958,6 +7949,17 @@ declare namespace CodeceptJS {
          * @returns automatically synchronized promise through #recorder
          */
         waitToHide(locator: CodeceptJS.LocatorOrString, sec?: number): void;
+        /**
+         * Waits for number of tabs.
+         *
+         * ```js
+         * I.waitForNumberOfTabs(2);
+         * ```
+         * @param expectedTabs - expecting the number of tabs.
+         * @param sec - number of secs to wait.
+         * @returns automatically synchronized promise through #recorder
+         */
+        waitForNumberOfTabs(expectedTabs: number, sec: number): void;
         /**
          * Waiting for the part of the URL to match the expected. Useful for SPA to understand that page was changed.
          *
@@ -8047,9 +8049,9 @@ declare namespace CodeceptJS {
          */
         waitForFunction(fn: string | ((...params: any[]) => any), argsOrSec?: any[] | number, sec?: number): void;
         /**
-         * 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): void;
         /**
@@ -9275,6 +9277,8 @@ declare namespace CodeceptJS {
      * @property [manualStart = false] - do not start browser before a test, start it manually inside a helper with `this.helpers["WebDriver"]._startBrowser()`.
      * @property [timeouts] - [WebDriver timeouts](http://webdriver.io/docs/timeouts.html) defined as hash.
      * @property [highlightElement] - highlight the interacting elements. Default: false. Note: only activate under verbose mode (--verbose).
+     * @property [logLevel = silent] - level of logging verbosity. Default: silent. Options: trace | debug | info | warn | error | silent. More info: https://webdriver.io/docs/configuration/#loglevel
+     * @property [devtoolsProtocol = false] - enable devtools protocol. Default: false. More info: https://webdriver.io/docs/automationProtocols/#devtools-protocol.
      */
     type WebDriverConfig = {
         url: string;
@@ -9297,6 +9301,8 @@ declare namespace CodeceptJS {
         manualStart?: boolean;
         timeouts?: any;
         highlightElement?: boolean;
+        logLevel?: string;
+        devtoolsProtocol?: boolean;
     };
     /**
      * WebDriver helper which wraps [webdriverio](http://webdriver.io/) library to
@@ -9304,6 +9310,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:
@@ -9325,6 +9338,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
      * {
@@ -9365,6 +9400,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)
@@ -9920,6 +9974,8 @@ declare namespace CodeceptJS {
          */
         selectOption(select: LocatorOrString, option: string | any[]): void;
         /**
+         * 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).
@@ -9931,11 +9987,10 @@ declare namespace CodeceptJS {
          * @param locator - field located by label|name|CSS|XPath|strict locator.
          * @param pathToFile - local file path relative to codecept.conf.ts or codecept.conf.js config file.
          * @returns automatically synchronized promise through #recorder
-         *
-         * Appium: not tested
          */
         attachFile(locator: CodeceptJS.LocatorOrString, pathToFile: string): void;
         /**
+         * Appium: not tested
          * Selects a checkbox or radio button.
          * Element is located by label or name or CSS or XPath.
          *
@@ -9949,11 +10004,10 @@ declare namespace CodeceptJS {
          * @param field - checkbox located by label | name | CSS | XPath | strict locator.
          * @param [context = null] - (optional, `null` by default) element located by CSS | XPath | strict locator.
          * @returns automatically synchronized promise through #recorder
-         *
-         * Appium: not tested
          */
         checkOption(field: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): void;
         /**
+         * Appium: not tested
          * Unselects a checkbox or radio button.
          * Element is located by label or name or CSS or XPath.
          *
@@ -9967,8 +10021,6 @@ declare namespace CodeceptJS {
          * @param field - checkbox located by label | name | CSS | XPath | strict locator.
          * @param [context = null] - (optional, `null` by default) element located by CSS | XPath | strict locator.
          * @returns automatically synchronized promise through #recorder
-         *
-         * Appium: not tested
          */
         uncheckOption(field: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): void;
         /**
@@ -10203,6 +10255,7 @@ declare namespace CodeceptJS {
          */
         dontSeeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): void;
         /**
+         * Appium: not tested
          * Verifies that the specified checkbox is checked.
          *
          * ```js
@@ -10212,11 +10265,10 @@ declare namespace CodeceptJS {
          * ```
          * @param field - located by label|name|CSS|XPath|strict locator.
          * @returns automatically synchronized promise through #recorder
-         *
-         * Appium: not tested
          */
         seeCheckboxIsChecked(field: CodeceptJS.LocatorOrString): void;
         /**
+         * Appium: not tested
          * Verifies that the specified checkbox is not checked.
          *
          * ```js
@@ -10226,8 +10278,6 @@ declare namespace CodeceptJS {
          * ```
          * @param field - located by label|name|CSS|XPath|strict locator.
          * @returns automatically synchronized promise through #recorder
-         *
-         * Appium: not tested
          */
         dontSeeCheckboxIsChecked(field: CodeceptJS.LocatorOrString): void;
         /**
@@ -10432,6 +10482,8 @@ declare namespace CodeceptJS {
          */
         dontSeeCurrentUrlEquals(url: string): void;
         /**
+         * 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.
@@ -10457,10 +10509,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>;
         /**
@@ -10498,10 +10546,10 @@ 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.
          * @returns automatically synchronized promise through #recorder
          */
-        scrollIntoView(locator: LocatorOrString, scrollIntoViewOptions: ScrollIntoViewOptions): void;
+        scrollIntoView(locator: LocatorOrString, scrollIntoViewOptions: ScrollIntoViewOptions | boolean): void;
         /**
          * Scrolls to element matched by locator.
          * Extra shift can be set with offsetX and offsetY options.
@@ -10557,6 +10605,7 @@ declare namespace CodeceptJS {
          */
         saveScreenshot(fileName: string, fullPage?: boolean): void;
         /**
+         * 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:
@@ -10572,11 +10621,6 @@ declare namespace CodeceptJS {
          * ```
          * @param cookie - a cookie object or array of cookie objects.
          * @returns automatically synchronized promise through #recorder
-         *
-         *
-         *
-         * Uses Selenium's JSON [cookie
-         * format](https://code.google.com/p/selenium/wiki/JsonWireProtocol#Cookie_JSON_Object).
          */
         setCookie(cookie: Cookie | Cookie[]): void;
         /**
@@ -10630,7 +10674,7 @@ declare namespace CodeceptJS {
          */
         acceptPopup(): void;
         /**
-         * 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(): void;
         /**
@@ -10675,6 +10719,8 @@ declare namespace CodeceptJS {
          */
         pressKeyUp(key: string): void;
         /**
+         * _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).
@@ -10734,9 +10780,6 @@ declare namespace CodeceptJS {
          * - `'Tab'`
          * @param key - key or array of keys to press.
          * @returns automatically synchronized promise through #recorder
-         *
-         *
-         * _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.
          */
         pressKey(key: string | string[]): void;
         /**
@@ -10763,13 +10806,13 @@ declare namespace CodeceptJS {
          */
         type(key: string | string[], delay?: number): void;
         /**
+         * 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`.
          * @param height - height in pixels.
          * @returns automatically synchronized promise through #recorder
-         *
-         * Appium: not tested in web, in apps doesn't work
          */
         resizeWindow(width: number, height: number): void;
         /**
@@ -10808,6 +10851,7 @@ declare namespace CodeceptJS {
          */
         blur(locator: CodeceptJS.LocatorOrString, options?: any): void;
         /**
+         * Appium: not tested
          * Drag an item to a destination element.
          *
          * ```js
@@ -10816,8 +10860,6 @@ declare namespace CodeceptJS {
          * @param srcElement - located by CSS|XPath|strict locator.
          * @param destElement - located by CSS|XPath|strict locator.
          * @returns automatically synchronized promise through #recorder
-         *
-         * Appium: not tested
          */
         dragAndDrop(srcElement: LocatorOrString, destElement: LocatorOrString): void;
         /**
@@ -11048,6 +11090,17 @@ declare namespace CodeceptJS {
          * @returns automatically synchronized promise through #recorder
          */
         waitForFunction(fn: string | ((...params: any[]) => any), argsOrSec?: any[] | number, sec?: number): void;
+        /**
+         * Waits for number of tabs.
+         *
+         * ```js
+         * I.waitForNumberOfTabs(2);
+         * ```
+         * @param expectedTabs - expecting the number of tabs.
+         * @param sec - number of secs to wait.
+         * @returns automatically synchronized promise through #recorder
+         */
+        waitForNumberOfTabs(expectedTabs: number, sec: number): void;
         /**
          * Switches frame or in case of null locator reverts to parent.
          *
@@ -11149,6 +11202,9 @@ declare namespace CodeceptJS {
          */
         grabPageScrollPosition(): Promise<PageScrollPosition>;
         /**
+         * This method is **deprecated**.
+         *
+         *
          * Set the current geo location
          *
          *
@@ -11158,11 +11214,13 @@ 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
          * @returns automatically synchronized promise through #recorder
          */
         setGeoLocation(latitude: number, longitude: number, altitude?: number): void;
         /**
+         * This method is **deprecated**.
+         *
          * Return the current geo location
          * Resumes test execution, so **should be used inside async function with `await`** operator.
          *
@@ -11545,7 +11603,10 @@ declare namespace CodeceptJS {
         isStrict(): boolean;
         isAccessibilityId(): boolean;
         isBasic(): boolean;
-        toXPath(): string;
+        /**
+         * @param [pseudoSelector] - CSS to XPath extension pseudo: https://www.npmjs.com/package/csstoxpath?activeTab=explore#extension-pseudos
+         */
+        toXPath(pseudoSelector?: string): string;
         or(locator: CodeceptJS.LocatorOrString): Locator;
         find(locator: CodeceptJS.LocatorOrString): Locator;
         withChild(locator: CodeceptJS.LocatorOrString): Locator;
@@ -11553,7 +11614,14 @@ declare namespace CodeceptJS {
         at(position: number): Locator;
         first(): Locator;
         last(): Locator;
+        /**
+         * Find an element containing a text
+         */
         withText(text: string): Locator;
+        /**
+         * Find an element with exact text
+         */
+        withTextEquals(text: string): Locator;
         withAttr(attributes: {
             [key: string]: string;
         }): Locator;