codeceptjs 3.3.0-beta.5 → 3.3.2

package/docs/build/Puppeteer.js

@@ -444,7 +444,7 @@ class Puppeteer extends Helper {
    * I.seeInPopup('Popup text');
    * ```
    * @param {string} text value to check.
-   * 
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async seeInPopup(text) {
     popupStore.assertPopupVisible();
@@ -639,6 +639,7 @@ class Puppeteer extends Helper {
    * ```
    * 
    * @param {string} url url path or global url.
+   * @return {void} automatically synchronized promise with recorder #! 
    */
   async amOnPage(url) {
     if (!(/^\w+\:\/\//.test(url))) {
@@ -673,6 +674,7 @@ class Puppeteer 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
    *
    * 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.
@@ -714,10 +716,10 @@ class Puppeteer 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
    * {{ react }}
    */
   async moveCursorTo(locator, offsetX = 0, offsetY = 0) {
@@ -737,9 +739,9 @@ class Puppeteer 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
    */
   async dragAndDrop(srcElement, destElement) {
     return proceedDragAndDrop.call(this, srcElement, destElement);
@@ -751,7 +753,7 @@ class Puppeteer extends Helper {
    * ```js
    * I.refreshPage();
    * ```
-   * 
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async refreshPage() {
     return this.page.reload({ timeout: this.options.getPageTimeout, waitUntil: this.options.waitForNavigation });
@@ -763,7 +765,7 @@ class Puppeteer extends Helper {
    * ```js
    * I.scrollPageToTop();
    * ```
-   * 
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   scrollPageToTop() {
     return this.executeScript(() => {
@@ -777,7 +779,7 @@ class Puppeteer extends Helper {
    * ```js
    * I.scrollPageToBottom();
    * ```
-   * 
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   scrollPageToBottom() {
     return this.executeScript(() => {
@@ -799,9 +801,10 @@ class Puppeteer 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) {
     if (typeof locator === 'number' && typeof offsetX === 'number') {
@@ -830,6 +833,7 @@ class Puppeteer 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.page.title();
@@ -860,14 +864,14 @@ class Puppeteer 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.page.title();
@@ -882,6 +886,7 @@ class Puppeteer extends Helper {
    * ```
    * 
    * @param {string} text value to check.
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async dontSeeInTitle(text) {
     const title = await this.page.title();
@@ -1069,7 +1074,8 @@ class Puppeteer 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 }}
    */
   async seeElement(locator) {
@@ -1088,7 +1094,8 @@ class Puppeteer 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) {
@@ -1107,8 +1114,8 @@ class Puppeteer 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) {
     const els = await this._locate(locator);
@@ -1122,7 +1129,8 @@ class Puppeteer 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) {
     const els = await this._locate(locator);
@@ -1152,8 +1160,9 @@ class Puppeteer 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 }}
@@ -1188,8 +1197,9 @@ class Puppeteer 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 }}
@@ -1225,8 +1235,9 @@ class Puppeteer extends Helper {
    * ```js
    * I.clickLink('Logout', '#nav');
    * ```
-   * @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 }}
    */
@@ -1337,9 +1348,9 @@ class Puppeteer 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 }}
    */
@@ -1359,9 +1370,9 @@ class Puppeteer 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 }}
    */
@@ -1380,8 +1391,9 @@ class Puppeteer 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
    */
   async checkOption(field, context = null) {
     const elm = await this._locateCheckable(field, context);
@@ -1405,8 +1417,9 @@ class Puppeteer 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
    */
   async uncheckOption(field, context = null) {
     const elm = await this._locateCheckable(field, context);
@@ -1428,8 +1441,8 @@ class Puppeteer 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
    */
   async seeCheckboxIsChecked(field) {
     return proceedIsChecked.call(this, 'assert', field);
@@ -1444,8 +1457,8 @@ class Puppeteer 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
    */
   async dontSeeCheckboxIsChecked(field) {
     return proceedIsChecked.call(this, 'negate', field);
@@ -1463,7 +1476,7 @@ class Puppeteer 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);
@@ -1483,7 +1496,7 @@ class Puppeteer 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);
@@ -1551,6 +1564,7 @@ class Puppeteer extends Helper {
    * - `'Tab'`
    * 
    * @param {string|string[]} key key or array of keys to press.
+   * [!] returns a _promise_ which is synchronized internally by recorder
    * 
    *
    * _Note:_ Shortcuts like `'Meta'` + `'A'` do not work on macOS ([GoogleChrome/puppeteer#1313](https://github.com/GoogleChrome/puppeteer/issues/1313)).
@@ -1598,7 +1612,7 @@ class Puppeteer 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)) {
@@ -1625,9 +1639,9 @@ class Puppeteer 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 }}
    */
   async fillField(field, value) {
@@ -1653,8 +1667,8 @@ class Puppeteer 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) {
     return this.fillField(field, '');
@@ -1667,8 +1681,9 @@ class Puppeteer 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 }}
    */
@@ -1690,9 +1705,9 @@ class Puppeteer 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) {
     return proceedSeeInField.call(this, 'assert', field, value);
@@ -1707,8 +1722,9 @@ class Puppeteer 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) {
     return proceedSeeInField.call(this, 'negate', field, value);
@@ -1724,8 +1740,9 @@ class Puppeteer 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
    *
    * > ⚠ 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.
    */
@@ -1760,9 +1777,9 @@ class Puppeteer 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 els = await findVisibleFields.call(this, select);
@@ -1801,7 +1818,7 @@ class Puppeteer 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
    * {{ react }}
    */
@@ -1822,6 +1839,7 @@ class Puppeteer extends Helper {
    * ```
    * 
    * @param {string} url a fragment to check
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async seeInCurrentUrl(url) {
     stringIncludes('url').assert(url, await this._getPageUrl());
@@ -1831,6 +1849,7 @@ class Puppeteer 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) {
     stringIncludes('url').negate(url, await this._getPageUrl());
@@ -1847,6 +1866,7 @@ class Puppeteer extends Helper {
    * ```
    * 
    * @param {string} url value to check.
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async seeCurrentUrlEquals(url) {
     urlEquals(this.options.url).assert(url, await this._getPageUrl());
@@ -1862,6 +1882,7 @@ class Puppeteer extends Helper {
    * ```
    * 
    * @param {string} url value to check.
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async dontSeeCurrentUrlEquals(url) {
     urlEquals(this.options.url).negate(url, await this._getPageUrl());
@@ -1877,7 +1898,8 @@ class Puppeteer 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 }}
    */
@@ -1893,7 +1915,8 @@ class Puppeteer 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);
@@ -1909,8 +1932,8 @@ class Puppeteer 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 }}
    */
@@ -1969,6 +1992,7 @@ class Puppeteer 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) {
     const source = await this.page.content();
@@ -1983,7 +2007,7 @@ class Puppeteer extends Helper {
    * ```
    * 
    * @param {string} value to check.
-   * 
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async dontSeeInSource(text) {
     const source = await this.page.content();
@@ -1999,9 +2023,9 @@ class Puppeteer 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 }}
    */
@@ -2018,9 +2042,9 @@ class Puppeteer 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 }}
    */
@@ -2045,7 +2069,7 @@ class Puppeteer extends Helper {
    * ```
    * 
    * @param {Cookie|Array<Cookie>} cookie a cookie object or array of cookie objects.
-   * 
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async setCookie(cookie) {
     if (Array.isArray(cookie)) {
@@ -2062,7 +2086,7 @@ class Puppeteer extends Helper {
    * ```
    * 
    * @param {string} name cookie name.
-   * 
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    */
   async seeCookie(name) {
@@ -2078,6 +2102,7 @@ class Puppeteer extends Helper {
    * ```
    * 
    * @param {string} name cookie name.
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async dontSeeCookie(name) {
     const cookies = await this.page.cookies();
@@ -2117,6 +2142,7 @@ class Puppeteer extends Helper {
    * ```
    * 
    * @param {?string} [cookie=null] (optional, `null` by default) cookie name
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async clearCookie(name) {
     const cookies = await this.page.cookies();
@@ -2154,7 +2180,7 @@ class Puppeteer 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
    * 
    *
    * If a function returns a Promise It will wait for it resolution.
@@ -2191,7 +2217,7 @@ class Puppeteer 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
    * 
    *
    * Asynchronous scripts can also be executed with `executeScript` if a function returns a Promise.
@@ -2218,7 +2244,7 @@ class Puppeteer 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
    * 
    * {{ react }}
@@ -2241,7 +2267,7 @@ class Puppeteer 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
    * 
    * {{ react }}
@@ -2263,7 +2289,7 @@ class Puppeteer 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
    * 
    */
@@ -2284,7 +2310,7 @@ class Puppeteer 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
    * 
    */
@@ -2306,7 +2332,7 @@ class Puppeteer 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
    * 
    */
@@ -2325,7 +2351,7 @@ class Puppeteer 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
    * 
    */
@@ -2347,7 +2373,7 @@ class Puppeteer 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
    * 
@@ -2370,7 +2396,7 @@ class Puppeteer 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
    * 
@@ -2394,8 +2420,9 @@ class Puppeteer 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
    * {{ react }}
    */
   async seeCssPropertiesOnElements(locator, cssProperties) {
@@ -2440,8 +2467,9 @@ class Puppeteer 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
    * {{ react }}
    */
   async seeAttributesOnElements(locator, attributes) {
@@ -2480,8 +2508,9 @@ class Puppeteer 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
    * {{ react }}
    */
   async dragSlider(locator, offsetX = 0) {
@@ -2509,7 +2538,7 @@ class Puppeteer 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
    * 
@@ -2533,7 +2562,7 @@ class Puppeteer 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
    * 
@@ -2557,9 +2586,9 @@ class Puppeteer 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) {
     const outputFile = screenshotOutputFolder(fileName);
@@ -2584,6 +2613,7 @@ class Puppeteer 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) {
     const fullPageOption = fullPage || this.options.fullPageScreenshots;
@@ -2618,6 +2648,7 @@ class Puppeteer 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(((done) => {
@@ -2629,8 +2660,9 @@ class Puppeteer 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) {
     const waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout;
@@ -2666,10 +2698,10 @@ class Puppeteer 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) {
     const waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout;
@@ -2706,9 +2738,10 @@ class Puppeteer 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
    * {{ react }}
    */
   async waitNumberOfVisibleElements(locator, num, sec) {
@@ -2747,8 +2780,9 @@ class Puppeteer 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) {
     const els = await this._locate(locator);
@@ -2772,8 +2806,9 @@ class Puppeteer 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
    * {{ react }}
    */
   async waitForElement(locator, sec) {
@@ -2800,9 +2835,9 @@ class Puppeteer 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
    *
    * This method accepts [React selectors](https://codecept.io/react).
    */
@@ -2830,8 +2865,9 @@ class Puppeteer 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) {
     const waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout;
@@ -2857,8 +2893,9 @@ class Puppeteer 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) {
     const waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout;
@@ -2891,6 +2928,7 @@ class Puppeteer 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 waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout;
@@ -2918,6 +2956,7 @@ class Puppeteer 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 waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout;
@@ -2952,7 +2991,8 @@ class Puppeteer 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) {
     const waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout;
@@ -3027,7 +3067,8 @@ class Puppeteer 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) {
     if (Number.isInteger(locator)) {
@@ -3081,7 +3122,7 @@ class Puppeteer 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 = [];
@@ -3128,8 +3169,9 @@ class Puppeteer 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) {
     const waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout;
@@ -3178,6 +3220,7 @@ class Puppeteer extends Helper {
    *   loadEventEnd: 241
    * }
    * ```
+   * @return {Promise<any>} automatically synchronized promise through #recorder 
    */
   async grabDataFromPerformanceTiming() {
     return perfTiming;
@@ -3201,7 +3244,7 @@ class Puppeteer 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
    *