codeceptjs 3.5.5 → 3.5.7-beta.1

package/docs/helpers/Playwright.md

@@ -45,7 +45,7 @@ Type: [object][5]
 -   `restart` **([string][8] | [boolean][32])?** restart strategy between tests. Possible values:-   'context' or **false** - restarts [browser context][40] but keeps running browser. Recommended by Playwright team to keep tests isolated.
     -   'browser' or **true** - closes browser and opens it again between tests.
     -   'session' or 'keep' - keeps browser context and session, but cleans up cookies and localStorage between tests. The fastest option when running tests in windowed mode. Works with `keepCookies` and `keepBrowserState` options. This behavior was default before CodeceptJS 3.1
--   `timeout` **[number][19]?** -   [timeout][41] in ms of all Playwright actions .
+-   `timeout` **[number][20]?** -   [timeout][41] in ms of all Playwright actions .
 -   `disableScreenshots` **[boolean][32]?** don't save screenshot on failure.
 -   `emulate` **any?** browser in device emulation mode.
 -   `video` **[boolean][32]?** enables video recording for failed tests; videos are saved into `output/videos` folder
@@ -56,11 +56,11 @@ Type: [object][5]
 -   `uniqueScreenshotNames` **[boolean][32]?** option to prevent screenshot override if you have scenarios with the same name in different suites.
 -   `keepBrowserState` **[boolean][32]?** keep browser state between tests when `restart` is set to 'session'.
 -   `keepCookies` **[boolean][32]?** keep cookies between tests when `restart` is set to 'session'.
--   `waitForAction` **[number][19]?** how long to wait after click, doubleClick or PressKey actions in ms. Default: 100.
+-   `waitForAction` **[number][20]?** how long to wait after click, doubleClick or PressKey actions in ms. Default: 100.
 -   `waitForNavigation` **(`"load"` | `"domcontentloaded"` | `"commit"`)?** When to consider navigation succeeded. Possible options: `load`, `domcontentloaded`, `commit`. Choose one of those options is possible. See [Playwright API][38].
--   `pressKeyDelay` **[number][19]?** Delay between key presses in ms. Used when calling Playwrights page.type(...) in fillField/appendField
--   `getPageTimeout` **[number][19]?** config option to set maximum navigation time in milliseconds.
--   `waitForTimeout` **[number][19]?** default wait* timeout in ms. Default: 1000.
+-   `pressKeyDelay` **[number][20]?** Delay between key presses in ms. Used when calling Playwrights page.type(...) in fillField/appendField
+-   `getPageTimeout` **[number][20]?** config option to set maximum navigation time in milliseconds.
+-   `waitForTimeout` **[number][20]?** default wait* timeout in ms. Default: 1000.
 -   `basicAuth` **[object][5]?** the basic authentication to pass to base url. Example: {username: 'username', password: 'password'}
 -   `windowSize` **[string][8]?** default window size. Set a dimension like `640x480`.
 -   `colorScheme` **(`"dark"` | `"light"` | `"no-preference"`)?** default color scheme. Possible values: `dark` | `light` | `no-preference`.
@@ -71,10 +71,10 @@ Type: [object][5]
 -   `firefox` **[object][5]?** pass additional firefox options
 -   `electron` **[object][5]?** (pass additional electron options
 -   `channel` **any?** (While Playwright can operate against the stock Google Chrome and Microsoft Edge browsers available on the machine. In particular, current Playwright version will support Stable and Beta channels of these browsers. See [Google Chrome & Microsoft Edge][43].
--   `ignoreLog` **[Array][9]<[string][8]>?** An array with console message types that are not logged to debug log. Default value is `['warning', 'log']`. E.g. you can set `[]` to log all messages. See all possible [values][44].
+-   `ignoreLog` **[Array][10]<[string][8]>?** An array with console message types that are not logged to debug log. Default value is `['warning', 'log']`. E.g. you can set `[]` to log all messages. See all possible [values][44].
 -   `ignoreHTTPSErrors` **[boolean][32]?** Allows access to untrustworthy pages, e.g. to a page with an expired certificate. Default value is `false`
 -   `bypassCSP` **[boolean][32]?** bypass Content Security Policy or CSP
--   `highlightElement` **[boolean][32]?** highlight the interacting elements. Default: false
+-   `highlightElement` **[boolean][32]?** highlight the interacting elements. Default: false. Note: only activate under verbose mode (--verbose).
 
 
 
@@ -400,7 +400,7 @@ I.amOnPage('/login'); // opens a login page
 
 -   `url` **[string][8]** url path or global url.
 
-Returns **void** automatically synchronized promise with recorder #!
+Returns **[Promise][9]<void>** automatically synchronized promise through #recorder
 
 ### appendField
 
@@ -417,7 +417,8 @@ I.appendField('password', secret('123456'));
 
 -   `field` **([string][8] | [object][5])** located by label|name|CSS|XPath|strict locator
 -   `value` **[string][8]** text value to append.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
+
+Returns **[Promise][9]<void>** automatically synchronized promise through #recorder
 
 ### attachFile
 
@@ -434,7 +435,8 @@ I.attachFile('form input[name=avatar]', 'data/avatar.jpg');
 
 -   `locator` **([string][8] | [object][5])** field located by label|name|CSS|XPath|strict locator.
 -   `pathToFile` **[string][8]** local file path relative to codecept.conf.ts or codecept.conf.js config file.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
+
+Returns **[Promise][9]<void>** automatically synchronized promise through #recorder
 
 ### blockTraffic
 
@@ -455,12 +457,12 @@ I.blockTraffic(['http://example.com/css/style.css', 'http://example.com/css/*.cs
 
 #### Parameters
 
--   `urls` **([string][8] | [Array][9] | [RegExp][10])** URL or a list of URLs to block . URL can contain * for wildcards. Example: [https://www.example.com**][11] to block all traffic for that domain. Regexp are also supported.
+-   `urls` **([string][8] | [Array][10] | [RegExp][11])** URL or a list of URLs to block . URL can contain * for wildcards. Example: [https://www.example.com**][12] to block all traffic for that domain. Regexp are also supported.
 
 ### blur
 
 Remove focus from a text input, button, etc.
-Calls [blur][12] on the element.
+Calls [blur][13] on the element.
 
 Examples:
 
@@ -478,7 +480,9 @@ I.dontSee('#add-to-cart-btn');
 #### Parameters
 
 -   `locator` **([string][8] | [object][5])** field located by label|name|CSS|XPath|strict locator.
--   `options` **any?** Playwright only: [Additional options][13] for available options object as 2nd argument. 
+-   `options` **any?** Playwright only: [Additional options][14] for available options object as 2nd argument. 
+
+Returns **[Promise][9]<void>** automatically synchronized promise through #recorder
 
 ### cancelPopup
 
@@ -500,13 +504,14 @@ I.checkOption('agree', '//form');
 #### Parameters
 
 -   `field` **([string][8] | [object][5])** checkbox located by label | name | CSS | XPath | strict locator.
--   `context` **([string][8]? | [object][5])** (optional, `null` by default) element located by CSS | XPath | strict locator.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder[Additional options][14] for check available as 3rd argument.Examples:```js
-    // click on element at position
-    I.checkOption('Agree', '.signup', { position: { x: 5, y: 5 } })
-    ```> ⚠️ To avoid flakiness, option `force: true` is set by default 
+-   `context` **([string][8]? | [object][5])** (optional, `null` by default) element located by CSS | XPath | strict locator. 
 -   `options`   
 
+Returns **[Promise][9]<void>** automatically synchronized promise through #recorder[Additional options][15] for check available as 3rd argument.Examples:```js
+// click on element at position
+I.checkOption('Agree', '.signup', { position: { x: 5, y: 5 } })
+```> ⚠️ To avoid flakiness, option `force: true` is set by default
+
 ### clearCookie
 
 Clears a cookie by name,
@@ -519,8 +524,9 @@ I.clearCookie('test');
 
 #### Parameters
 
--   `cookie` **[string][8]?** (optional, `null` by default) cookie name
-    ⚠️ returns a _promise_ which is synchronized internally by recorder 
+-   `cookie` **[string][8]?** (optional, `null` by default) cookie name 
+
+Returns **[Promise][9]<void>** automatically synchronized promise through #recorder
 
 ### clearField
 
@@ -535,12 +541,12 @@ I.clearField('.text-area')
 I.clearField('#submit', { force: true })
 ```
 
-Use `force` to bypass the [actionability][15] checks.
+Use `force` to bypass the [actionability][16] checks.
 
 #### Parameters
 
 -   `locator` **([string][8] | [object][5])** field located by label|name|CSS|XPath|strict locator.
--   `options` **any?** [Additional options][16] for available options object as 2nd argument. 
+-   `options` **any?** [Additional options][17] for available options object as 2nd argument. 
 
 ### click
 
@@ -569,9 +575,8 @@ I.click({css: 'nav a.login'});
 #### Parameters
 
 -   `locator` **([string][8] | [object][5])** clickable link or button located by text, or any element located by CSS|XPath|strict locator.
--   `context` **([string][8]? | [object][5] | null)** (optional, `null` by default) element to search in CSS|XPath|Strict locator.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder 
--   `options` **any?** [Additional options][17] for click available as 3rd argument.Examples:```js
+-   `context` **([string][8]? | [object][5] | null)** (optional, `null` by default) element to search in CSS|XPath|Strict locator. 
+-   `options` **any?** [Additional options][18] for click available as 3rd argument.Examples:```js
     // click on element at position
     I.click('canvas', '.model', { position: { x: 20, y: 40 } })
 
@@ -579,6 +584,8 @@ I.click({css: 'nav a.login'});
     I.click('.edit', null, { modifiers: ['Ctrl'] } )
     ``` 
 
+Returns **[Promise][9]<void>** automatically synchronized promise through #recorder
+
 ### clickLink
 
 Clicks link and waits for navigation (deprecated)
@@ -617,8 +624,9 @@ I.dontSee('Login', '.nav'); // no login inside .nav element
 #### Parameters
 
 -   `text` **[string][8]** which is not present.
--   `context` **([string][8] | [object][5])?** (optional) element located by CSS|XPath|strict locator in which to perfrom search.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder 
+-   `context` **([string][8] | [object][5])?** (optional) element located by CSS|XPath|strict locator in which to perfrom search. 
+
+Returns **[Promise][9]<void>** automatically synchronized promise through #recorder
 
 ### dontSeeCheckboxIsChecked
 
@@ -633,7 +641,8 @@ I.dontSeeCheckboxIsChecked('agree'); // located by name
 #### Parameters
 
 -   `field` **([string][8] | [object][5])** located by label|name|CSS|XPath|strict locator.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
+
+Returns **[Promise][9]<void>** automatically synchronized promise through #recorder
 
 ### dontSeeCookie
 
@@ -646,7 +655,8 @@ I.dontSeeCookie('auth'); // no auth cookie
 #### Parameters
 
 -   `name` **[string][8]** cookie name.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
+
+Returns **[Promise][9]<void>** automatically synchronized promise through #recorder
 
 ### dontSeeCurrentUrlEquals
 
@@ -661,7 +671,8 @@ I.dontSeeCurrentUrlEquals('http://mysite.com/login'); // absolute urls are also
 #### Parameters
 
 -   `url` **[string][8]** value to check.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
+
+Returns **[Promise][9]<void>** automatically synchronized promise through #recorder
 
 ### dontSeeElement
 
@@ -674,7 +685,8 @@ I.dontSeeElement('.modal'); // modal is not shown
 #### Parameters
 
 -   `locator` **([string][8] | [object][5])** located by CSS|XPath|Strict locator.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
+
+Returns **[Promise][9]<void>** automatically synchronized promise through #recorder
 
 ### dontSeeElementInDOM
 
@@ -687,7 +699,8 @@ I.dontSeeElementInDOM('.nav'); // checks that element is not on page visible or
 #### Parameters
 
 -   `locator` **([string][8] | [object][5])** located by CSS|XPath|Strict locator.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
+
+Returns **[Promise][9]<void>** automatically synchronized promise through #recorder
 
 ### dontSeeInCurrentUrl
 
@@ -696,7 +709,8 @@ Checks that current url does not contain a provided fragment.
 #### Parameters
 
 -   `url` **[string][8]** value to check.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
+
+Returns **[Promise][9]<void>** automatically synchronized promise through #recorder
 
 ### dontSeeInField
 
@@ -712,7 +726,8 @@ I.dontSeeInField({ css: 'form input.email' }, 'user@user.com'); // field by CSS
 
 -   `field` **([string][8] | [object][5])** located by label|name|CSS|XPath|strict locator.
 -   `value` **([string][8] | [object][5])** value to check.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
+
+Returns **[Promise][9]<void>** automatically synchronized promise through #recorder
 
 ### dontSeeInSource
 
@@ -726,7 +741,8 @@ I.dontSeeInSource('<!--'); // no comments in source
 
 -   `text`  
 -   `value` **[string][8]** to check.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
+
+Returns **[Promise][9]&lt;void>** automatically synchronized promise through #recorder
 
 ### dontSeeInTitle
 
@@ -739,7 +755,8 @@ I.dontSeeInTitle('Error');
 #### Parameters
 
 -   `text` **[string][8]** value to check.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
+
+Returns **[Promise][9]&lt;void>** automatically synchronized promise through #recorder
 
 ### dontSeeTraffic
 
@@ -756,7 +773,7 @@ I.dontSeeTraffic({ name: 'Unexpected API Call of "user" endpoint', url: /api.exa
 
 -   `opts` **[Object][5]** options when checking the traffic network.
     -   `opts.name` **[string][8]** A name of that request. Can be any value. Only relevant to have a more meaningful error message in case of fail.
-    -   `opts.url` **([string][8] | [RegExp][10])** Expected URL of request in network traffic. Can be a string or a regular expression.
+    -   `opts.url` **([string][8] | [RegExp][11])** Expected URL of request in network traffic. Can be a string or a regular expression.
 
 ### doubleClick
 
@@ -773,8 +790,9 @@ I.doubleClick('.btn.edit');
 #### Parameters
 
 -   `locator` **([string][8] | [object][5])** clickable link or button located by text, or any element located by CSS|XPath|strict locator.
--   `context` **([string][8]? | [object][5])** (optional, `null` by default) element to search in CSS|XPath|Strict locator.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder 
+-   `context` **([string][8]? | [object][5])** (optional, `null` by default) element to search in CSS|XPath|Strict locator. 
+
+Returns **[Promise][9]&lt;void>** automatically synchronized promise through #recorder
 
 ### dragAndDrop
 
@@ -788,12 +806,13 @@ I.dragAndDrop('#dragHandle', '#container');
 
 -   `srcElement` **([string][8] | [object][5])** located by CSS|XPath|strict locator.
 -   `destElement` **([string][8] | [object][5])** located by CSS|XPath|strict locator.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
--   `options` **any?** [Additional options][18] can be passed as 3rd argument.```js
+-   `options` **any?** [Additional options][19] can be passed as 3rd argument.```js
     // specify coordinates for source position
     I.dragAndDrop('img.src', 'img.dst', { sourcePosition: {x: 10, y: 10} })
     ```> When no option is set, custom drag and drop would be used, to use the dragAndDrop API from Playwright, please set options, for example `force: true`
 
+Returns **[Promise][9]&lt;void>** automatically synchronized promise through #recorder
+
 ### dragSlider
 
 Drag the scrubber of a slider to a given position
@@ -807,8 +826,9 @@ I.dragSlider('#slider', -70);
 #### Parameters
 
 -   `locator` **([string][8] | [object][5])** located by label|name|CSS|XPath|strict locator.
--   `offsetX` **[number][19]** position to drag.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder 
+-   `offsetX` **[number][20]** position to drag. 
+
+Returns **[Promise][9]&lt;void>** automatically synchronized promise through #recorder
 
 ### executeScript
 
@@ -835,10 +855,10 @@ If a function returns a Promise it will wait for its resolution.
 
 #### Parameters
 
--   `fn` **([string][8] | [function][20])** function to be executed in browser context.
+-   `fn` **([string][8] | [function][21])** function to be executed in browser context.
 -   `arg` **any?** optional argument to pass to the function
 
-Returns **[Promise][21]&lt;any>** 
+Returns **[Promise][9]&lt;any>** 
 
 ### fillField
 
@@ -860,7 +880,8 @@ I.fillField({css: 'form#login input[name=username]'}, 'John');
 
 -   `field` **([string][8] | [object][5])** located by label|name|CSS|XPath|strict locator.
 -   `value` **([string][8] | [object][5])** text value to fill.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
+
+Returns **[Promise][9]&lt;void>** automatically synchronized promise through #recorder
 
 ### flushNetworkTraffics
 
@@ -872,7 +893,7 @@ Resets all recorded WS messages.
 
 ### focus
 
-Calls [focus][12] on the matching element.
+Calls [focus][13] on the matching element.
 
 Examples:
 
@@ -887,6 +908,8 @@ I.see('#add-to-cart-bnt');
 -   `locator` **([string][8] | [object][5])** field located by label|name|CSS|XPath|strict locator.
 -   `options` **any?** Playwright only: [Additional options][22] for available options object as 2nd argument. 
 
+Returns **[Promise][9]&lt;void>** automatically synchronized promise through #recorder
+
 ### forceClick
 
 Perform an emulated click on a link or a button, given by a locator.
@@ -917,8 +940,9 @@ I.forceClick({css: 'nav a.login'});
 #### Parameters
 
 -   `locator` **([string][8] | [object][5])** clickable link or button located by text, or any element located by CSS|XPath|strict locator.
--   `context` **([string][8]? | [object][5])** (optional, `null` by default) element to search in CSS|XPath|Strict locator.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder 
+-   `context` **([string][8]? | [object][5])** (optional, `null` by default) element to search in CSS|XPath|Strict locator. 
+
+Returns **[Promise][9]&lt;void>** automatically synchronized promise through #recorder
 
 ### grabAttributeFrom
 
@@ -935,7 +959,7 @@ let hint = await I.grabAttributeFrom('#tooltip', 'title');
 -   `locator` **([string][8] | [object][5])** element located by CSS|XPath|strict locator.
 -   `attr` **[string][8]** attribute name.
 
-Returns **[Promise][21]&lt;[string][8]>** attribute value
+Returns **[Promise][9]&lt;[string][8]>** attribute value
 
 ### grabAttributeFromAll
 
@@ -951,7 +975,7 @@ let hints = await I.grabAttributeFromAll('.tooltip', 'title');
 -   `locator` **([string][8] | [object][5])** element located by CSS|XPath|strict locator.
 -   `attr` **[string][8]** attribute name.
 
-Returns **[Promise][21]&lt;[Array][9]&lt;[string][8]>>** attribute value
+Returns **[Promise][9]&lt;[Array][10]&lt;[string][8]>>** attribute value
 
 ### grabBrowserLogs
 
@@ -965,7 +989,7 @@ console.log(JSON.stringify(errors));
 
 [Learn more about console messages][23]
 
-Returns **[Promise][21]&lt;[Array][9]&lt;any>>** 
+Returns **[Promise][9]&lt;[Array][10]&lt;any>>** 
 
 ### grabCookie
 
@@ -982,7 +1006,7 @@ assert(cookie.value, '123456');
 
 -   `name` **[string][8]?** cookie name. 
 
-Returns **([Promise][21]&lt;[string][8]> | [Promise][21]&lt;[Array][9]&lt;[string][8]>>)** attribute valueReturns cookie in JSON format. If name not passed returns all cookies for this domain.
+Returns **any** attribute valueReturns cookie in JSON format. If name not passed returns all cookies for this domain.
 
 ### grabCssPropertyFrom
 
@@ -999,7 +1023,7 @@ const value = await I.grabCssPropertyFrom('h3', 'font-weight');
 -   `locator` **([string][8] | [object][5])** element located by CSS|XPath|strict locator.
 -   `cssProperty` **[string][8]** CSS property name.
 
-Returns **[Promise][21]&lt;[string][8]>** CSS value
+Returns **[Promise][9]&lt;[string][8]>** CSS value
 
 ### grabCssPropertyFromAll
 
@@ -1015,7 +1039,7 @@ const values = await I.grabCssPropertyFromAll('h3', 'font-weight');
 -   `locator` **([string][8] | [object][5])** element located by CSS|XPath|strict locator.
 -   `cssProperty` **[string][8]** CSS property name.
 
-Returns **[Promise][21]&lt;[Array][9]&lt;[string][8]>>** CSS value
+Returns **[Promise][9]&lt;[Array][10]&lt;[string][8]>>** CSS value
 
 ### grabCurrentUrl
 
@@ -1027,7 +1051,7 @@ let url = await I.grabCurrentUrl();
 console.log(`Current URL is [${url}]`);
 ```
 
-Returns **[Promise][21]&lt;[string][8]>** current URL
+Returns **[Promise][9]&lt;[string][8]>** current URL
 
 ### grabDataFromPerformanceTiming
 
@@ -1052,7 +1076,7 @@ let data = await I.grabDataFromPerformanceTiming();
 }
 ```
 
-Returns **[Promise][21]&lt;any>** automatically synchronized promise through #recorder
+Returns **[Promise][9]&lt;void>** automatically synchronized promise through #recorder
 
 ### grabElementBoundingRect
 
@@ -1080,7 +1104,7 @@ const width = await I.grabElementBoundingRect('h3', 'width');
 -   `prop`  
 -   `elementSize` **[string][8]?** x, y, width or height of the given element.
 
-Returns **([Promise][21]&lt;DOMRect> | [Promise][21]&lt;[number][19]>)** Element bounding rectangle
+Returns **([Promise][9]&lt;DOMRect> | [Promise][9]&lt;[number][20]>)** Element bounding rectangle
 
 ### grabHTMLFrom
 
@@ -1097,7 +1121,7 @@ let postHTML = await I.grabHTMLFrom('#post');
 -   `locator`  
 -   `element` **([string][8] | [object][5])** located by CSS|XPath|strict locator.
 
-Returns **[Promise][21]&lt;[string][8]>** HTML code for an element
+Returns **[Promise][9]&lt;[string][8]>** HTML code for an element
 
 ### grabHTMLFromAll
 
@@ -1113,7 +1137,7 @@ let postHTMLs = await I.grabHTMLFromAll('.post');
 -   `locator`  
 -   `element` **([string][8] | [object][5])** located by CSS|XPath|strict locator.
 
-Returns **[Promise][21]&lt;[Array][9]&lt;[string][8]>>** HTML code for an element
+Returns **[Promise][9]&lt;[Array][10]&lt;[string][8]>>** HTML code for an element
 
 ### grabMetrics
 
@@ -1167,7 +1191,7 @@ const metrics = await I.grabMetrics();
 ]
 ```
 
-Returns **[Promise][21]&lt;[Array][9]&lt;[Object][5]>>** 
+Returns **[Promise][9]&lt;[Array][10]&lt;[Object][5]>>** 
 
 ### grabNumberOfOpenTabs
 
@@ -1178,7 +1202,7 @@ Resumes test execution, so **should be used inside async function with `await`**
 let tabs = await I.grabNumberOfOpenTabs();
 ```
 
-Returns **[Promise][21]&lt;[number][19]>** number of open tabs
+Returns **[Promise][9]&lt;[number][20]>** number of open tabs
 
 ### grabNumberOfVisibleElements
 
@@ -1193,7 +1217,7 @@ let numOfElements = await I.grabNumberOfVisibleElements('p');
 
 -   `locator` **([string][8] | [object][5])** located by CSS|XPath|strict locator.
 
-Returns **[Promise][21]&lt;[number][19]>** number of visible elements
+Returns **[Promise][9]&lt;[number][20]>** number of visible elements
 
 ### grabPageScrollPosition
 
@@ -1204,7 +1228,7 @@ Resumes test execution, so **should be used inside an async function with `await
 let { x, y } = await I.grabPageScrollPosition();
 ```
 
-Returns **[Promise][21]&lt;PageScrollPosition>** scroll position
+Returns **[Promise][9]&lt;PageScrollPosition>** scroll position
 
 ### grabPopupText
 
@@ -1214,7 +1238,7 @@ Grab the text within the popup. If no popup is visible then it will return null
 await I.grabPopupText();
 ```
 
-Returns **[Promise][21]&lt;([string][8] | null)>** 
+Returns **[Promise][9]&lt;([string][8] | null)>** 
 
 ### grabRecordedNetworkTraffics
 
@@ -1227,7 +1251,7 @@ expect(traffics[0].response.status).to.equal(200);
 expect(traffics[0].response.body).to.contain({ name: 'this was mocked' });
 ```
 
-Returns **[Promise][21]&lt;[Array][9]&lt;any>>** 
+Returns **[Promise][9]&lt;[Array][10]&lt;any>>** 
 
 ### grabSource
 
@@ -1238,7 +1262,7 @@ Resumes test execution, so **should be used inside async function with `await`**
 let pageSource = await I.grabSource();
 ```
 
-Returns **[Promise][21]&lt;[string][8]>** source code
+Returns **[Promise][9]&lt;[string][8]>** source code
 
 ### grabTextFrom
 
@@ -1255,7 +1279,7 @@ If multiple elements found returns first element.
 
 -   `locator` **([string][8] | [object][5])** element located by CSS|XPath|strict locator.
 
-Returns **[Promise][21]&lt;[string][8]>** attribute value
+Returns **[Promise][9]&lt;[string][8]>** attribute value
 
 ### grabTextFromAll
 
@@ -1270,7 +1294,7 @@ let pins = await I.grabTextFromAll('#pin li');
 
 -   `locator` **([string][8] | [object][5])** element located by CSS|XPath|strict locator.
 
-Returns **[Promise][21]&lt;[Array][9]&lt;[string][8]>>** attribute value
+Returns **[Promise][9]&lt;[Array][10]&lt;[string][8]>>** attribute value
 
 ### grabTitle
 
@@ -1281,7 +1305,7 @@ Resumes test execution, so **should be used inside async with `await`** operator
 let title = await I.grabTitle();
 ```
 
-Returns **[Promise][21]&lt;[string][8]>** title
+Returns **[Promise][9]&lt;[string][8]>** title
 
 ### grabTrafficUrl
 
@@ -1289,12 +1313,12 @@ Returns full URL of request matching parameter "urlMatch".
 
 #### Parameters
 
--   `urlMatch` **([string][8] | [RegExp][10])** Expected URL of request in network traffic. Can be a string or a regular expression.Examples:```js
+-   `urlMatch` **([string][8] | [RegExp][11])** Expected URL of request in network traffic. Can be a string or a regular expression.Examples:```js
     I.grabTrafficUrl('https://api.example.com/session');
     I.grabTrafficUrl(/session.*start/);
     ```
 
-Returns **[Promise][21]&lt;any>** 
+Returns **[Promise][9]&lt;any>** 
 
 ### grabValueFrom
 
@@ -1310,7 +1334,7 @@ let email = await I.grabValueFrom('input[name=email]');
 
 -   `locator` **([string][8] | [object][5])** field located by label|name|CSS|XPath|strict locator.
 
-Returns **[Promise][21]&lt;[string][8]>** attribute value
+Returns **[Promise][9]&lt;[string][8]>** attribute value
 
 ### grabValueFromAll
 
@@ -1325,13 +1349,13 @@ let inputs = await I.grabValueFromAll('//form/input');
 
 -   `locator` **([string][8] | [object][5])** field located by label|name|CSS|XPath|strict locator.
 
-Returns **[Promise][21]&lt;[Array][9]&lt;[string][8]>>** attribute value
+Returns **[Promise][9]&lt;[Array][10]&lt;[string][8]>>** attribute value
 
 ### grabWebSocketMessages
 
 Grab the recording WS messages
 
-Returns **[Array][9]&lt;any>** 
+Returns **[Array][10]&lt;any>** 
 
 ### handleDownloads
 
@@ -1351,21 +1375,7 @@ I.waitForFile('avatar.jpg', 5);
 
 -   `fileName` **[string][8]** set filename for downloaded file
 
-Returns **[Promise][21]&lt;void>** 
-
-### haveRequestHeaders
-
-Set headers for all next requests
-
-```js
-I.haveRequestHeaders({
-   'X-Sent-By': 'CodeceptJS',
-});
-```
-
-#### Parameters
-
--   `customHeaders` **[object][5]** headers to set
+Returns **[Promise][9]&lt;void>** 
 
 ### makeApiRequest
 
@@ -1386,7 +1396,7 @@ I.makeApiRequest('PATCH', )
 -   `url` **[string][8]** endpoint
 -   `options` **[object][5]** request options depending on method used
 
-Returns **[Promise][21]&lt;[object][5]>** response
+Returns **[Promise][9]&lt;[object][5]>** response
 
 ### mockRoute
 
@@ -1400,8 +1410,8 @@ This method allows intercepting and mocking requests & responses. [Learn more ab
 
 #### Parameters
 
--   `url` **([string][8] | [RegExp][10])?** URL, regex or pattern for to match URL
--   `handler` **[function][20]?** a function to process reques
+-   `url` **([string][8] | [RegExp][11])?** URL, regex or pattern for to match URL
+-   `handler` **[function][21]?** a function to process reques
 
 ### mockTraffic
 
@@ -1435,9 +1445,10 @@ I.moveCursorTo('#submit', 5,5);
 #### Parameters
 
 -   `locator` **([string][8] | [object][5])** located by CSS|XPath|strict locator.
--   `offsetX` **[number][19]** (optional, `0` by default) X-axis offset. 
--   `offsetY` **[number][19]** (optional, `0` by default) Y-axis offset.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder 
+-   `offsetX` **[number][20]** (optional, `0` by default) X-axis offset. 
+-   `offsetY` **[number][20]** (optional, `0` by default) Y-axis offset. 
+
+Returns **[Promise][9]&lt;void>** automatically synchronized promise through #recorder
 
 ### openNewTab
 
@@ -1521,8 +1532,9 @@ Some of the supported key names are:
 
 #### Parameters
 
--   `key` **([string][8] | [Array][9]&lt;[string][8]>)** 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][30]).
+-   `key` **([string][8] | [Array][10]&lt;[string][8]>)** key or array of keys to press.
+
+Returns **[Promise][9]&lt;void>** automatically synchronized promise through #recorder_Note:_ Shortcuts like `'Meta'` + `'A'` do not work on macOS ([GoogleChrome/Puppeteer#1313][30]).
 
 ### pressKeyDown
 
@@ -1539,7 +1551,8 @@ I.pressKeyUp('Control');
 #### Parameters
 
 -   `key` **[string][8]** name of key to press down.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
+
+Returns **[Promise][9]&lt;void>** automatically synchronized promise through #recorder
 
 ### pressKeyUp
 
@@ -1556,7 +1569,8 @@ I.pressKeyUp('Control');
 #### Parameters
 
 -   `key` **[string][8]** name of key to release.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
+
+Returns **[Promise][9]&lt;void>** automatically synchronized promise through #recorder
 
 ### refreshPage
 
@@ -1566,7 +1580,7 @@ Reload the current page.
 I.refreshPage();
 ```
 
-⚠️ returns a _promise_ which is synchronized internally by recorder
+Returns **[Promise][9]&lt;void>** automatically synchronized promise through #recorder
 
 ### resizeWindow
 
@@ -1575,15 +1589,16 @@ First parameter can be set to `maximize`.
 
 #### Parameters
 
--   `width` **[number][19]** width in pixels or `maximize`.
--   `height` **[number][19]** height in pixels.
-    ⚠️ returns a _promise_ which is synchronized internally by recorderUnlike 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.
-    It also can't maximize a window.Update configuration to change real window size on start:```js
-    // inside codecept.conf.js
-    // @codeceptjs/configure package must be installed
-    { setWindowSize } = require('@codeceptjs/configure');
-    ```
+-   `width` **[number][20]** width in pixels or `maximize`.
+-   `height` **[number][20]** height in pixels.
+
+Returns **[Promise][9]&lt;void>** automatically synchronized promise through #recorderUnlike 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.
+It also can't maximize a window.Update configuration to change real window size on start:```js
+// inside codecept.conf.js
+// @codeceptjs/configure package must be installed
+{ setWindowSize } = require('@codeceptjs/configure');
+```
 
 ### restartBrowser
 
@@ -1618,8 +1633,9 @@ I.rightClick('Click me', '.context');
 #### Parameters
 
 -   `locator` **([string][8] | [object][5])** clickable element located by CSS|XPath|strict locator.
--   `context` **([string][8]? | [object][5])** (optional, `null` by default) element located by CSS|XPath|strict locator.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder 
+-   `context` **([string][8]? | [object][5])** (optional, `null` by default) element located by CSS|XPath|strict locator. 
+
+Returns **[Promise][9]&lt;void>** automatically synchronized promise through #recorder
 
 ### saveElementScreenshot
 
@@ -1634,7 +1650,8 @@ I.saveElementScreenshot(`#submit`,'debug.png');
 
 -   `locator` **([string][8] | [object][5])** element located by CSS|XPath|strict locator.
 -   `fileName` **[string][8]** file name to save.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
+
+Returns **[Promise][9]&lt;void>** automatically synchronized promise through #recorder
 
 ### saveScreenshot
 
@@ -1650,8 +1667,9 @@ I.saveScreenshot('debug.png', true) //resizes to available scrollHeight and scro
 #### Parameters
 
 -   `fileName` **[string][8]** file name to save.
--   `fullPage` **[boolean][32]** (optional, `false` by default) flag to enable fullscreen screenshot mode.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder 
+-   `fullPage` **[boolean][32]** (optional, `false` by default) flag to enable fullscreen screenshot mode. 
+
+Returns **[Promise][9]&lt;void>** automatically synchronized promise through #recorder
 
 ### scrollPageToBottom
 
@@ -1661,7 +1679,7 @@ Scroll page to the bottom.
 I.scrollPageToBottom();
 ```
 
-⚠️ returns a _promise_ which is synchronized internally by recorder
+Returns **[Promise][9]&lt;void>** automatically synchronized promise through #recorder
 
 ### scrollPageToTop
 
@@ -1671,7 +1689,7 @@ Scroll page to the top.
 I.scrollPageToTop();
 ```
 
-⚠️ returns a _promise_ which is synchronized internally by recorder
+Returns **[Promise][9]&lt;void>** automatically synchronized promise through #recorder
 
 ### scrollTo
 
@@ -1686,9 +1704,10 @@ I.scrollTo('#submit', 5, 5);
 #### Parameters
 
 -   `locator` **([string][8] | [object][5])** located by CSS|XPath|strict locator.
--   `offsetX` **[number][19]** (optional, `0` by default) X-axis offset. 
--   `offsetY` **[number][19]** (optional, `0` by default) Y-axis offset.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder 
+-   `offsetX` **[number][20]** (optional, `0` by default) X-axis offset. 
+-   `offsetY` **[number][20]** (optional, `0` by default) Y-axis offset. 
+
+Returns **[Promise][9]&lt;void>** automatically synchronized promise through #recorder
 
 ### see
 
@@ -1704,8 +1723,9 @@ I.see('Register', {css: 'form.register'}); // use strict locator
 #### Parameters
 
 -   `text` **[string][8]** expected on page.
--   `context` **([string][8]? | [object][5])** (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 
+-   `context` **([string][8]? | [object][5])** (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text. 
+
+Returns **[Promise][9]&lt;void>** automatically synchronized promise through #recorder
 
 ### seeAttributesOnElements
 
@@ -1719,7 +1739,8 @@ I.seeAttributesOnElements('//form', { method: "post"});
 
 -   `locator` **([string][8] | [object][5])** located by CSS|XPath|strict locator.
 -   `attributes` **[object][5]** attributes and their values to check.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
+
+Returns **[Promise][9]&lt;void>** automatically synchronized promise through #recorder
 
 ### seeCheckboxIsChecked
 
@@ -1734,7 +1755,8 @@ I.seeCheckboxIsChecked({css: '#signup_form input[type=checkbox]'});
 #### Parameters
 
 -   `field` **([string][8] | [object][5])** located by label|name|CSS|XPath|strict locator.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
+
+Returns **[Promise][9]&lt;void>** automatically synchronized promise through #recorder
 
 ### seeCookie
 
@@ -1747,7 +1769,8 @@ I.seeCookie('Auth');
 #### Parameters
 
 -   `name` **[string][8]** cookie name.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
+
+Returns **[Promise][9]&lt;void>** automatically synchronized promise through #recorder
 
 ### seeCssPropertiesOnElements
 
@@ -1761,7 +1784,8 @@ I.seeCssPropertiesOnElements('h3', { 'font-weight': "bold"});
 
 -   `locator` **([string][8] | [object][5])** located by CSS|XPath|strict locator.
 -   `cssProperties` **[object][5]** object with CSS properties and their values to check.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
+
+Returns **[Promise][9]&lt;void>** automatically synchronized promise through #recorder
 
 ### seeCurrentUrlEquals
 
@@ -1777,7 +1801,8 @@ I.seeCurrentUrlEquals('http://my.site.com/register');
 #### Parameters
 
 -   `url` **[string][8]** value to check.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
+
+Returns **[Promise][9]&lt;void>** automatically synchronized promise through #recorder
 
 ### seeElement
 
@@ -1791,7 +1816,8 @@ I.seeElement('#modal');
 #### Parameters
 
 -   `locator` **([string][8] | [object][5])** located by CSS|XPath|strict locator.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
+
+Returns **[Promise][9]&lt;void>** automatically synchronized promise through #recorder
 
 ### seeElementInDOM
 
@@ -1805,7 +1831,8 @@ I.seeElementInDOM('#modal');
 #### Parameters
 
 -   `locator` **([string][8] | [object][5])** element located by CSS|XPath|strict locator.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
+
+Returns **[Promise][9]&lt;void>** automatically synchronized promise through #recorder
 
 ### seeInCurrentUrl
 
@@ -1818,7 +1845,8 @@ I.seeInCurrentUrl('/register'); // we are on registration page
 #### Parameters
 
 -   `url` **[string][8]** a fragment to check
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
+
+Returns **[Promise][9]&lt;void>** automatically synchronized promise through #recorder
 
 ### seeInField
 
@@ -1836,7 +1864,8 @@ I.seeInField('#searchform input','Search');
 
 -   `field` **([string][8] | [object][5])** located by label|name|CSS|XPath|strict locator.
 -   `value` **([string][8] | [object][5])** value to check.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
+
+Returns **[Promise][9]&lt;void>** automatically synchronized promise through #recorder
 
 ### seeInPopup
 
@@ -1850,7 +1879,8 @@ I.seeInPopup('Popup text');
 #### Parameters
 
 -   `text` **[string][8]** value to check.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
+
+Returns **[Promise][9]&lt;void>** automatically synchronized promise through #recorder
 
 ### seeInSource
 
@@ -1863,7 +1893,8 @@ I.seeInSource('<h1>Green eggs &amp; ham</h1>');
 #### Parameters
 
 -   `text` **[string][8]** value to check.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
+
+Returns **[Promise][9]&lt;void>** automatically synchronized promise through #recorder
 
 ### seeInTitle
 
@@ -1876,7 +1907,8 @@ I.seeInTitle('Home Page');
 #### Parameters
 
 -   `text` **[string][8]** text value to check.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
+
+Returns **[Promise][9]&lt;void>** automatically synchronized promise through #recorder
 
 ### seeNumberOfElements
 
@@ -1890,8 +1922,9 @@ I.seeNumberOfElements('#submitBtn', 1);
 #### Parameters
 
 -   `locator` **([string][8] | [object][5])** element located by CSS|XPath|strict locator.
--   `num` **[number][19]** number of elements.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
+-   `num` **[number][20]** number of elements.
+
+Returns **[Promise][9]&lt;void>** automatically synchronized promise through #recorder
 
 ### seeNumberOfVisibleElements
 
@@ -1905,8 +1938,9 @@ I.seeNumberOfVisibleElements('.buttons', 3);
 #### Parameters
 
 -   `locator` **([string][8] | [object][5])** element located by CSS|XPath|strict locator.
--   `num` **[number][19]** number of elements.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
+-   `num` **[number][20]** number of elements.
+
+Returns **[Promise][9]&lt;void>** automatically synchronized promise through #recorder
 
 ### seeTextEquals
 
@@ -1919,8 +1953,9 @@ I.seeTextEquals('text', 'h1');
 #### Parameters
 
 -   `text` **[string][8]** element value to check.
--   `context` **([string][8] | [object][5])?** element located by CSS|XPath|strict locator.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder 
+-   `context` **([string][8] | [object][5])?** element located by CSS|XPath|strict locator. 
+
+Returns **[Promise][9]&lt;void>** automatically synchronized promise through #recorder
 
 ### seeTitleEquals
 
@@ -1933,7 +1968,8 @@ I.seeTitleEquals('Test title.');
 #### Parameters
 
 -   `text` **[string][8]** value to check.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
+
+Returns **[Promise][9]&lt;void>** automatically synchronized promise through #recorder
 
 ### seeTraffic
 
@@ -1973,9 +2009,9 @@ await I.seeTraffic({
     -   `opts.url` **[string][8]** Expected URL of request in network traffic
     -   `opts.parameters` **[Object][5]?** Expected parameters of that request in network traffic
     -   `opts.requestPostData` **[Object][5]?** Expected that request contains post data in network traffic
-    -   `opts.timeout` **[number][19]?** Timeout to wait for request in seconds. Default is 10 seconds. 
+    -   `opts.timeout` **[number][20]?** Timeout to wait for request in seconds. Default is 10 seconds. 
 
-Returns **[Promise][21]&lt;any>** 
+Returns **[Promise][9]&lt;any>** 
 
 ### selectOption
 
@@ -2001,8 +2037,9 @@ I.selectOption('Which OS do you use?', ['Android', 'iOS']);
 #### Parameters
 
 -   `select` **([string][8] | [object][5])** field located by label|name|CSS|XPath|strict locator.
--   `option` **([string][8] | [Array][9]&lt;any>)** visible text or value of option.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
+-   `option` **([string][8] | [Array][10]&lt;any>)** visible text or value of option.
+
+Returns **[Promise][9]&lt;void>** automatically synchronized promise through #recorder
 
 ### setCookie
 
@@ -2022,8 +2059,23 @@ I.setCookie([
 
 #### Parameters
 
--   `cookie` **(Cookie | [Array][9]&lt;Cookie>)** a cookie object or array of cookie objects.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
+-   `cookie` **(Cookie | [Array][10]&lt;Cookie>)** a cookie object or array of cookie objects.
+
+Returns **[Promise][9]&lt;void>** automatically synchronized promise through #recorder
+
+### setPlaywrightRequestHeaders
+
+Set headers for all next requests
+
+```js
+I.setPlaywrightRequestHeaders({
+   'X-Sent-By': 'CodeceptJS',
+});
+```
+
+#### Parameters
+
+-   `customHeaders` **[object][5]** headers to set
 
 ### startRecordingTraffic
 
@@ -2058,8 +2110,8 @@ If no handler is passed, all mock requests for the rote are disabled.
 
 #### Parameters
 
--   `url` **([string][8] | [RegExp][10])?** URL, regex or pattern for to match URL
--   `handler` **[function][20]?** a function to process reques
+-   `url` **([string][8] | [RegExp][11])?** URL, regex or pattern for to match URL
+-   `handler` **[function][21]?** a function to process reques
 
 ### stopRecordingTraffic
 
@@ -2088,8 +2140,9 @@ I.switchTo(); // switch back to main page
 
 #### Parameters
 
--   `locator` **([string][8]? | [object][5])** (optional, `null` by default) element located by CSS|XPath|strict locator.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder 
+-   `locator` **([string][8]? | [object][5])** (optional, `null` by default) element located by CSS|XPath|strict locator. 
+
+Returns **[Promise][9]&lt;void>** automatically synchronized promise through #recorder
 
 ### switchToNextTab
 
@@ -2102,7 +2155,7 @@ I.switchToNextTab(2);
 
 #### Parameters
 
--   `num` **[number][19]**  
+-   `num` **[number][20]**  
 
 ### switchToPreviousTab
 
@@ -2115,7 +2168,7 @@ I.switchToPreviousTab(2);
 
 #### Parameters
 
--   `num` **[number][19]**  
+-   `num` **[number][20]**  
 
 ### type
 
@@ -2140,9 +2193,10 @@ I.type(secret('123456'));
 #### Parameters
 
 -   `keys`  
--   `delay` **[number][19]?** (optional) delay in ms between key presses
-    ⚠️ returns a _promise_ which is synchronized internally by recorder 
--   `key` **([string][8] | [Array][9]&lt;[string][8]>)** or array of keys to type.
+-   `delay` **[number][20]?** (optional) delay in ms between key presses 
+-   `key` **([string][8] | [Array][10]&lt;[string][8]>)** or array of keys to type.
+
+Returns **[Promise][9]&lt;void>** automatically synchronized promise through #recorder
 
 ### uncheckOption
 
@@ -2160,13 +2214,14 @@ I.uncheckOption('agree', '//form');
 #### Parameters
 
 -   `field` **([string][8] | [object][5])** checkbox located by label | name | CSS | XPath | strict locator.
--   `context` **([string][8]? | [object][5])** (optional, `null` by default) element located by CSS | XPath | strict locator.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder[Additional options][33] for uncheck available as 3rd argument.Examples:```js
-    // click on element at position
-    I.uncheckOption('Agree', '.signup', { position: { x: 5, y: 5 } })
-    ```> ⚠️ To avoid flakiness, option `force: true` is set by default 
+-   `context` **([string][8]? | [object][5])** (optional, `null` by default) element located by CSS | XPath | strict locator. 
 -   `options`   
 
+Returns **[Promise][9]&lt;void>** automatically synchronized promise through #recorder[Additional options][33] for uncheck available as 3rd argument.Examples:```js
+// click on element at position
+I.uncheckOption('Agree', '.signup', { position: { x: 5, y: 5 } })
+```> ⚠️ To avoid flakiness, option `force: true` is set by default
+
 ### usePlaywrightTo
 
 Use Playwright API inside a test.
@@ -2185,7 +2240,7 @@ I.usePlaywrightTo('emulate offline mode', async ({ browserContext }) => {
 #### Parameters
 
 -   `description` **[string][8]** used to show in logs.
--   `fn` **[function][20]** async function that executed with Playwright helper as argumen
+-   `fn` **[function][21]** async function that executed with Playwright helper as argumen
 
 ### wait
 
@@ -2197,8 +2252,9 @@ I.wait(2); // wait 2 secs
 
 #### Parameters
 
--   `sec` **[number][19]** number of second to wait.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
+-   `sec` **[number][20]** number of second to wait.
+
+Returns **[Promise][9]&lt;void>** automatically synchronized promise through #recorder
 
 ### waitForClickable
 
@@ -2214,8 +2270,9 @@ I.waitForClickable('.btn.continue', 5); // wait for 5 secs
 
 -   `locator` **([string][8] | [object][5])** element located by CSS|XPath|strict locator.
 -   `waitTimeout`  
--   `sec` **[number][19]?** (optional, `1` by default) time in seconds to wait
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
+-   `sec` **[number][20]?** (optional, `1` by default) time in seconds to wait
+
+Returns **[Promise][9]&lt;void>** automatically synchronized promise through #recorder
 
 ### waitForDetached
 
@@ -2229,8 +2286,9 @@ I.waitForDetached('#popup');
 #### Parameters
 
 -   `locator` **([string][8] | [object][5])** element located by CSS|XPath|strict locator.
--   `sec` **[number][19]** (optional, `1` by default) time in seconds to wait
-    ⚠️ returns a _promise_ which is synchronized internally by recorder 
+-   `sec` **[number][20]** (optional, `1` by default) time in seconds to wait 
+
+Returns **[Promise][9]&lt;void>** automatically synchronized promise through #recorder
 
 ### waitForElement
 
@@ -2245,8 +2303,9 @@ I.waitForElement('.btn.continue', 5); // wait for 5 secs
 #### Parameters
 
 -   `locator` **([string][8] | [object][5])** element located by CSS|XPath|strict locator.
--   `sec` **[number][19]?** (optional, `1` by default) time in seconds to wait
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
+-   `sec` **[number][20]?** (optional, `1` by default) time in seconds to wait
+
+Returns **[Promise][9]&lt;void>** automatically synchronized promise through #recorder
 
 ### waitForEnabled
 
@@ -2256,8 +2315,9 @@ Element can be located by CSS or XPath.
 #### Parameters
 
 -   `locator` **([string][8] | [object][5])** element located by CSS|XPath|strict locator.
--   `sec` **[number][19]** (optional) time in seconds to wait, 1 by default.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder 
+-   `sec` **[number][20]** (optional) time in seconds to wait, 1 by default. 
+
+Returns **[Promise][9]&lt;void>** automatically synchronized promise through #recorder
 
 ### waitForFunction
 
@@ -2276,10 +2336,11 @@ I.waitForFunction((count) => window.requests == count, [3], 5) // pass args and
 
 #### Parameters
 
--   `fn` **([string][8] | [function][20])** to be executed in browser context.
--   `argsOrSec` **([Array][9]&lt;any> | [number][19])?** (optional, `1` by default) arguments for function or seconds. 
--   `sec` **[number][19]?** (optional, `1` by default) time in seconds to wait
-    ⚠️ returns a _promise_ which is synchronized internally by recorder 
+-   `fn` **([string][8] | [function][21])** to be executed in browser context.
+-   `argsOrSec` **([Array][10]&lt;any> | [number][20])?** (optional, `1` by default) arguments for function or seconds. 
+-   `sec` **[number][20]?** (optional, `1` by default) time in seconds to wait 
+
+Returns **[Promise][9]&lt;void>** automatically synchronized promise through #recorder
 
 ### waitForInvisible
 
@@ -2293,8 +2354,9 @@ I.waitForInvisible('#popup');
 #### Parameters
 
 -   `locator` **([string][8] | [object][5])** element located by CSS|XPath|strict locator.
--   `sec` **[number][19]** (optional, `1` by default) time in seconds to wait
-    ⚠️ returns a _promise_ which is synchronized internally by recorder 
+-   `sec` **[number][20]** (optional, `1` by default) time in seconds to wait 
+
+Returns **[Promise][9]&lt;void>** automatically synchronized promise through #recorder
 
 ### waitForNavigation
 
@@ -2317,8 +2379,8 @@ I.waitForRequest(request => request.url() === 'http://example.com' && request.me
 
 #### Parameters
 
--   `urlOrPredicate` **([string][8] | [function][20])** 
--   `sec` **[number][19]?** seconds to wait 
+-   `urlOrPredicate` **([string][8] | [function][21])** 
+-   `sec` **[number][20]?** seconds to wait 
 
 ### waitForResponse
 
@@ -2331,8 +2393,8 @@ I.waitForResponse(response => response.url() === 'https://example.com' && respon
 
 #### Parameters
 
--   `urlOrPredicate` **([string][8] | [function][20])** 
--   `sec` **[number][19]?** number of seconds to wait 
+-   `urlOrPredicate` **([string][8] | [function][21])** 
+-   `sec` **[number][20]?** number of seconds to wait 
 
 ### waitForText
 
@@ -2348,9 +2410,10 @@ I.waitForText('Thank you, form has been submitted', 5, '#modal');
 #### Parameters
 
 -   `text` **[string][8]** to wait for.
--   `sec` **[number][19]** (optional, `1` by default) time in seconds to wait 
--   `context` **([string][8] | [object][5])?** (optional) element located by CSS|XPath|strict locator.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder 
+-   `sec` **[number][20]** (optional, `1` by default) time in seconds to wait 
+-   `context` **([string][8] | [object][5])?** (optional) element located by CSS|XPath|strict locator. 
+
+Returns **[Promise][9]&lt;void>** automatically synchronized promise through #recorder
 
 ### waitForURL
 
@@ -2360,7 +2423,7 @@ See [Playwright's reference][38]
 
 #### Parameters
 
--   `url` **([string][8] | [RegExp][10])** A glob pattern, regex pattern or predicate receiving URL to match while waiting for the navigation. Note that if the parameter is a string without wildcard characters, the method will wait for navigation to URL that is exactly equal to the string.
+-   `url` **([string][8] | [RegExp][11])** A glob pattern, regex pattern or predicate receiving URL to match while waiting for the navigation. Note that if the parameter is a string without wildcard characters, the method will wait for navigation to URL that is exactly equal to the string.
 -   `options` **any**  
 
 ### waitForValue
@@ -2375,8 +2438,9 @@ I.waitForValue('//input', "GoodValue");
 
 -   `field` **([string][8] | [object][5])** input field.
 -   `value` **[string][8]** expected value.
--   `sec` **[number][19]** (optional, `1` by default) time in seconds to wait
-    ⚠️ returns a _promise_ which is synchronized internally by recorder 
+-   `sec` **[number][20]** (optional, `1` by default) time in seconds to wait 
+
+Returns **[Promise][9]&lt;void>** automatically synchronized promise through #recorder
 
 ### waitForVisible
 
@@ -2390,8 +2454,9 @@ I.waitForVisible('#popup');
 #### Parameters
 
 -   `locator` **([string][8] | [object][5])** element located by CSS|XPath|strict locator.
--   `sec` **[number][19]** (optional, `1` by default) time in seconds to wait
-    ⚠️ returns a _promise_ which is synchronized internally by recorderThis method accepts [React selectors][39]. 
+-   `sec` **[number][20]** (optional, `1` by default) time in seconds to wait 
+
+Returns **[Promise][9]&lt;void>** automatically synchronized promise through #recorderThis method accepts [React selectors][39].
 
 ### waitInUrl
 
@@ -2404,8 +2469,9 @@ I.waitInUrl('/info', 2);
 #### Parameters
 
 -   `urlPart` **[string][8]** value to check.
--   `sec` **[number][19]** (optional, `1` by default) time in seconds to wait
-    ⚠️ returns a _promise_ which is synchronized internally by recorder 
+-   `sec` **[number][20]** (optional, `1` by default) time in seconds to wait 
+
+Returns **[Promise][9]&lt;void>** automatically synchronized promise through #recorder
 
 ### waitNumberOfVisibleElements
 
@@ -2418,9 +2484,10 @@ I.waitNumberOfVisibleElements('a', 3);
 #### Parameters
 
 -   `locator` **([string][8] | [object][5])** element located by CSS|XPath|strict locator.
--   `num` **[number][19]** number of elements.
--   `sec` **[number][19]** (optional, `1` by default) time in seconds to wait
-    ⚠️ returns a _promise_ which is synchronized internally by recorder 
+-   `num` **[number][20]** number of elements.
+-   `sec` **[number][20]** (optional, `1` by default) time in seconds to wait 
+
+Returns **[Promise][9]&lt;void>** automatically synchronized promise through #recorder
 
 ### waitToHide
 
@@ -2434,8 +2501,9 @@ I.waitToHide('#popup');
 #### Parameters
 
 -   `locator` **([string][8] | [object][5])** element located by CSS|XPath|strict locator.
--   `sec` **[number][19]** (optional, `1` by default) time in seconds to wait
-    ⚠️ returns a _promise_ which is synchronized internally by recorder 
+-   `sec` **[number][20]** (optional, `1` by default) time in seconds to wait 
+
+Returns **[Promise][9]&lt;void>** automatically synchronized promise through #recorder
 
 ### waitUrlEquals
 
@@ -2449,8 +2517,9 @@ I.waitUrlEquals('http://127.0.0.1:8000/info');
 #### Parameters
 
 -   `urlPart` **[string][8]** value to check.
--   `sec` **[number][19]** (optional, `1` by default) time in seconds to wait
-    ⚠️ returns a _promise_ which is synchronized internally by recorder 
+-   `sec` **[number][20]** (optional, `1` by default) time in seconds to wait 
+
+Returns **[Promise][9]&lt;void>** automatically synchronized promise through #recorder
 
 [1]: https://github.com/microsoft/playwright
 
@@ -2468,31 +2537,31 @@ I.waitUrlEquals('http://127.0.0.1:8000/info');
 
 [8]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
 
-[9]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
+[9]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise
 
-[10]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/RegExp
+[10]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
 
-[11]: https://www.example.com**
+[11]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/RegExp
 
-[12]: https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus
+[12]: https://www.example.com**
 
-[13]: https://playwright.dev/docs/api/class-locator#locator-blur
+[13]: https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus
 
-[14]: https://playwright.dev/docs/api/class-elementhandle#element-handle-check
+[14]: https://playwright.dev/docs/api/class-locator#locator-blur
 
-[15]: https://playwright.dev/docs/actionability
+[15]: https://playwright.dev/docs/api/class-elementhandle#element-handle-check
 
-[16]: https://playwright.dev/docs/api/class-locator#locator-clear
+[16]: https://playwright.dev/docs/actionability
 
-[17]: https://playwright.dev/docs/api/class-page#page-click
+[17]: https://playwright.dev/docs/api/class-locator#locator-clear
 
-[18]: https://playwright.dev/docs/api/class-page#page-drag-and-drop
+[18]: https://playwright.dev/docs/api/class-page#page-click
 
-[19]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
+[19]: https://playwright.dev/docs/api/class-page#page-drag-and-drop
 
-[20]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function
+[20]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
 
-[21]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise
+[21]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function
 
 [22]: https://playwright.dev/docs/api/class-locator#locator-focus