codeceptjs 3.3.1 → 3.3.4

package/docs/build/Playwright.js

@@ -167,7 +167,8 @@ const { createValueEngine, createDisabledEngine } = require('./extras/Playwright
  *      Playwright: {
  *        url: "http://localhost",
  *        chromium: {
- *          browserWSEndpoint: 'ws://localhost:9222/devtools/browser/c5aa6160-b5bc-4d53-bb49-6ecb36cd2e0a'
+ *          browserWSEndpoint: 'ws://localhost:9222/devtools/browser/c5aa6160-b5bc-4d53-bb49-6ecb36cd2e0a',
+ *          cdpConnection: false // default is false
  *        }
  *      }
  *    }
@@ -272,6 +273,7 @@ class Playwright extends Helper {
     this.sessionPages = {};
     this.activeSessionName = '';
     this.isElectron = false;
+    this.isCDPConnection = false;
     this.electronSessions = [];
     this.storageState = null;
 
@@ -347,6 +349,7 @@ class Playwright extends Helper {
     this.isRemoteBrowser = !!this.playwrightOptions.browserWSEndpoint;
     this.isElectron = this.options.browser === 'electron';
     this.userDataDir = this.playwrightOptions.userDataDir;
+    this.isCDPConnection = this.playwrightOptions.cdpConnection;
     popupStore.defaultAction = this.options.defaultPopupAction;
   }
 
@@ -553,8 +556,7 @@ class Playwright extends Helper {
   * ```
   *
   * @param {string} description used to show in logs.
-  * @param {function} fn async function that executed with Playwright helper as argument
-  * @return {Promise<any>}
+  * @param {function} fn async function that executed with Playwright helper as argumen
   */
   usePlaywrightTo(description, fn) {
     return this._useTo(...arguments);
@@ -569,7 +571,6 @@ class Playwright extends Helper {
    * I.click('#triggerPopup');
    * I.acceptPopup();
    * ```
-   * @return {Promise<any>}
    */
   amAcceptingPopups() {
     popupStore.actionType = 'accept';
@@ -579,7 +580,6 @@ class Playwright extends Helper {
    * Accepts the active JavaScript native popup window, as created by window.alert|window.confirm|window.prompt.
    * Don't confuse popups with modal windows, as created by [various
    * libraries](http://jster.net/category/windows-modals-popups).
-   * @return {Promise<any>}
    */
   acceptPopup() {
     popupStore.assertPopupActionType('accept');
@@ -594,7 +594,6 @@ class Playwright extends Helper {
    * I.click('#triggerPopup');
    * I.cancelPopup();
    * ```
-   * @return {Promise<any>}
    */
   amCancellingPopups() {
     popupStore.actionType = 'cancel';
@@ -602,7 +601,6 @@ class Playwright extends Helper {
 
   /**
    * Dismisses the active JavaScript popup, as created by window.alert|window.confirm|window.prompt.
-   * @return {Promise<any>}
    */
   cancelPopup() {
     popupStore.assertPopupActionType('cancel');
@@ -616,7 +614,7 @@ class Playwright extends Helper {
    * I.seeInPopup('Popup text');
    * ```
    * @param {string} text value to check.
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async seeInPopup(text) {
     popupStore.assertPopupVisible();
@@ -627,7 +625,6 @@ class Playwright extends Helper {
   /**
    * Set current page
    * @param {object} page page to set
-   * @return {Promise<any>}
    */
   async _setPage(page) {
     page = await page;
@@ -652,7 +649,6 @@ class Playwright extends Helper {
   /**
    * Add the 'dialog' event listener to a page
    * @page {playwright.Page}
-   * @return {Promise<any>}
    *
    * The popup listener handles the dialog with the predefined action when it appears on the page.
    * It also saves a reference to the object which is used in seeInPopup.
@@ -683,7 +679,6 @@ class Playwright extends Helper {
 
   /**
    * Gets page URL including hash.
-   * @return {Promise<any>}
    */
   async _getPageUrl() {
     return this.executeScript(() => window.location.href);
@@ -707,6 +702,15 @@ class Playwright extends Helper {
   async _startBrowser() {
     if (this.isElectron) {
       this.browser = await playwright._electron.launch(this.playwrightOptions);
+    } else if (this.isRemoteBrowser && this.isCDPConnection) {
+      try {
+        this.browser = await playwright[this.options.browser].connectOverCDP(this.playwrightOptions);
+      } catch (err) {
+        if (err.toString().indexOf('ECONNREFUSED')) {
+          throw new RemoteBrowserConnectionRefused(err);
+        }
+        throw err;
+      }
     } else if (this.isRemoteBrowser) {
       try {
         this.browser = await playwright[this.options.browser].connect(this.playwrightOptions);
@@ -800,7 +804,7 @@ class Playwright extends Helper {
    * ```
    * 
    * @param {string} url url path or global url.
-   * @return {Promise<any>}
+   * @return {void} automatically synchronized promise with recorder #! 
    */
   async amOnPage(url) {
     if (this.isElectron) {
@@ -838,7 +842,7 @@ class Playwright extends Helper {
    * 
    * @param {number} width width in pixels or `maximize`.
    * @param {number} height height in pixels.
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    * Unlike other drivers Playwright changes the size of a viewport, not the window!
    * Playwright does not control the window of a browser so it can't adjust its real size.
@@ -871,7 +875,6 @@ class Playwright extends Helper {
    * ```
    *
    * @param {object} customHeaders headers to set
-   * @return {Promise<any>}
    */
   async haveRequestHeaders(customHeaders) {
     if (!customHeaders) {
@@ -892,7 +895,7 @@ class Playwright 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.
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    */
   async moveCursorTo(locator, offsetX = 0, offsetY = 0) {
@@ -914,7 +917,7 @@ class Playwright extends Helper {
    * 
    * @param {LocatorOrString} srcElement located by CSS|XPath|strict locator.
    * @param {LocatorOrString} destElement located by CSS|XPath|strict locator.
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    * @param {any} [options] [Additional options](https://playwright.dev/docs/api/class-page#page-drag-and-drop) can be passed as 3rd argument.
    *
@@ -938,7 +941,7 @@ class Playwright extends Helper {
    * ```js
    * I.refreshPage();
    * ```
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async refreshPage() {
     return this.page.reload({ timeout: this.options.getPageTimeout, waitUntil: this.options.waitForNavigation });
@@ -950,7 +953,7 @@ class Playwright extends Helper {
    * ```js
    * I.scrollPageToTop();
    * ```
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   scrollPageToTop() {
     return this.executeScript(() => {
@@ -964,7 +967,7 @@ class Playwright extends Helper {
    * ```js
    * I.scrollPageToBottom();
    * ```
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async scrollPageToBottom() {
     return this.executeScript(() => {
@@ -989,7 +992,7 @@ class Playwright 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.
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async scrollTo(locator, offsetX = 0, offsetY = 0) {
     if (typeof locator === 'number' && typeof offsetX === 'number') {
@@ -1018,7 +1021,7 @@ class Playwright extends Helper {
    * ```
    * 
    * @param {string} text text value to check.
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async seeInTitle(text) {
     const title = await this.page.title();
@@ -1056,7 +1059,7 @@ class Playwright extends Helper {
    * ```
    * 
    * @param {string} text value to check.
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async seeTitleEquals(text) {
     const title = await this.page.title();
@@ -1071,7 +1074,7 @@ class Playwright extends Helper {
    * ```
    * 
    * @param {string} text value to check.
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async dontSeeInTitle(text) {
     const title = await this.page.title();
@@ -1099,7 +1102,6 @@ class Playwright extends Helper {
    * ```js
    * const elements = await this.helpers['Playwright']._locate({name: 'password'});
    * ```
-   * @return {Promise<any>}
    */
   async _locate(locator) {
     const context = await this.context || await this._getContext();
@@ -1113,7 +1115,6 @@ class Playwright extends Helper {
    * ```js
    * this.helpers['Playwright']._locateCheckable('I agree with terms and conditions').then // ...
    * ```
-   * @return {Promise<any>}
    */
   async _locateCheckable(locator, providedContext = null) {
     const context = providedContext || await this._getContext();
@@ -1128,7 +1129,6 @@ class Playwright extends Helper {
    * ```js
    * this.helpers['Playwright']._locateClickable('Next page').then // ...
    * ```
-   * @return {Promise<any>}
    */
   async _locateClickable(locator) {
     const context = await this._getContext();
@@ -1141,7 +1141,6 @@ class Playwright extends Helper {
    * ```js
    * this.helpers['Playwright']._locateFields('Your email').then // ...
    * ```
-   * @return {Promise<any>}
    */
   async _locateFields(locator) {
     return findFields.call(this, locator);
@@ -1156,7 +1155,6 @@ class Playwright extends Helper {
    * ```
    *
    * @param {number} [num=1]
-   * @return {Promise<any>}
    */
   async switchToNextTab(num = 1) {
     if (this.isElectron) {
@@ -1171,6 +1169,7 @@ class Playwright extends Helper {
     if (!page) {
       throw new Error(`There is no ability to switch to next tab with offset ${num}`);
     }
+    targetCreatedHandler.call(this, page);
     await this._setPage(page);
     return this._waitForAction();
   }
@@ -1183,7 +1182,6 @@ class Playwright extends Helper {
    * I.switchToPreviousTab(2);
    * ```
    * @param {number} [num=1]
-   * @return {Promise<any>}
    */
   async switchToPreviousTab(num = 1) {
     if (this.isElectron) {
@@ -1208,7 +1206,6 @@ class Playwright extends Helper {
    * ```js
    * I.closeCurrentTab();
    * ```
-   * @return {Promise<any>}
    */
   async closeCurrentTab() {
     if (this.isElectron) {
@@ -1226,7 +1223,6 @@ class Playwright extends Helper {
    * ```js
    * I.closeOtherTabs();
    * ```
-   * @return {Promise<any>}
    */
   async closeOtherTabs() {
     const pages = await this.browserContext.pages();
@@ -1251,13 +1247,14 @@ class Playwright extends Helper {
    * // enable mobile
    * I.openNewTab({ isMobile: true });
    * ```
-   * @return {Promise<any>}
    */
   async openNewTab(options) {
     if (this.isElectron) {
       throw new Error('Cannot open new tabs inside an Electron container');
     }
-    await this._setPage(await this.browserContext.newPage(options));
+    const page = await this.browserContext.newPage(options);
+    targetCreatedHandler.call(this, page);
+    await this._setPage(page);
     return this._waitForAction();
   }
 
@@ -1285,7 +1282,7 @@ class Playwright extends Helper {
    * I.seeElement('#modal');
    * ```
    * @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    */
   async seeElement(locator) {
@@ -1302,7 +1299,7 @@ class Playwright extends Helper {
    * ```
    * 
    * @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|Strict locator.
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    */
   async dontSeeElement(locator) {
@@ -1319,7 +1316,7 @@ class Playwright extends Helper {
    * I.seeElementInDOM('#modal');
    * ```
    * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async seeElementInDOM(locator) {
     const els = await this._locate(locator);
@@ -1334,7 +1331,7 @@ class Playwright extends Helper {
    * ```
    * 
    * @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|Strict locator.
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async dontSeeElementInDOM(locator) {
     const els = await this._locate(locator);
@@ -1397,7 +1394,7 @@ class Playwright 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 | null} [context=null] (optional, `null` by default) element to search in CSS|XPath|Strict locator.
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    * 
    *
    * @param {any} [opts] [Additional options](https://playwright.dev/docs/api/class-page#page-click) for click available as 3rd argument.
@@ -1419,7 +1416,6 @@ class Playwright extends Helper {
 
   /**
    * Clicks link and waits for navigation (deprecated)
-   * @return {Promise<any>}
    */
   async clickLink(locator, context = null) {
     console.log('clickLink deprecated: Playwright automatically waits for navigation to happen.');
@@ -1455,7 +1451,7 @@ class Playwright 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.
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    * 
    */
   async forceClick(locator, context = null) {
@@ -1475,7 +1471,7 @@ class Playwright 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.
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    *
    */
@@ -1497,7 +1493,7 @@ class Playwright 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.
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    *
    */
@@ -1518,7 +1514,7 @@ class Playwright 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.
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    * [Additional options](https://playwright.dev/docs/api/class-elementhandle#element-handle-check) for check available as 3rd argument.
    *
@@ -1549,7 +1545,7 @@ class Playwright 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.
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    * [Additional options](https://playwright.dev/docs/api/class-elementhandle#element-handle-uncheck) for uncheck available as 3rd argument.
    *
@@ -1577,7 +1573,7 @@ class Playwright extends Helper {
    * ```
    * 
    * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async seeCheckboxIsChecked(field) {
     return proceedIsChecked.call(this, 'assert', field);
@@ -1593,7 +1589,7 @@ class Playwright extends Helper {
    * ```
    * 
    * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async dontSeeCheckboxIsChecked(field) {
     return proceedIsChecked.call(this, 'negate', field);
@@ -1611,7 +1607,7 @@ class Playwright extends Helper {
    * ```
    * 
    * @param {string} key name of key to press down.
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async pressKeyDown(key) {
     key = getNormalizedKey.call(this, key);
@@ -1631,7 +1627,7 @@ class Playwright extends Helper {
    * ```
    * 
    * @param {string} key name of key to release.
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async pressKeyUp(key) {
     key = getNormalizedKey.call(this, key);
@@ -1699,7 +1695,7 @@ class Playwright extends Helper {
    * - `'Tab'`
    * 
    * @param {string|string[]} key key or array of keys to press.
-   * @return {Promise<any>}
+   * [!] 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)).
@@ -1747,7 +1743,7 @@ class Playwright extends Helper {
    * 
    * @param {string|string[]} key or array of keys to type.
    * @param {?number} [delay=null] (optional) delay in ms between key presses
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async type(keys, delay = null) {
     if (!Array.isArray(keys)) {
@@ -1776,7 +1772,7 @@ class Playwright extends Helper {
    * ```
    * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
    * @param {CodeceptJS.StringOrSecret} value text value to fill.
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    */
   async fillField(field, value) {
@@ -1803,7 +1799,7 @@ class Playwright extends Helper {
    * I.clearField('#email');
    * ```
    * @param {LocatorOrString} editable field located by label|name|CSS|XPath|strict locator.
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async clearField(field) {
     return this.fillField(field, '');
@@ -1818,7 +1814,7 @@ class Playwright extends Helper {
    * ```
    * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator
    * @param {string} value text value to append.
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    *
    */
@@ -1842,7 +1838,7 @@ class Playwright extends Helper {
    * ```
    * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
    * @param {string} value value to check.
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async seeInField(field, value) {
     return proceedSeeInField.call(this, 'assert', field, value);
@@ -1859,7 +1855,7 @@ class Playwright extends Helper {
    * 
    * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
    * @param {string} value value to check.
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async dontSeeInField(field, value) {
     return proceedSeeInField.call(this, 'negate', field, value);
@@ -1877,7 +1873,7 @@ class Playwright 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.
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    */
   async attachFile(locator, pathToFile) {
@@ -1913,7 +1909,7 @@ class Playwright extends Helper {
    * ```
    * @param {LocatorOrString} select field located by label|name|CSS|XPath|strict locator.
    * @param {string|Array<*>} option visible text or value of option.
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async selectOption(select, option) {
     const els = await findFields.call(this, select);
@@ -1970,7 +1966,7 @@ class Playwright extends Helper {
    * ```
    * 
    * @param {string} url a fragment to check
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async seeInCurrentUrl(url) {
     stringIncludes('url').assert(url, await this._getPageUrl());
@@ -1980,7 +1976,7 @@ class Playwright extends Helper {
    * Checks that current url does not contain a provided fragment.
    * 
    * @param {string} url value to check.
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async dontSeeInCurrentUrl(url) {
     stringIncludes('url').negate(url, await this._getPageUrl());
@@ -1997,7 +1993,7 @@ class Playwright extends Helper {
    * ```
    * 
    * @param {string} url value to check.
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async seeCurrentUrlEquals(url) {
     urlEquals(this.options.url).assert(url, await this._getPageUrl());
@@ -2013,7 +2009,7 @@ class Playwright extends Helper {
    * ```
    * 
    * @param {string} url value to check.
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async dontSeeCurrentUrlEquals(url) {
     urlEquals(this.options.url).negate(url, await this._getPageUrl());
@@ -2030,7 +2026,7 @@ class Playwright 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.
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    *
    */
@@ -2047,7 +2043,7 @@ class Playwright extends Helper {
    * 
    * @param {string} text element value to check.
    * @param {CodeceptJS.LocatorOrString?} [context=null]  element located by CSS|XPath|strict locator.
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async seeTextEquals(text, context = null) {
     return proceedSee.call(this, 'assert', text, context, true);
@@ -2064,7 +2060,7 @@ class Playwright 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.
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    *
    */
@@ -2090,9 +2086,11 @@ class Playwright extends Helper {
    * Get JS log from browser.
    *
    * ```js
-   * let logs = await I.grabBrowserLogs();
-   * console.log(JSON.stringify(logs))
+   * const logs = await I.grabBrowserLogs();
+   * const errors = logs.map(l => ({ type: l.type(), text: l.text() })).filter(l => l.type === 'error');
+   * console.log(JSON.stringify(errors));
    * ```
+   * [Learn more about console messages](https://playwright.dev/docs/api/class-consolemessage)
    * @return {Promise<any[]>}
    */
   async grabBrowserLogs() {
@@ -2123,7 +2121,7 @@ class Playwright extends Helper {
    * I.seeInSource('<h1>Green eggs &amp; ham</h1>');
    * ```
    * @param {string} text value to check.
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async seeInSource(text) {
     const source = await this.page.content();
@@ -2138,7 +2136,7 @@ class Playwright extends Helper {
    * ```
    * 
    * @param {string} value to check.
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async dontSeeInSource(text) {
     const source = await this.page.content();
@@ -2156,7 +2154,7 @@ class Playwright extends Helper {
    * 
    * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
    * @param {number} num number of elements.
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    *
    */
@@ -2175,7 +2173,7 @@ class Playwright extends Helper {
    * 
    * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
    * @param {number} num number of elements.
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    *
    */
@@ -2200,7 +2198,7 @@ class Playwright extends Helper {
    * ```
    * 
    * @param {Cookie|Array<Cookie>} cookie a cookie object or array of cookie objects.
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async setCookie(cookie) {
     if (Array.isArray(cookie)) {
@@ -2217,7 +2215,7 @@ class Playwright extends Helper {
    * ```
    * 
    * @param {string} name cookie name.
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    */
   async seeCookie(name) {
@@ -2233,7 +2231,7 @@ class Playwright extends Helper {
    * ```
    * 
    * @param {string} name cookie name.
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async dontSeeCookie(name) {
     const cookies = await this.browserContext.cookies();
@@ -2273,7 +2271,7 @@ class Playwright extends Helper {
    * ```
    * 
    * @param {?string} [cookie=null] (optional, `null` by default) cookie name
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async clearCookie() {
     // Playwright currently doesn't support to delete a certain cookie
@@ -2304,7 +2302,6 @@ class Playwright extends Helper {
    *
    * @param {string|function} fn function to be executed in browser context.
    * @param {any} [arg] optional argument to pass to the function
-   * @return {Promise<any>}
    */
   async executeScript(fn, arg) {
     let context = this.page;
@@ -2502,7 +2499,7 @@ class Playwright extends Helper {
    * 
    * @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
    * @param {object} cssProperties object with CSS properties and their values to check.
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    */
   async seeCssPropertiesOnElements(locator, cssProperties) {
@@ -2548,7 +2545,7 @@ class Playwright extends Helper {
    * 
    * @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
    * @param {object} attributes attributes and their values to check.
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    */
   async seeAttributesOnElements(locator, attributes) {
@@ -2587,7 +2584,7 @@ class Playwright extends Helper {
    * 
    * @param {CodeceptJS.LocatorOrString} locator located by label|name|CSS|XPath|strict locator.
    * @param {number} offsetX position to drag.
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    */
   async dragSlider(locator, offsetX = 0) {
@@ -2665,7 +2662,7 @@ class Playwright extends Helper {
    * 
    * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
    * @param {string} fileName file name to save.
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    */
   async saveElementScreenshot(locator, fileName) {
@@ -2691,7 +2688,7 @@ class Playwright extends Helper {
    * 
    * @param {string} fileName file name to save.
    * @param {boolean} [fullPage=false] (optional, `false` by default) flag to enable fullscreen screenshot mode.
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async saveScreenshot(fileName, fullPage) {
     const fullPageOption = fullPage || this.options.fullPageScreenshots;
@@ -2807,7 +2804,7 @@ class Playwright extends Helper {
    * ```
    * 
    * @param {number} sec number of second to wait.
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async wait(sec) {
     return new Promise(((done) => {
@@ -2821,7 +2818,7 @@ class Playwright 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.
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async waitForEnabled(locator, sec) {
     const waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout;
@@ -2856,7 +2853,7 @@ class Playwright 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
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async waitForValue(field, value, sec) {
     const waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout;
@@ -2892,7 +2889,7 @@ class Playwright 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
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    */
   async waitNumberOfVisibleElements(locator, num, sec) {
@@ -2933,7 +2930,7 @@ class Playwright 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
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async waitForClickable(locator, waitTimeout) {
     console.log('I.waitForClickable is DEPRECATED: This is no longer needed, Playwright automatically waits for element to be clickable');
@@ -2951,7 +2948,7 @@ class Playwright 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
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    */
   async waitForElement(locator, sec) {
@@ -2975,7 +2972,7 @@ class Playwright 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
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    * This method accepts [React selectors](https://codecept.io/react).
    */
@@ -2999,7 +2996,7 @@ class Playwright 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
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async waitForInvisible(locator, sec) {
     const waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout;
@@ -3021,7 +3018,7 @@ class Playwright 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
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async waitToHide(locator, sec) {
     const waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout;
@@ -3048,7 +3045,7 @@ class Playwright extends Helper {
    * 
    * @param {string} urlPart value to check.
    * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async waitInUrl(urlPart, sec = null) {
     const waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout;
@@ -3076,7 +3073,7 @@ class Playwright extends Helper {
    * 
    * @param {string} urlPart value to check.
    * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async waitUrlEquals(urlPart, sec = null) {
     const waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout;
@@ -3112,7 +3109,7 @@ class Playwright 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.
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async waitForText(text, sec = null, context = null) {
     const waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout;
@@ -3152,7 +3149,6 @@ class Playwright extends Helper {
    *
    * @param {string|function} urlOrPredicate
    * @param {?number} [sec=null] seconds to wait
-   * @return {Promise<any>}
    */
   async waitForRequest(urlOrPredicate, sec = null) {
     const timeout = sec ? sec * 1000 : this.options.waitForTimeout;
@@ -3169,7 +3165,6 @@ class Playwright extends Helper {
    *
    * @param {string|function} urlOrPredicate
    * @param {?number} [sec=null] number of seconds to wait
-   * @return {Promise<any>}
    */
   async waitForResponse(urlOrPredicate, sec = null) {
     const timeout = sec ? sec * 1000 : this.options.waitForTimeout;
@@ -3185,7 +3180,7 @@ class Playwright extends Helper {
    * ```
    * 
    * @param {?CodeceptJS.LocatorOrString} [locator=null] (optional, `null` by default) element located by CSS|XPath|strict locator.
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async switchTo(locator) {
     if (Number.isInteger(locator)) {
@@ -3243,7 +3238,7 @@ class Playwright 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
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async waitForFunction(fn, argsOrSec = null, sec = null) {
     let args = [];
@@ -3265,7 +3260,6 @@ class Playwright extends Helper {
    * See [Playwright's reference](https://playwright.dev/docs/api/class-page?_highlight=waitfornavi#pagewaitfornavigationoptions)
    *
    * @param {*} opts
-   * @return {Promise<any>}
    */
   async waitForNavigation(opts = {}) {
     opts = {
@@ -3293,7 +3287,7 @@ class Playwright 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
-   * @return {Promise<any>}
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async waitForDetached(locator, sec) {
     const waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout;
@@ -3339,7 +3333,7 @@ class Playwright extends Helper {
    *   loadEventEnd: 241
    * }
    * ```
-   * @return {Promise<any>}
+   * @return {Promise<any>} automatically synchronized promise through #recorder 
    */
   async grabDataFromPerformanceTiming() {
     return perfTiming;
@@ -3385,8 +3379,7 @@ class Playwright extends Helper {
   * This method allows intercepting and mocking requests & responses. [Learn more about it](https://playwright.dev/docs/network#handle-requests)
   *
   * @param {string|RegExp} [url] URL, regex or pattern for to match URL
-  * @param {function} [handler] a function to process request
-  * @return {Promise<any>}
+  * @param {function} [handler] a function to process reques
   */
   async mockRoute(url, handler) {
     return this.browserContext.route(...arguments);
@@ -3402,8 +3395,7 @@ class Playwright extends Helper {
   * If no handler is passed, all mock requests for the rote are disabled.
   *
   * @param {string|RegExp} [url] URL, regex or pattern for to match URL
-  * @param {function} [handler] a function to process request
-  * @return {Promise<any>}
+  * @param {function} [handler] a function to process reques
   */
   async stopMockingRoute(url, handler) {
     return this.browserContext.unroute(...arguments);