codeceptjs 3.3.0-beta.5 → 3.3.2

package/docs/build/WebDriver.js

@@ -772,7 +772,7 @@ class WebDriver extends Helper {
    * ```
    *
    *
-   * @param {string | object} locator element located by CSS|XPath|strict locator.
+   * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
    */
   async _locate(locator, smartWait = false) {
     if (require('../store').debugMode) smartWait = false;
@@ -831,7 +831,7 @@ class WebDriver extends Helper {
    * this.helpers['WebDriver']._locateCheckable('I agree with terms and conditions').then // ...
    * ```
    *
-   * @param {string | object} locator element located by CSS|XPath|strict locator.
+   * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
    */
   async _locateCheckable(locator) {
     return findCheckable.call(this, locator, this.$$.bind(this)).then(res => res);
@@ -845,7 +845,7 @@ class WebDriver extends Helper {
    * const els = await this.helpers.WebDriver._locateClickable('Next page', '.pages');
    * ```
    *
-   * @param {string | object} locator element located by CSS|XPath|strict locator.
+   * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
    */
   async _locateClickable(locator, context) {
     const locateFn = prepareLocateFn.call(this, context);
@@ -859,7 +859,7 @@ class WebDriver extends Helper {
    * this.helpers['WebDriver']._locateFields('Your email').then // ...
    * ```
    *
-   * @param {string | object} locator element located by CSS|XPath|strict locator.
+   * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
    */
   async _locateFields(locator) {
     return findFields.call(this, locator).then(res => res);
@@ -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) {
@@ -933,8 +934,9 @@ class WebDriver extends Helper {
    * I.click({css: 'nav a.login'});
    * ```
    * 
-   * @param {string | object} locator clickable link or button located by text, or any element located by CSS|XPath|strict locator.
-   * @param {?string | object} [context=null] (optional, `null` by default) element to search in CSS|XPath|Strict locator.
+   * @param {CodeceptJS.LocatorOrString} locator clickable link or button located by text, or any element located by 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 }}
@@ -979,8 +981,9 @@ class WebDriver extends Helper {
    * I.forceClick({css: 'nav a.login'});
    * ```
    * 
-   * @param {string | object} locator clickable link or button located by text, or any element located by CSS|XPath|strict locator.
-   * @param {?string | object} [context=null] (optional, `null` by default) element to search in CSS|XPath|Strict locator.
+   * @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 }}
@@ -1017,9 +1020,9 @@ class WebDriver extends Helper {
    * I.doubleClick('.btn.edit');
    * ```
    * 
-   * @param {string | object} locator clickable link or button located by text, or any element located by CSS|XPath|strict locator.
-   * @param {?string | object} [context=null] (optional, `null` by default) element to search in CSS|XPath|Strict locator.
-   * 
+   * @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 }}
    */
@@ -1049,9 +1052,9 @@ class WebDriver extends Helper {
    * I.rightClick('Click me', '.context');
    * ```
    * 
-   * @param {string | object} locator clickable element located by CSS|XPath|strict locator.
-   * @param {?string | object} [context=null] (optional, `null` by default) element located by CSS|XPath|strict locator.
-   * 
+   * @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 }}
    */
@@ -1092,9 +1095,9 @@ class WebDriver extends Helper {
    * I.forceRightClick('Menu');
    * ```
    * 
-   * @param {string | object} locator clickable link or button located by text, or any element located by CSS|XPath|strict locator.
-   * @param {?string | object} [context=null] (optional, `null` by default) element to search in CSS|XPath|Strict locator.
-   * 
+   * @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 }}
    */
@@ -1133,9 +1136,9 @@ class WebDriver extends Helper {
    * // or by strict locator
    * I.fillField({css: 'form#login input[name=username]'}, 'John');
    * ```
-   * @param {string | object} field located by label|name|CSS|XPath|strict locator.
-   * @param {string | object} value text value to fill.
-   * 
+   * @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 }}
    *
@@ -1154,8 +1157,9 @@ class WebDriver extends Helper {
    * ```js
    * I.appendField('#myTextField', 'appended');
    * ```
-   * @param {string | object} field located by label|name|CSS|XPath|strict locator
+   * @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) {
@@ -1173,8 +1177,8 @@ class WebDriver extends Helper {
    * I.clearField('user[email]');
    * I.clearField('#email');
    * ```
-   * @param {string | object} editable field located by label|name|CSS|XPath|strict locator.
-   * 
+   * @param {LocatorOrString} editable field located by label|name|CSS|XPath|strict locator.
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    */
   async clearField(field) {
@@ -1203,9 +1207,9 @@ class WebDriver extends Helper {
    * ```js
    * I.selectOption('Which OS do you use?', ['Android', 'iOS']);
    * ```
-   * @param {string | object} select field located by label|name|CSS|XPath|strict locator.
+   * @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);
@@ -1246,8 +1250,9 @@ class WebDriver extends Helper {
    * I.attachFile('form input[name=avatar]', 'data/avatar.jpg');
    * ```
    * 
-   * @param {string | object} locator field located by label|name|CSS|XPath|strict locator.
+   * @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) {
@@ -1285,8 +1290,9 @@ class WebDriver extends Helper {
    * I.checkOption('I Agree to Terms and Conditions');
    * I.checkOption('agree', '//form');
    * ```
-   * @param {string | object} field checkbox located by label | name | CSS | XPath | strict locator.
-   * @param {?string | object} [context=null] (optional, `null` by default) element located by CSS | XPath | strict locator.
+   * @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) {
@@ -1315,8 +1321,9 @@ class WebDriver extends Helper {
    * I.uncheckOption('I Agree to Terms and Conditions');
    * I.uncheckOption('agree', '//form');
    * ```
-   * @param {string | object} field checkbox located by label | name | CSS | XPath | strict locator.
-   * @param {?string | object} [context=null] (optional, `null` by default) element located by CSS | XPath | strict locator.
+   * @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) {
@@ -1342,7 +1349,7 @@ class WebDriver extends Helper {
    * let pins = await I.grabTextFromAll('#pin li');
    * ```
    * 
-   * @param {string | object} locator element located by CSS|XPath|strict locator.
+   * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
    * @returns {Promise<string[]>} attribute value
    * 
    *
@@ -1363,7 +1370,7 @@ class WebDriver extends Helper {
    * ```
    * If multiple elements found returns first element.
    * 
-   * @param {string | object} locator element located by CSS|XPath|strict locator.
+   * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
    * @returns {Promise<string>} attribute value
    * 
    *
@@ -1386,7 +1393,7 @@ class WebDriver extends Helper {
    * let postHTMLs = await I.grabHTMLFromAll('.post');
    * ```
    * 
-   * @param {string | object} element located by CSS|XPath|strict locator.
+   * @param {CodeceptJS.LocatorOrString} element located by CSS|XPath|strict locator.
    * @returns {Promise<string[]>} HTML code for an element
    * 
    *
@@ -1407,7 +1414,7 @@ class WebDriver extends Helper {
    * let postHTML = await I.grabHTMLFrom('#post');
    * ```
    * 
-   * @param {string | object} element located by CSS|XPath|strict locator.
+   * @param {CodeceptJS.LocatorOrString} element located by CSS|XPath|strict locator.
    * @returns {Promise<string>} HTML code for an element
    * 
    *
@@ -1429,7 +1436,7 @@ class WebDriver extends Helper {
    * ```js
    * let inputs = await I.grabValueFromAll('//form/input');
    * ```
-   * @param {string | object} locator field located by label|name|CSS|XPath|strict locator.
+   * @param {CodeceptJS.LocatorOrString} locator field located by label|name|CSS|XPath|strict locator.
    * @returns {Promise<string[]>} attribute value
    * 
    *
@@ -1450,7 +1457,7 @@ class WebDriver extends Helper {
    * ```js
    * let email = await I.grabValueFrom('input[name=email]');
    * ```
-   * @param {string | object} locator field located by label|name|CSS|XPath|strict locator.
+   * @param {CodeceptJS.LocatorOrString} locator field located by label|name|CSS|XPath|strict locator.
    * @returns {Promise<string>} attribute value
    * 
    *
@@ -1473,7 +1480,7 @@ class WebDriver extends Helper {
    * const values = await I.grabCssPropertyFromAll('h3', 'font-weight');
    * ```
    * 
-   * @param {string | object} locator element located by CSS|XPath|strict locator.
+   * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
    * @param {string} cssProperty CSS property name.
    * @returns {Promise<string[]>} CSS value
    * 
@@ -1494,7 +1501,7 @@ class WebDriver extends Helper {
    * const value = await I.grabCssPropertyFrom('h3', 'font-weight');
    * ```
    * 
-   * @param {string | object} locator element located by CSS|XPath|strict locator.
+   * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
    * @param {string} cssProperty CSS property name.
    * @returns {Promise<string>} CSS value
    * 
@@ -1517,7 +1524,7 @@ class WebDriver extends Helper {
    * ```js
    * let hints = await I.grabAttributeFromAll('.tooltip', 'title');
    * ```
-   * @param {string | object} locator element located by CSS|XPath|strict locator.
+   * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
    * @param {string} attr attribute name.
    * @returns {Promise<string[]>} attribute value
    * 
@@ -1537,7 +1544,7 @@ class WebDriver extends Helper {
    * ```js
    * let hint = await I.grabAttributeFrom('#tooltip', 'title');
    * ```
-   * @param {string | object} locator element located by CSS|XPath|strict locator.
+   * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
    * @param {string} attr attribute name.
    * @returns {Promise<string>} attribute value
    * 
@@ -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.
+   * Checks that title is equal to provided one.
    * 
-   *  ```js
-   *  I.seeTitleEquals('Test title.');
-   *  ```
-   * 
-   *  @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();
@@ -1620,7 +1629,8 @@ class WebDriver extends Helper {
    * I.see('Register', {css: 'form.register'}); // use strict locator
    * ```
    * @param {string} text expected on page.
-   * @param {?string | object} [context=null] (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text.
+   * @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 }}
    */
@@ -1636,7 +1646,8 @@ class WebDriver extends Helper {
    * ```
    * 
    * @param {string} text element value to check.
-   * @param {(string | object)?} [context=null]  element located by CSS|XPath|strict locator.
+   * @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);
@@ -1652,8 +1663,8 @@ class WebDriver extends Helper {
    * ```
    * 
    * @param {string} text which is not present.
-   * @param {string | object} [context] (optional) element located by CSS|XPath|strict locator in which to perfrom search.
-   * 
+   * @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 }}
    */
@@ -1671,9 +1682,9 @@ class WebDriver extends Helper {
    * I.seeInField('form input[type=hidden]','hidden_value');
    * I.seeInField('#searchform input','Search');
    * ```
-   * @param {string | object} field located by label|name|CSS|XPath|strict locator.
+   * @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) {
@@ -1689,8 +1700,9 @@ class WebDriver extends Helper {
    * I.dontSeeInField({ css: 'form input.email' }, 'user@user.com'); // field by CSS
    * ```
    * 
-   * @param {string | object} field located by label|name|CSS|XPath|strict locator.
+   * @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) {
@@ -1706,8 +1718,8 @@ class WebDriver extends Helper {
    * I.seeCheckboxIsChecked({css: '#signup_form input[type=checkbox]'});
    * ```
    * 
-   * @param {string | object} field located by label|name|CSS|XPath|strict locator.
-   * 
+   * @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) {
@@ -1723,8 +1735,8 @@ class WebDriver extends Helper {
    * I.dontSeeCheckboxIsChecked('agree'); // located by name
    * ```
    * 
-   * @param {string | object} field located by label|name|CSS|XPath|strict locator.
-   * 
+   * @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) {
@@ -1738,7 +1750,8 @@ class WebDriver extends Helper {
    * ```js
    * I.seeElement('#modal');
    * ```
-   * @param {string | object} locator located by CSS|XPath|strict locator.
+   * @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
+   * [!] returns a _promise_ which is synchronized internally by recorder
    * {{ react }}
    *
    */
@@ -1756,7 +1769,8 @@ class WebDriver extends Helper {
    * I.dontSeeElement('.modal'); // modal is not shown
    * ```
    * 
-   * @param {string | object} locator located by CSS|XPath|Strict locator.
+   * @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|Strict locator.
+   * [!] returns a _promise_ which is synchronized internally by recorder
    * {{ react }}
    */
   async dontSeeElement(locator) {
@@ -1775,8 +1789,8 @@ class WebDriver extends Helper {
    * ```js
    * I.seeElementInDOM('#modal');
    * ```
-   * @param {string | object} locator element located by CSS|XPath|strict locator.
-   * 
+   * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    */
   async seeElementInDOM(locator) {
@@ -1791,7 +1805,8 @@ class WebDriver extends Helper {
    * I.dontSeeElementInDOM('.nav'); // checks that element is not on page visible or not
    * ```
    * 
-   * @param {string | object} locator located by CSS|XPath|Strict locator.
+   * @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();
@@ -1889,9 +1905,9 @@ class WebDriver extends Helper {
    * I.seeNumberOfElements('#submitBtn', 1);
    * ```
    * 
-   * @param {string | object} locator element located by CSS|XPath|strict locator.
+   * @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) {
@@ -1907,9 +1923,9 @@ class WebDriver extends Helper {
    * I.seeNumberOfVisibleElements('.buttons', 3);
    * ```
    * 
-   * @param {string | object} locator element located by CSS|XPath|strict locator.
+   * @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) {
@@ -1924,8 +1940,9 @@ class WebDriver extends Helper {
    * I.seeCssPropertiesOnElements('h3', { 'font-weight': "bold"});
    * ```
    * 
-   * @param {string | object} locator located by CSS|XPath|strict locator.
+   * @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);
@@ -1966,8 +1983,9 @@ class WebDriver extends Helper {
    * I.seeAttributesOnElements('//form', { method: "post"});
    * ```
    * 
-   * @param {string | object} locator located by CSS|XPath|strict locator.
+   * @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);
@@ -2001,7 +2019,7 @@ class WebDriver extends Helper {
    * let numOfElements = await I.grabNumberOfVisibleElements('p');
    * ```
    * 
-   * @param {string | object} locator located by CSS|XPath|strict locator.
+   * @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
    * @returns {Promise<number>} number of visible elements
    */
   async grabNumberOfVisibleElements(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
    * 
    *
    */
@@ -2151,9 +2173,9 @@ class WebDriver extends Helper {
    * I.scrollIntoView('#submit', { behavior: "smooth", block: "center", inline: "center" });
    * ```
    * 
-   * @param {string | object} locator located by CSS|XPath|strict locator.
+   * @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) {
@@ -2172,9 +2194,10 @@ class WebDriver extends Helper {
    * I.scrollTo('#submit', 5, 5);
    * ```
    * 
-   * @param {string | object} locator located by CSS|XPath|strict locator.
+   * @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) {
@@ -2213,10 +2236,10 @@ class WebDriver extends Helper {
    * I.moveCursorTo('#submit', 5,5);
    * ```
    * 
-   * @param {string | object} locator located by CSS|XPath|strict locator.
+   * @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);
@@ -2234,9 +2257,9 @@ class WebDriver extends Helper {
    * I.saveElementScreenshot(`#submit`,'debug.png');
    * ```
    * 
-   * @param {string | object} locator element located by CSS|XPath|strict locator.
+   * @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) {
@@ -2681,9 +2709,9 @@ class WebDriver extends Helper {
    * I.dragAndDrop('#dragHandle', '#container');
    * ```
    * 
-   * @param {string | object} srcElement located by CSS|XPath|strict locator.
-   * @param {string | object} destElement located by CSS|XPath|strict locator.
-   * 
+   * @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) {
@@ -2707,8 +2735,9 @@ class WebDriver extends Helper {
    * I.dragSlider('#slider', -70);
    * ```
    * 
-   * @param {string | object} locator located by label|name|CSS|XPath|strict locator.
+   * @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));
@@ -2825,8 +2856,9 @@ class WebDriver extends Helper {
    * Waits for element to become enabled (by default waits for 1sec).
    * Element can be located by CSS or XPath.
    * 
-   * @param {string | object} locator element located by CSS|XPath|strict locator.
+   * @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;
@@ -2868,8 +2900,9 @@ class WebDriver extends Helper {
    * I.waitForElement('.btn.continue', 5); // wait for 5 secs
    * ```
    * 
-   * @param {string | object} locator element located by CSS|XPath|strict locator.
+   * @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;
@@ -2894,8 +2927,9 @@ class WebDriver extends Helper {
    * I.waitForClickable('.btn.continue', 5); // wait for 5 secs
    * ```
    * 
-   * @param {string | object} locator element located by CSS|XPath|strict locator.
+   * @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;
@@ -2994,7 +3030,8 @@ class WebDriver extends Helper {
    * 
    * @param {string }text to wait for.
    * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
-   * @param {string | object} [context] (optional) element located by CSS|XPath|strict locator.
+   * @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) {
@@ -3038,10 +3075,10 @@ class WebDriver extends Helper {
    * I.waitForValue('//input', "GoodValue");
    * ```
    * 
-   * @param {string | object} field input field.
+   * @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;
@@ -3084,9 +3121,9 @@ class WebDriver extends Helper {
    * I.waitForVisible('#popup');
    * ```
    * 
-   * @param {string | object} locator element located by CSS|XPath|strict locator.
+   * @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) {
@@ -3120,9 +3157,10 @@ class WebDriver extends Helper {
    * I.waitNumberOfVisibleElements('a', 3);
    * ```
    * 
-   * @param {string | object} locator element located by CSS|XPath|strict locator.
+   * @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;
@@ -3156,8 +3194,9 @@ class WebDriver extends Helper {
    * I.waitForInvisible('#popup');
    * ```
    * 
-   * @param {string | object} locator element located by CSS|XPath|strict locator.
+   * @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;
@@ -3185,8 +3224,9 @@ class WebDriver extends Helper {
    * I.waitToHide('#popup');
    * ```
    * 
-   * @param {string | object} locator element located by CSS|XPath|strict locator.
+   * @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);
@@ -3200,8 +3240,9 @@ class WebDriver extends Helper {
    * I.waitForDetached('#popup');
    * ```
    * 
-   * @param {string | object} locator element located by CSS|XPath|strict locator.
+   * @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 = [];
@@ -3267,7 +3308,8 @@ class WebDriver extends Helper {
    * I.switchTo(); // switch back to main page
    * ```
    * 
-   * @param {?string | object} [locator=null] (optional, `null` by default) element located by CSS|XPath|strict locator.
+   * @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) {
@@ -3541,7 +3585,7 @@ class WebDriver extends Helper {
    * const width = await I.grabElementBoundingRect('h3', 'width');
    * // width == 527
    * ```
-   * @param {string | object} locator element located by CSS|XPath|strict locator.
+   * @param {LocatorOrString} locator element located by CSS|XPath|strict locator.
    * @param {string=} elementSize x, y, width or height of the given element.
    * @returns {Promise<DOMRect>|Promise<number>} Element bounding rectangle
    * 
@@ -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) {
   }