codeceptjs 3.3.0 → 3.3.3

package/docs/build/WebDriver.js

@@ -896,6 +896,7 @@ class WebDriver extends Helper {
    * ```
    * 
    * @param {string} url url path or global url.
+   * @return {void} automatically synchronized promise with recorder #! 
    *
    */
   amOnPage(url) {
@@ -934,7 +935,8 @@ class WebDriver extends Helper {
    * ```
    * 
    * @param {CodeceptJS.LocatorOrString} locator clickable link or button located by text, or any element located by CSS|XPath|strict locator.
-   * @param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element to search in CSS|XPath|Strict locator.
+   * @param {?CodeceptJS.LocatorOrString | null} [context=null] (optional, `null` by default) element to search in CSS|XPath|Strict locator.
+   * [!] returns a _promise_ which is synchronized internally by recorder
    * 
    *
    * {{ react }}
@@ -981,6 +983,7 @@ class WebDriver extends Helper {
    * 
    * @param {CodeceptJS.LocatorOrString} locator clickable link or button located by text, or any element located by CSS|XPath|strict locator.
    * @param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element to search in CSS|XPath|Strict locator.
+   * [!] returns a _promise_ which is synchronized internally by recorder
    * 
    *
    * {{ react }}
@@ -1019,7 +1022,7 @@ class WebDriver extends Helper {
    * 
    * @param {CodeceptJS.LocatorOrString} locator clickable link or button located by text, or any element located by CSS|XPath|strict locator.
    * @param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element to search in CSS|XPath|Strict locator.
-   * 
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    * {{ react }}
    */
@@ -1051,7 +1054,7 @@ class WebDriver extends Helper {
    * 
    * @param {CodeceptJS.LocatorOrString} locator clickable element located by CSS|XPath|strict locator.
    * @param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element located by CSS|XPath|strict locator.
-   * 
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    * {{ react }}
    */
@@ -1094,7 +1097,7 @@ class WebDriver extends Helper {
    * 
    * @param {CodeceptJS.LocatorOrString} locator clickable link or button located by text, or any element located by CSS|XPath|strict locator.
    * @param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element to search in CSS|XPath|Strict locator.
-   * 
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    * {{ react }}
    */
@@ -1135,7 +1138,7 @@ class WebDriver extends Helper {
    * ```
    * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
    * @param {CodeceptJS.StringOrSecret} value text value to fill.
-   * 
+   * [!] returns a _promise_ which is synchronized internally by recorder
    * {{ react }}
    * {{ custom }}
    *
@@ -1156,6 +1159,7 @@ class WebDriver extends Helper {
    * ```
    * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator
    * @param {string} value text value to append.
+   * [!] returns a _promise_ which is synchronized internally by recorder
    * {{ react }}
    */
   async appendField(field, value) {
@@ -1174,7 +1178,7 @@ class WebDriver extends Helper {
    * I.clearField('#email');
    * ```
    * @param {LocatorOrString} editable field located by label|name|CSS|XPath|strict locator.
-   * 
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    */
   async clearField(field) {
@@ -1205,7 +1209,7 @@ class WebDriver extends Helper {
    * ```
    * @param {LocatorOrString} select field located by label|name|CSS|XPath|strict locator.
    * @param {string|Array<*>} option visible text or value of option.
-   * 
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async selectOption(select, option) {
     const res = await findFields.call(this, select);
@@ -1248,6 +1252,7 @@ class WebDriver extends Helper {
    * 
    * @param {CodeceptJS.LocatorOrString} locator field located by label|name|CSS|XPath|strict locator.
    * @param {string} pathToFile local file path relative to codecept.json config file.
+   * [!] returns a _promise_ which is synchronized internally by recorder
    * Appium: not tested
    */
   async attachFile(locator, pathToFile) {
@@ -1287,6 +1292,7 @@ class WebDriver extends Helper {
    * ```
    * @param {CodeceptJS.LocatorOrString} field checkbox located by label | name | CSS | XPath | strict locator.
    * @param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element located by CSS | XPath | strict locator.
+   * [!] returns a _promise_ which is synchronized internally by recorder
    * Appium: not tested
    */
   async checkOption(field, context = null) {
@@ -1317,6 +1323,7 @@ class WebDriver extends Helper {
    * ```
    * @param {CodeceptJS.LocatorOrString} field checkbox located by label | name | CSS | XPath | strict locator.
    * @param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element located by CSS | XPath | strict locator.
+   * [!] returns a _promise_ which is synchronized internally by recorder
    * Appium: not tested
    */
   async uncheckOption(field, context = null) {
@@ -1559,6 +1566,7 @@ class WebDriver extends Helper {
    * ```
    * 
    * @param {string} text text value to check.
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async seeInTitle(text) {
     const title = await this.browser.getTitle();
@@ -1566,14 +1574,14 @@ class WebDriver extends Helper {
   }
 
   /**
-   *  Checks that title is equal to provided one.
-   * 
-   *  ```js
-   *  I.seeTitleEquals('Test title.');
-   *  ```
+   * Checks that title is equal to provided one.
    * 
-   *  @param {string} text value to check.
+   * ```js
+   * I.seeTitleEquals('Test title.');
+   * ```
    * 
+   * @param {string} text value to check.
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async seeTitleEquals(text) {
     const title = await this.browser.getTitle();
@@ -1588,6 +1596,7 @@ class WebDriver extends Helper {
    * ```
    * 
    * @param {string} text value to check.
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async dontSeeInTitle(text) {
     const title = await this.browser.getTitle();
@@ -1621,6 +1630,7 @@ class WebDriver extends Helper {
    * ```
    * @param {string} text expected on page.
    * @param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text.
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    * {{ react }}
    */
@@ -1637,6 +1647,7 @@ class WebDriver extends Helper {
    * 
    * @param {string} text element value to check.
    * @param {CodeceptJS.LocatorOrString?} [context=null]  element located by CSS|XPath|strict locator.
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async seeTextEquals(text, context = null) {
     return proceedSee.call(this, 'assert', text, context, true);
@@ -1653,7 +1664,7 @@ class WebDriver extends Helper {
    * 
    * @param {string} text which is not present.
    * @param {CodeceptJS.LocatorOrString} [context] (optional) element located by CSS|XPath|strict locator in which to perfrom search.
-   * 
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    * {{ react }}
    */
@@ -1673,7 +1684,7 @@ class WebDriver extends Helper {
    * ```
    * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
    * @param {string} value value to check.
-   * 
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    */
   async seeInField(field, value) {
@@ -1691,6 +1702,7 @@ class WebDriver extends Helper {
    * 
    * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
    * @param {string} value value to check.
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    */
   async dontSeeInField(field, value) {
@@ -1707,7 +1719,7 @@ class WebDriver extends Helper {
    * ```
    * 
    * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
-   * 
+   * [!] returns a _promise_ which is synchronized internally by recorder
    * Appium: not tested
    */
   async seeCheckboxIsChecked(field) {
@@ -1724,7 +1736,7 @@ class WebDriver extends Helper {
    * ```
    * 
    * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
-   * 
+   * [!] returns a _promise_ which is synchronized internally by recorder
    * Appium: not tested
    */
   async dontSeeCheckboxIsChecked(field) {
@@ -1739,6 +1751,7 @@ class WebDriver extends Helper {
    * I.seeElement('#modal');
    * ```
    * @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
+   * [!] returns a _promise_ which is synchronized internally by recorder
    * {{ react }}
    *
    */
@@ -1757,6 +1770,7 @@ class WebDriver extends Helper {
    * ```
    * 
    * @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|Strict locator.
+   * [!] returns a _promise_ which is synchronized internally by recorder
    * {{ react }}
    */
   async dontSeeElement(locator) {
@@ -1776,7 +1790,7 @@ class WebDriver extends Helper {
    * I.seeElementInDOM('#modal');
    * ```
    * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
-   * 
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    */
   async seeElementInDOM(locator) {
@@ -1792,6 +1806,7 @@ class WebDriver extends Helper {
    * ```
    * 
    * @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|Strict locator.
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    */
   async dontSeeElementInDOM(locator) {
@@ -1806,6 +1821,7 @@ class WebDriver extends Helper {
    * I.seeInSource('<h1>Green eggs &amp; ham</h1>');
    * ```
    * @param {string} text value to check.
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    */
   async seeInSource(text) {
@@ -1873,7 +1889,7 @@ class WebDriver extends Helper {
    * ```
    * 
    * @param {string} value to check.
-   * 
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async dontSeeInSource(text) {
     const source = await this.browser.getPageSource();
@@ -1891,7 +1907,7 @@ class WebDriver extends Helper {
    * 
    * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
    * @param {number} num number of elements.
-   * 
+   * [!] returns a _promise_ which is synchronized internally by recorder
    * {{ react }}
    */
   async seeNumberOfElements(locator, num) {
@@ -1909,7 +1925,7 @@ class WebDriver extends Helper {
    * 
    * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
    * @param {number} num number of elements.
-   * 
+   * [!] returns a _promise_ which is synchronized internally by recorder
    * {{ react }}
    */
   async seeNumberOfVisibleElements(locator, num) {
@@ -1926,6 +1942,7 @@ class WebDriver extends Helper {
    * 
    * @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
    * @param {object} cssProperties object with CSS properties and their values to check.
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async seeCssPropertiesOnElements(locator, cssProperties) {
     const res = await this._locate(locator);
@@ -1968,6 +1985,7 @@ class WebDriver extends Helper {
    * 
    * @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
    * @param {object} attributes attributes and their values to check.
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async seeAttributesOnElements(locator, attributes) {
     const res = await this._locate(locator);
@@ -2021,6 +2039,7 @@ class WebDriver extends Helper {
    * ```
    * 
    * @param {string} url a fragment to check
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    */
   async seeInCurrentUrl(url) {
@@ -2032,6 +2051,7 @@ class WebDriver extends Helper {
    * Checks that current url does not contain a provided fragment.
    * 
    * @param {string} url value to check.
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    */
   async dontSeeInCurrentUrl(url) {
@@ -2050,6 +2070,7 @@ class WebDriver extends Helper {
    * ```
    * 
    * @param {string} url value to check.
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    */
   async seeCurrentUrlEquals(url) {
@@ -2067,6 +2088,7 @@ class WebDriver extends Helper {
    * ```
    * 
    * @param {string} url value to check.
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    */
   async dontSeeCurrentUrlEquals(url) {
@@ -2100,7 +2122,7 @@ class WebDriver extends Helper {
    * 
    * @param {string|function} fn function to be executed in browser context.
    * @param {...any} args to be passed to function.
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    * 
    *
    *
@@ -2134,7 +2156,7 @@ class WebDriver extends Helper {
    * 
    * @param {string|function} fn function to be executed in browser context.
    * @param {...any} args to be passed to function.
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    * 
    *
    */
@@ -2153,7 +2175,7 @@ class WebDriver extends Helper {
    * 
    * @param {LocatorOrString} locator located by CSS|XPath|strict locator.
    * @param {ScrollIntoViewOptions} scrollIntoViewOptions see https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView.
-   * 
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    */
   async scrollIntoView(locator, scrollIntoViewOptions) {
@@ -2175,6 +2197,7 @@ class WebDriver extends Helper {
    * @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
    * @param {number} [offsetX=0] (optional, `0` by default) X-axis offset.
    * @param {number} [offsetY=0] (optional, `0` by default) Y-axis offset.
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    */
   async scrollTo(locator, offsetX = 0, offsetY = 0) {
@@ -2216,7 +2239,7 @@ class WebDriver extends Helper {
    * @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
    * @param {number} [offsetX=0] (optional, `0` by default) X-axis offset.
    * @param {number} [offsetY=0] (optional, `0` by default) Y-axis offset.
-   * 
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async moveCursorTo(locator, xOffset, yOffset) {
     const res = await this._locate(withStrictLocator(locator), true);
@@ -2236,7 +2259,7 @@ class WebDriver extends Helper {
    * 
    * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
    * @param {string} fileName file name to save.
-   * 
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    */
   async saveElementScreenshot(locator, fileName) {
@@ -2262,6 +2285,7 @@ class WebDriver extends Helper {
    * 
    * @param {string} fileName file name to save.
    * @param {boolean} [fullPage=false] (optional, `false` by default) flag to enable fullscreen screenshot mode.
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async saveScreenshot(fileName, fullPage = false) {
     const outputFile = screenshotOutputFolder(fileName);
@@ -2316,7 +2340,7 @@ class WebDriver extends Helper {
    * ```
    * 
    * @param {Cookie|Array<Cookie>} cookie a cookie object or array of cookie objects.
-   * 
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    *
    * Uses Selenium's JSON [cookie
@@ -2336,6 +2360,7 @@ class WebDriver extends Helper {
    * ```
    * 
    * @param {?string} [cookie=null] (optional, `null` by default) cookie name
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async clearCookie(cookie) {
     return this.browser.deleteCookies(cookie);
@@ -2349,7 +2374,7 @@ class WebDriver extends Helper {
    * ```
    * 
    * @param {string} name cookie name.
-   * 
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async seeCookie(name) {
     const cookie = await this.browser.getCookies([name]);
@@ -2364,6 +2389,7 @@ class WebDriver extends Helper {
    * ```
    * 
    * @param {string} name cookie name.
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async dontSeeCookie(name) {
     const cookie = await this.browser.getCookies([name]);
@@ -2459,7 +2485,7 @@ class WebDriver extends Helper {
    * ```
    * 
    * @param {string} key name of key to press down.
-   * 
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async pressKeyDown(key) {
     key = getNormalizedKey.call(this, key);
@@ -2488,7 +2514,7 @@ class WebDriver extends Helper {
    * ```
    * 
    * @param {string} key name of key to release.
-   * 
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async pressKeyUp(key) {
     key = getNormalizedKey.call(this, key);
@@ -2565,6 +2591,7 @@ class WebDriver extends Helper {
    * - `'Tab'`
    * 
    * @param {string|string[]} key key or array of keys to press.
+   * [!] returns a _promise_ which is synchronized internally by 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.
@@ -2625,7 +2652,7 @@ class WebDriver extends Helper {
    * 
    * @param {string|string[]} key or array of keys to type.
    * @param {?number} [delay=null] (optional) delay in ms between key presses
-   * 
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async type(keys, delay = null) {
     if (!Array.isArray(keys)) {
@@ -2647,6 +2674,7 @@ class WebDriver extends Helper {
    * 
    * @param {number} width width in pixels or `maximize`.
    * @param {number} height height in pixels.
+   * [!] returns a _promise_ which is synchronized internally by recorder
    * Appium: not tested in web, in apps doesn't work
    */
   async resizeWindow(width, height) {
@@ -2683,7 +2711,7 @@ class WebDriver extends Helper {
    * 
    * @param {LocatorOrString} srcElement located by CSS|XPath|strict locator.
    * @param {LocatorOrString} destElement located by CSS|XPath|strict locator.
-   * 
+   * [!] returns a _promise_ which is synchronized internally by recorder
    * Appium: not tested
    */
   async dragAndDrop(srcElement, destElement) {
@@ -2709,6 +2737,7 @@ class WebDriver extends Helper {
    * 
    * @param {CodeceptJS.LocatorOrString} locator located by label|name|CSS|XPath|strict locator.
    * @param {number} offsetX position to drag.
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async dragSlider(locator, offsetX = 0) {
     const browser = this.browser;
@@ -2788,13 +2817,14 @@ class WebDriver extends Helper {
   }
 
   /**
-   *  Close all tabs except for the current one.
+   * Close all tabs except for the current one.
    * 
    * 
-   *  ```js
-   *  I.closeOtherTabs();
-   *  ```
+   * ```js
+   * I.closeOtherTabs();
+   * ```
    * 
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async closeOtherTabs() {
     const handles = await this.browser.getWindowHandles();
@@ -2816,6 +2846,7 @@ class WebDriver extends Helper {
    * ```
    * 
    * @param {number} sec number of second to wait.
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async wait(sec) {
     return new Promise(resolve => setTimeout(resolve, sec * 1000));
@@ -2827,6 +2858,7 @@ class WebDriver extends Helper {
    * 
    * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
    * @param {number} [sec=1] (optional) time in seconds to wait, 1 by default.
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async waitForEnabled(locator, sec = null) {
     const aSec = sec || this.options.waitForTimeout;
@@ -2870,6 +2902,7 @@ class WebDriver extends Helper {
    * 
    * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
    * @param {number} [sec] (optional, `1` by default) time in seconds to wait
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async waitForElement(locator, sec = null) {
     const aSec = sec || this.options.waitForTimeout;
@@ -2896,6 +2929,7 @@ class WebDriver extends Helper {
    * 
    * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
    * @param {number} [sec] (optional, `1` by default) time in seconds to wait
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async waitForClickable(locator, waitTimeout) {
     waitTimeout = waitTimeout || this.options.waitForTimeout;
@@ -2918,6 +2952,7 @@ class WebDriver extends Helper {
    * 
    * @param {string} urlPart value to check.
    * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async waitInUrl(urlPart, sec = null) {
     const client = this.browser;
@@ -2961,6 +2996,7 @@ class WebDriver extends Helper {
    * 
    * @param {string} urlPart value to check.
    * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async waitUrlEquals(urlPart, sec = null) {
     const aSec = sec || this.options.waitForTimeout;
@@ -2995,6 +3031,7 @@ class WebDriver extends Helper {
    * @param {string }text to wait for.
    * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
    * @param {CodeceptJS.LocatorOrString} [context] (optional) element located by CSS|XPath|strict locator.
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    */
   async waitForText(text, sec = null, context = null) {
@@ -3041,7 +3078,7 @@ class WebDriver extends Helper {
    * @param {LocatorOrString} field input field.
    * @param {string }value expected value.
    * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
-   * 
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async waitForValue(field, value, sec = null) {
     const client = this.browser;
@@ -3086,7 +3123,7 @@ class WebDriver extends Helper {
    * 
    * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
    * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
-   * 
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    */
   async waitForVisible(locator, sec = null) {
@@ -3123,6 +3160,7 @@ class WebDriver extends Helper {
    * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
    * @param {number} num number of elements.
    * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async waitNumberOfVisibleElements(locator, num, sec = null) {
     const aSec = sec || this.options.waitForTimeout;
@@ -3158,6 +3196,7 @@ class WebDriver extends Helper {
    * 
    * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
    * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async waitForInvisible(locator, sec = null) {
     const aSec = sec || this.options.waitForTimeout;
@@ -3187,6 +3226,7 @@ class WebDriver extends Helper {
    * 
    * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
    * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async waitToHide(locator, sec = null) {
     return this.waitForInvisible(locator, sec);
@@ -3202,6 +3242,7 @@ class WebDriver extends Helper {
    * 
    * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
    * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async waitForDetached(locator, sec = null) {
     const aSec = sec || this.options.waitForTimeout;
@@ -3240,7 +3281,7 @@ class WebDriver extends Helper {
    * @param {string|function} fn to be executed in browser context.
    * @param {any[]|number} [argsOrSec] (optional, `1` by default) arguments for function or seconds.
    * @param {number} [sec] (optional, `1` by default) time in seconds to wait
-   * 
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async waitForFunction(fn, argsOrSec = null, sec = null) {
     let args = [];
@@ -3268,6 +3309,7 @@ class WebDriver extends Helper {
    * ```
    * 
    * @param {?CodeceptJS.LocatorOrString} [locator=null] (optional, `null` by default) element located by CSS|XPath|strict locator.
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async switchTo(locator) {
     this.browser.isInsideFrame = true;
@@ -3285,16 +3327,16 @@ class WebDriver extends Helper {
   }
 
   /**
-   *  Switch focus to a particular tab by its number. It waits tabs loading and then switch tab.
+   * Switch focus to a particular tab by its number. It waits tabs loading and then switch tab.
    * 
-   *  ```js
-   *  I.switchToNextTab();
-   *  I.switchToNextTab(2);
-   *  ```
-   * 
-   *  @param {number} [num] (optional) number of tabs to switch forward, default: 1.
-   *  @param {number | null} [sec] (optional) time in seconds to wait.
+   * ```js
+   * I.switchToNextTab();
+   * I.switchToNextTab(2);
+   * ```
    * 
+   * @param {number} [num] (optional) number of tabs to switch forward, default: 1.
+   * @param {number | null} [sec] (optional) time in seconds to wait.
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async switchToNextTab(num = 1, sec = null) {
     const aSec = sec || this.options.waitForTimeout;
@@ -3325,16 +3367,16 @@ class WebDriver extends Helper {
   }
 
   /**
-   *  Switch focus to a particular tab by its number. It waits tabs loading and then switch tab.
+   * Switch focus to a particular tab by its number. It waits tabs loading and then switch tab.
    * 
-   *  ```js
-   *  I.switchToPreviousTab();
-   *  I.switchToPreviousTab(2);
-   *  ```
-   * 
-   *  @param {number} [num] (optional) number of tabs to switch backward, default: 1.
-   *  @param {number?} [sec] (optional) time in seconds to wait.
+   * ```js
+   * I.switchToPreviousTab();
+   * I.switchToPreviousTab(2);
+   * ```
    * 
+   * @param {number} [num] (optional) number of tabs to switch backward, default: 1.
+   * @param {number?} [sec] (optional) time in seconds to wait.
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async switchToPreviousTab(num = 1, sec = null) {
     const aSec = sec || this.options.waitForTimeout;
@@ -3365,12 +3407,13 @@ class WebDriver extends Helper {
   }
 
   /**
-   *  Close current tab.
+   * Close current tab.
    * 
-   *  ```js
-   *  I.closeCurrentTab();
-   *  ```
+   * ```js
+   * I.closeCurrentTab();
+   * ```
    * 
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async closeCurrentTab() {
     await this.browser.closeWindow();
@@ -3379,12 +3422,13 @@ class WebDriver extends Helper {
   }
 
   /**
-   *  Open new tab and switch to it.
+   * Open new tab and switch to it.
    * 
-   *  ```js
-   *  I.openNewTab();
-   *  ```
+   * ```js
+   * I.openNewTab();
+   * ```
    * 
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async openNewTab(url = 'about:blank', windowName = null) {
     const client = this.browser;
@@ -3418,7 +3462,7 @@ class WebDriver extends Helper {
    * ```js
    * I.refreshPage();
    * ```
-   * 
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async refreshPage() {
     const client = this.browser;
@@ -3431,7 +3475,7 @@ class WebDriver extends Helper {
    * ```js
    * I.scrollPageToTop();
    * ```
-   * 
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   scrollPageToTop() {
     const client = this.browser;
@@ -3448,7 +3492,7 @@ class WebDriver extends Helper {
    * ```js
    * I.scrollPageToBottom();
    * ```
-   * 
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   scrollPageToBottom() {
     const client = this.browser;
@@ -3499,7 +3543,7 @@ class WebDriver extends Helper {
    * @param {number} latitude to set.
    * @param {number} longitude to set
    * @param {number=} altitude (optional, null by default) to set
-   * 
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async setGeoLocation(latitude, longitude, altitude = null) {
     if (altitude) {
@@ -3561,6 +3605,8 @@ class WebDriver extends Helper {
 
   /**
    * Placeholder for ~ locator only test case write once run on both Appium and WebDriver.
+   * @param {*} caps
+   * @param {*} fn
    */
   /* eslint-disable */
   runOnIOS(caps, fn) {
@@ -3568,6 +3614,8 @@ class WebDriver extends Helper {
 
   /**
    * Placeholder for ~ locator only test case write once run on both Appium and WebDriver.
+   * @param {*} caps
+   * @param {*} fn
    */
   runOnAndroid(caps, fn) {
   }