codeceptjs 3.5.0 → 3.5.1

package/docs/helpers/Playwright.md

@@ -33,48 +33,48 @@ Using playwright-core package, will prevent the download of browser binaries and
 
 ## Configuration
 
-This helper should be configured in codecept.conf.js
+This helper should be configured in codecept.conf.(js|ts)
 
 Type: [object][5]
 
 ### Properties
 
--   `url` **[string][8]** base url of website to be tested
+-   `url` **[string][8]?** base url of website to be tested
 -   `browser` **(`"chromium"` | `"firefox"` | `"webkit"` | `"electron"`)?** a browser to test on, either: `chromium`, `firefox`, `webkit`, `electron`. Default: chromium.
--   `show` **[boolean][30]?** show browser window.
--   `restart` **([string][8] | [boolean][30])?** restart strategy between tests. Possible values:-   'context' or **false** - restarts [browser context][37] but keeps running browser. Recommended by Playwright team to keep tests isolated.
+-   `show` **[boolean][31]?** show browser window.
+-   `restart` **([string][8] | [boolean][31])?** restart strategy between tests. Possible values:-   'context' or **false** - restarts [browser context][38] 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][14]?** -   [timeout][38] in ms of all Playwright actions .
--   `disableScreenshots` **[boolean][30]?** don't save screenshot on failure.
+-   `timeout` **[number][16]?** -   [timeout][39] in ms of all Playwright actions .
+-   `disableScreenshots` **[boolean][31]?** don't save screenshot on failure.
 -   `emulate` **any?** browser in device emulation mode.
--   `video` **[boolean][30]?** enables video recording for failed tests; videos are saved into `output/videos` folder
--   `keepVideoForPassedTests` **[boolean][30]?** save videos for passed tests; videos are saved into `output/videos` folder
--   `trace` **[boolean][30]?** record [tracing information][39] with screenshots and snapshots.
--   `keepTraceForPassedTests` **[boolean][30]?** save trace for passed tests.
--   `fullPageScreenshots` **[boolean][30]?** make full page screenshots on failure.
--   `uniqueScreenshotNames` **[boolean][30]?** option to prevent screenshot override if you have scenarios with the same name in different suites.
--   `keepBrowserState` **[boolean][30]?** keep browser state between tests when `restart` is set to 'session'.
--   `keepCookies` **[boolean][30]?** keep cookies between tests when `restart` is set to 'session'.
--   `waitForAction` **[number][14]?** how long to wait after click, doubleClick or PressKey actions in ms. Default: 100.
--   `waitForNavigation` **(`"load"` | `"domcontentloaded"` | `"networkidle"`)?** When to consider navigation succeeded. Possible options: `load`, `domcontentloaded`, `networkidle`. Choose one of those options is possible. See [Playwright API][40].
--   `pressKeyDelay` **[number][14]?** Delay between key presses in ms. Used when calling Playwrights page.type(...) in fillField/appendField
--   `getPageTimeout` **[number][14]?** config option to set maximum navigation time in milliseconds.
--   `waitForTimeout` **[number][14]?** default wait* timeout in ms. Default: 1000.
+-   `video` **[boolean][31]?** enables video recording for failed tests; videos are saved into `output/videos` folder
+-   `keepVideoForPassedTests` **[boolean][31]?** save videos for passed tests; videos are saved into `output/videos` folder
+-   `trace` **[boolean][31]?** record [tracing information][40] with screenshots and snapshots.
+-   `keepTraceForPassedTests` **[boolean][31]?** save trace for passed tests.
+-   `fullPageScreenshots` **[boolean][31]?** make full page screenshots on failure.
+-   `uniqueScreenshotNames` **[boolean][31]?** option to prevent screenshot override if you have scenarios with the same name in different suites.
+-   `keepBrowserState` **[boolean][31]?** keep browser state between tests when `restart` is set to 'session'.
+-   `keepCookies` **[boolean][31]?** keep cookies between tests when `restart` is set to 'session'.
+-   `waitForAction` **[number][16]?** how long to wait after click, doubleClick or PressKey actions in ms. Default: 100.
+-   `waitForNavigation` **(`"load"` | `"domcontentloaded"` | `"networkidle"`)?** When to consider navigation succeeded. Possible options: `load`, `domcontentloaded`, `networkidle`. Choose one of those options is possible. See [Playwright API][41].
+-   `pressKeyDelay` **[number][16]?** Delay between key presses in ms. Used when calling Playwrights page.type(...) in fillField/appendField
+-   `getPageTimeout` **[number][16]?** config option to set maximum navigation time in milliseconds.
+-   `waitForTimeout` **[number][16]?** 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`.
 -   `userAgent` **[string][8]?** user-agent string.
 -   `locale` **[string][8]?** locale string. Example: 'en-GB', 'de-DE', 'fr-FR', ...
--   `manualStart` **[boolean][30]?** do not start browser before a test, start it manually inside a helper with `this.helpers["Playwright"]._startBrowser()`.
+-   `manualStart` **[boolean][31]?** do not start browser before a test, start it manually inside a helper with `this.helpers["Playwright"]._startBrowser()`.
 -   `chromium` **[object][5]?** pass additional chromium options
 -   `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][41].
--   `ignoreLog` **[Array][19]<[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][42].
--   `ignoreHTTPSErrors` **[boolean][30]?** Allows access to untrustworthy pages, e.g. to a page with an expired certificate. Default value is `false`
--   `bypassCSP` **[boolean][30]?** bypass Content Security Policy or CSP
--   `highlightElement` **[boolean][30]?** highlight the interacting elements
+-   `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][42].
+-   `ignoreLog` **[Array][20]<[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][43].
+-   `ignoreHTTPSErrors` **[boolean][31]?** Allows access to untrustworthy pages, e.g. to a page with an expired certificate. Default value is `false`
+-   `bypassCSP` **[boolean][31]?** bypass Content Security Policy or CSP
+-   `highlightElement` **[boolean][31]?** highlight the interacting elements
 
 
 
@@ -217,6 +217,22 @@ const { devices } = require('playwright');
 }
 ```
 
+-   #### Example #9: Launch electron test
+
+```js
+{
+ helpers: {
+    Playwright: {
+      browser: 'electron',
+      electron: {
+        executablePath: require("electron"),
+        args: [path.join('../', "main.js")],
+      },
+    }
+  },
+}
+```
+
 Note: When connecting to remote browser `show` and specific `chrome` options (e.g. `headless` or `devtools`) are ignored.
 
 ## Access From Helpers
@@ -408,20 +424,26 @@ I.attachFile('form input[name=avatar]', 'data/avatar.jpg');
 
 ### blur
 
-Remove focus from a text input, button, etc
+Remove focus from a text input, button, etc.
 Calls [blur][9] on the element.
 
+Examples:
+
+```js
+I.blur('.text-area')
+```
+
+```js
+//element `#product-tile` is focused
+I.see('#add-to-cart-btn');
+I.blur('#product-tile')
+I.dontSee('#add-to-cart-btn');
+```
+
 #### Parameters
 
 -   `locator` **([string][8] | [object][5])** field located by label|name|CSS|XPath|strict locator.
--   `options` **any?** [Additional options][9] for available options object as 2nd argument.Examples:```js
-    I.blur('.text-area')
-    ``````js
-    //element `#product-tile` is focused
-    I.see('#add-to-cart-btn');
-    I.blur('#product-tile')
-    I.dontSee('#add-to-cart-btn');
-    ``` 
+-   `options` **any?** Playwright only: [Additional options][10] for available options object as 2nd argument. 
 
 ### cancelPopup
 
@@ -444,7 +466,7 @@ I.checkOption('agree', '//form');
 
 -   `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][10] for check available as 3rd argument.Examples:```js
+    ⚠️ returns a _promise_ which is synchronized internally by recorder[Additional options][11] 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 
@@ -467,16 +489,23 @@ I.clearCookie('test');
 
 ### clearField
 
-Clear the <input>, <textarea> or [contenteditable] .
+Clears the text input element: `<input>`, `<textarea>` or `[contenteditable]` .
+
+Examples:
+
+```js
+I.clearField('.text-area')
+
+// if this doesn't work use force option
+I.clearField('#submit', { force: true })
+```
+
+Use `force` to bypass the [actionability][12] checks.
 
 #### Parameters
 
 -   `locator` **([string][8] | [object][5])** field located by label|name|CSS|XPath|strict locator.
--   `options` **any?** [Additional options][11] for available options object as 2nd argument.Examples:```js
-    I.clearField('.text-area')
-    ``````js
-    I.clearField('#submit', { force: true }) // force to bypass the [actionability](https://playwright.dev/docs/actionability) checks.
-    ``` 
+-   `options` **any?** [Additional options][13] for available options object as 2nd argument. 
 
 ### click
 
@@ -507,7 +536,7 @@ I.click({css: 'nav a.login'});
 -   `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][12] for click available as 3rd argument.Examples:```js
+-   `options` **any?** [Additional options][14] for click available as 3rd argument.Examples:```js
     // click on element at position
     I.click('canvas', '.model', { position: { x: 20, y: 40 } })
 
@@ -708,7 +737,7 @@ 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][13] can be passed as 3rd argument.```js
+-   `options` **any?** [Additional options][15] 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`
@@ -726,7 +755,7 @@ I.dragSlider('#slider', -70);
 #### Parameters
 
 -   `locator` **([string][8] | [object][5])** located by label|name|CSS|XPath|strict locator.
--   `offsetX` **[number][14]** position to drag.
+-   `offsetX` **[number][16]** position to drag.
     ⚠️ returns a _promise_ which is synchronized internally by recorder 
 
 ### executeScript
@@ -754,10 +783,10 @@ If a function returns a Promise it will wait for its resolution.
 
 #### Parameters
 
--   `fn` **([string][8] | [function][15])** function to be executed in browser context.
+-   `fn` **([string][8] | [function][17])** function to be executed in browser context.
 -   `arg` **any?** optional argument to pass to the function
 
-Returns **[Promise][16]&lt;any>** 
+Returns **[Promise][18]&lt;any>** 
 
 ### fillField
 
@@ -783,16 +812,20 @@ I.fillField({css: 'form#login input[name=username]'}, 'John');
 
 ### focus
 
-Calls [focus][17] on the matching element.
+Calls [focus][9] on the matching element.
+
+Examples:
+
+```js
+I.dontSee('#add-to-cart-btn');
+I.focus('#product-tile')
+I.see('#add-to-cart-bnt');
+```
 
 #### Parameters
 
 -   `locator` **([string][8] | [object][5])** field located by label|name|CSS|XPath|strict locator.
--   `options` **any?** [Additional options][18] for available options object as 2nd argument.Examples:```js
-    I.dontSee('#add-to-cart-btn');
-    I.focus('#product-tile')
-    I.see('#add-to-cart-bnt');
-    ``` 
+-   `options` **any?** Playwright only: [Additional options][19] for available options object as 2nd argument. 
 
 ### forceClick
 
@@ -842,7 +875,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][16]&lt;[string][8]>** attribute value
+Returns **[Promise][18]&lt;[string][8]>** attribute value
 
 ### grabAttributeFromAll
 
@@ -858,7 +891,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][16]&lt;[Array][19]&lt;[string][8]>>** attribute value
+Returns **[Promise][18]&lt;[Array][20]&lt;[string][8]>>** attribute value
 
 ### grabBrowserLogs
 
@@ -870,9 +903,9 @@ const errors = logs.map(l => ({ type: l.type(), text: l.text() })).filter(l => l
 console.log(JSON.stringify(errors));
 ```
 
-[Learn more about console messages][20]
+[Learn more about console messages][21]
 
-Returns **[Promise][16]&lt;[Array][19]&lt;any>>** 
+Returns **[Promise][18]&lt;[Array][20]&lt;any>>** 
 
 ### grabCookie
 
@@ -889,7 +922,7 @@ assert(cookie.value, '123456');
 
 -   `name` **[string][8]?** cookie name. 
 
-Returns **([Promise][16]&lt;[string][8]> | [Promise][16]&lt;[Array][19]&lt;[string][8]>>)** attribute valueReturns cookie in JSON format. If name not passed returns all cookies for this domain.
+Returns **([Promise][18]&lt;[string][8]> | [Promise][18]&lt;[Array][20]&lt;[string][8]>>)** attribute valueReturns cookie in JSON format. If name not passed returns all cookies for this domain.
 
 ### grabCssPropertyFrom
 
@@ -906,7 +939,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][16]&lt;[string][8]>** CSS value
+Returns **[Promise][18]&lt;[string][8]>** CSS value
 
 ### grabCssPropertyFromAll
 
@@ -922,7 +955,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][16]&lt;[Array][19]&lt;[string][8]>>** CSS value
+Returns **[Promise][18]&lt;[Array][20]&lt;[string][8]>>** CSS value
 
 ### grabCurrentUrl
 
@@ -934,7 +967,7 @@ let url = await I.grabCurrentUrl();
 console.log(`Current URL is [${url}]`);
 ```
 
-Returns **[Promise][16]&lt;[string][8]>** current URL
+Returns **[Promise][18]&lt;[string][8]>** current URL
 
 ### grabDataFromPerformanceTiming
 
@@ -959,7 +992,7 @@ let data = await I.grabDataFromPerformanceTiming();
 }
 ```
 
-Returns **[Promise][16]&lt;any>** automatically synchronized promise through #recorder
+Returns **[Promise][18]&lt;any>** automatically synchronized promise through #recorder
 
 ### grabElementBoundingRect
 
@@ -987,7 +1020,7 @@ const width = await I.grabElementBoundingRect('h3', 'width');
 -   `prop`  
 -   `elementSize` **[string][8]?** x, y, width or height of the given element.
 
-Returns **([Promise][16]&lt;DOMRect> | [Promise][16]&lt;[number][14]>)** Element bounding rectangle
+Returns **([Promise][18]&lt;DOMRect> | [Promise][18]&lt;[number][16]>)** Element bounding rectangle
 
 ### grabHTMLFrom
 
@@ -1004,7 +1037,7 @@ let postHTML = await I.grabHTMLFrom('#post');
 -   `locator`  
 -   `element` **([string][8] | [object][5])** located by CSS|XPath|strict locator.
 
-Returns **[Promise][16]&lt;[string][8]>** HTML code for an element
+Returns **[Promise][18]&lt;[string][8]>** HTML code for an element
 
 ### grabHTMLFromAll
 
@@ -1020,7 +1053,7 @@ let postHTMLs = await I.grabHTMLFromAll('.post');
 -   `locator`  
 -   `element` **([string][8] | [object][5])** located by CSS|XPath|strict locator.
 
-Returns **[Promise][16]&lt;[Array][19]&lt;[string][8]>>** HTML code for an element
+Returns **[Promise][18]&lt;[Array][20]&lt;[string][8]>>** HTML code for an element
 
 ### grabNumberOfOpenTabs
 
@@ -1031,7 +1064,7 @@ Resumes test execution, so **should be used inside async function with `await`**
 let tabs = await I.grabNumberOfOpenTabs();
 ```
 
-Returns **[Promise][16]&lt;[number][14]>** number of open tabs
+Returns **[Promise][18]&lt;[number][16]>** number of open tabs
 
 ### grabNumberOfVisibleElements
 
@@ -1046,7 +1079,7 @@ let numOfElements = await I.grabNumberOfVisibleElements('p');
 
 -   `locator` **([string][8] | [object][5])** located by CSS|XPath|strict locator.
 
-Returns **[Promise][16]&lt;[number][14]>** number of visible elements
+Returns **[Promise][18]&lt;[number][16]>** number of visible elements
 
 ### grabPageScrollPosition
 
@@ -1057,7 +1090,7 @@ Resumes test execution, so **should be used inside an async function with `await
 let { x, y } = await I.grabPageScrollPosition();
 ```
 
-Returns **[Promise][16]&lt;PageScrollPosition>** scroll position
+Returns **[Promise][18]&lt;PageScrollPosition>** scroll position
 
 ### grabPopupText
 
@@ -1067,7 +1100,7 @@ Grab the text within the popup. If no popup is visible then it will return null
 await I.grabPopupText();
 ```
 
-Returns **[Promise][16]&lt;([string][8] | null)>** 
+Returns **[Promise][18]&lt;([string][8] | null)>** 
 
 ### grabSource
 
@@ -1078,7 +1111,7 @@ Resumes test execution, so **should be used inside async function with `await`**
 let pageSource = await I.grabSource();
 ```
 
-Returns **[Promise][16]&lt;[string][8]>** source code
+Returns **[Promise][18]&lt;[string][8]>** source code
 
 ### grabTextFrom
 
@@ -1095,7 +1128,7 @@ If multiple elements found returns first element.
 
 -   `locator` **([string][8] | [object][5])** element located by CSS|XPath|strict locator.
 
-Returns **[Promise][16]&lt;[string][8]>** attribute value
+Returns **[Promise][18]&lt;[string][8]>** attribute value
 
 ### grabTextFromAll
 
@@ -1110,7 +1143,7 @@ let pins = await I.grabTextFromAll('#pin li');
 
 -   `locator` **([string][8] | [object][5])** element located by CSS|XPath|strict locator.
 
-Returns **[Promise][16]&lt;[Array][19]&lt;[string][8]>>** attribute value
+Returns **[Promise][18]&lt;[Array][20]&lt;[string][8]>>** attribute value
 
 ### grabTitle
 
@@ -1121,7 +1154,7 @@ Resumes test execution, so **should be used inside async with `await`** operator
 let title = await I.grabTitle();
 ```
 
-Returns **[Promise][16]&lt;[string][8]>** title
+Returns **[Promise][18]&lt;[string][8]>** title
 
 ### grabValueFrom
 
@@ -1137,7 +1170,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][16]&lt;[string][8]>** attribute value
+Returns **[Promise][18]&lt;[string][8]>** attribute value
 
 ### grabValueFromAll
 
@@ -1152,14 +1185,14 @@ let inputs = await I.grabValueFromAll('//form/input');
 
 -   `locator` **([string][8] | [object][5])** field located by label|name|CSS|XPath|strict locator.
 
-Returns **[Promise][16]&lt;[Array][19]&lt;[string][8]>>** attribute value
+Returns **[Promise][18]&lt;[Array][20]&lt;[string][8]>>** attribute value
 
 ### handleDownloads
 
 Handles a file download. A file name is required to save the file on disk.
 Files are saved to "output" directory.
 
-Should be used with [FileSystem helper][21] to check that file were downloaded correctly.
+Should be used with [FileSystem helper][22] to check that file were downloaded correctly.
 
 ```js
 I.handleDownloads('downloads/avatar.jpg');
@@ -1172,7 +1205,7 @@ I.waitForFile('avatar.jpg', 5);
 
 -   `fileName` **[string][8]** set filename for downloaded file
 
-Returns **[Promise][16]&lt;void>** 
+Returns **[Promise][18]&lt;void>** 
 
 ### haveRequestHeaders
 
@@ -1190,7 +1223,7 @@ I.haveRequestHeaders({
 
 ### makeApiRequest
 
-Performs [api request][22] using
+Performs [api request][23] using
 the cookies from the current browser session.
 
 ```js
@@ -1207,22 +1240,22 @@ I.makeApiRequest('PATCH', )
 -   `url` **[string][8]** endpoint
 -   `options` **[object][5]** request options depending on method used
 
-Returns **[Promise][16]&lt;[object][5]>** response
+Returns **[Promise][18]&lt;[object][5]>** response
 
 ### mockRoute
 
-Mocks network request using [`browserContext.route`][23] of Playwright
+Mocks network request using [`browserContext.route`][24] of Playwright
 
 ```js
 I.mockRoute(/(.png$)|(.jpg$)/, route => route.abort());
 ```
 
-This method allows intercepting and mocking requests & responses. [Learn more about it][24]
+This method allows intercepting and mocking requests & responses. [Learn more about it][25]
 
 #### Parameters
 
--   `url` **([string][8] | [RegExp][25])?** URL, regex or pattern for to match URL
--   `handler` **[function][15]?** a function to process reques
+-   `url` **([string][8] | [RegExp][26])?** URL, regex or pattern for to match URL
+-   `handler` **[function][17]?** a function to process reques
 
 ### moveCursorTo
 
@@ -1237,8 +1270,8 @@ I.moveCursorTo('#submit', 5,5);
 #### Parameters
 
 -   `locator` **([string][8] | [object][5])** located by CSS|XPath|strict locator.
--   `offsetX` **[number][14]** (optional, `0` by default) X-axis offset. 
--   `offsetY` **[number][14]** (optional, `0` by default) Y-axis offset.
+-   `offsetX` **[number][16]** (optional, `0` by default) X-axis offset. 
+-   `offsetY` **[number][16]** (optional, `0` by default) Y-axis offset.
     ⚠️ returns a _promise_ which is synchronized internally by recorder 
 
 ### openNewTab
@@ -1249,7 +1282,7 @@ Open new tab and automatically switched to new tab
 I.openNewTab();
 ```
 
-You can pass in [page options][26] to emulate device on this page
+You can pass in [page options][27] to emulate device on this page
 
 ```js
 // enable mobile
@@ -1264,7 +1297,7 @@ I.openNewTab({ isMobile: true });
 
 Presses a key in the browser (on a focused element).
 
-_Hint:_ For populating text field or textarea, it is recommended to use [`fillField`][27].
+_Hint:_ For populating text field or textarea, it is recommended to use [`fillField`][28].
 
 ```js
 I.pressKey('Backspace');
@@ -1323,14 +1356,14 @@ Some of the supported key names are:
 
 #### Parameters
 
--   `key` **([string][8] | [Array][19]&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][28]).
+-   `key` **([string][8] | [Array][20]&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][29]).
 
 ### pressKeyDown
 
 Presses a key in the browser and leaves it in a down state.
 
-To make combinations with modifier key and user operation (e.g. `'Control'` + [`click`][29]).
+To make combinations with modifier key and user operation (e.g. `'Control'` + [`click`][30]).
 
 ```js
 I.pressKeyDown('Control');
@@ -1347,7 +1380,7 @@ I.pressKeyUp('Control');
 
 Releases a key in the browser which was previously set to a down state.
 
-To make combinations with modifier key and user operation (e.g. `'Control'` + [`click`][29]).
+To make combinations with modifier key and user operation (e.g. `'Control'` + [`click`][30]).
 
 ```js
 I.pressKeyDown('Control');
@@ -1377,8 +1410,8 @@ First parameter can be set to `maximize`.
 
 #### Parameters
 
--   `width` **[number][14]** width in pixels or `maximize`.
--   `height` **[number][14]** height in pixels.
+-   `width` **[number][16]** width in pixels or `maximize`.
+-   `height` **[number][16]** 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
@@ -1452,7 +1485,7 @@ I.saveScreenshot('debug.png', true) //resizes to available scrollHeight and scro
 #### Parameters
 
 -   `fileName` **[string][8]** file name to save.
--   `fullPage` **[boolean][30]** (optional, `false` by default) flag to enable fullscreen screenshot mode.
+-   `fullPage` **[boolean][31]** (optional, `false` by default) flag to enable fullscreen screenshot mode.
     ⚠️ returns a _promise_ which is synchronized internally by recorder 
 
 ### scrollPageToBottom
@@ -1488,8 +1521,8 @@ I.scrollTo('#submit', 5, 5);
 #### Parameters
 
 -   `locator` **([string][8] | [object][5])** located by CSS|XPath|strict locator.
--   `offsetX` **[number][14]** (optional, `0` by default) X-axis offset. 
--   `offsetY` **[number][14]** (optional, `0` by default) Y-axis offset.
+-   `offsetX` **[number][16]** (optional, `0` by default) X-axis offset. 
+-   `offsetY` **[number][16]** (optional, `0` by default) Y-axis offset.
     ⚠️ returns a _promise_ which is synchronized internally by recorder 
 
 ### see
@@ -1692,7 +1725,7 @@ I.seeNumberOfElements('#submitBtn', 1);
 #### Parameters
 
 -   `locator` **([string][8] | [object][5])** element located by CSS|XPath|strict locator.
--   `num` **[number][14]** number of elements.
+-   `num` **[number][16]** number of elements.
     ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### seeNumberOfVisibleElements
@@ -1707,7 +1740,7 @@ I.seeNumberOfVisibleElements('.buttons', 3);
 #### Parameters
 
 -   `locator` **([string][8] | [object][5])** element located by CSS|XPath|strict locator.
--   `num` **[number][14]** number of elements.
+-   `num` **[number][16]** number of elements.
     ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### seeTextEquals
@@ -1761,7 +1794,7 @@ 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][19]&lt;any>)** visible text or value of option.
+-   `option` **([string][8] | [Array][20]&lt;any>)** visible text or value of option.
     ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### setCookie
@@ -1782,7 +1815,7 @@ I.setCookie([
 
 #### Parameters
 
--   `cookie` **(Cookie | [Array][19]&lt;Cookie>)** a cookie object or array of cookie objects.
+-   `cookie` **(Cookie | [Array][20]&lt;Cookie>)** a cookie object or array of cookie objects.
     ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### stopMockingRoute
@@ -1798,8 +1831,8 @@ If no handler is passed, all mock requests for the rote are disabled.
 
 #### Parameters
 
--   `url` **([string][8] | [RegExp][25])?** URL, regex or pattern for to match URL
--   `handler` **[function][15]?** a function to process reques
+-   `url` **([string][8] | [RegExp][26])?** URL, regex or pattern for to match URL
+-   `handler` **[function][17]?** a function to process reques
 
 ### switchTo
 
@@ -1826,7 +1859,7 @@ I.switchToNextTab(2);
 
 #### Parameters
 
--   `num` **[number][14]**  
+-   `num` **[number][16]**  
 
 ### switchToPreviousTab
 
@@ -1839,13 +1872,13 @@ I.switchToPreviousTab(2);
 
 #### Parameters
 
--   `num` **[number][14]**  
+-   `num` **[number][16]**  
 
 ### type
 
 Types out the given text into an active field.
 To slow down typing use a second parameter, to set interval between key presses.
-_Note:_ Should be used when [`fillField`][27] is not an option.
+_Note:_ Should be used when [`fillField`][28] is not an option.
 
 ```js
 // passing in a string
@@ -1864,9 +1897,9 @@ I.type(secret('123456'));
 #### Parameters
 
 -   `keys`  
--   `delay` **[number][14]?** (optional) delay in ms between key presses
+-   `delay` **[number][16]?** (optional) delay in ms between key presses
     ⚠️ returns a _promise_ which is synchronized internally by recorder 
--   `key` **([string][8] | [Array][19]&lt;[string][8]>)** or array of keys to type.
+-   `key` **([string][8] | [Array][20]&lt;[string][8]>)** or array of keys to type.
 
 ### uncheckOption
 
@@ -1885,7 +1918,7 @@ I.uncheckOption('agree', '//form');
 
 -   `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][31] for uncheck available as 3rd argument.Examples:```js
+    ⚠️ returns a _promise_ which is synchronized internally by recorder[Additional options][32] 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 
@@ -1898,7 +1931,7 @@ Use Playwright API inside a test.
 First argument is a description of an action.
 Second argument is async function that gets this helper as parameter.
 
-{ [`page`][32], [`browserContext`][33] [`browser`][34] } objects from Playwright API are available.
+{ [`page`][33], [`browserContext`][34] [`browser`][35] } objects from Playwright API are available.
 
 ```js
 I.usePlaywrightTo('emulate offline mode', async ({ browserContext }) => {
@@ -1909,7 +1942,7 @@ I.usePlaywrightTo('emulate offline mode', async ({ browserContext }) => {
 #### Parameters
 
 -   `description` **[string][8]** used to show in logs.
--   `fn` **[function][15]** async function that executed with Playwright helper as argumen
+-   `fn` **[function][17]** async function that executed with Playwright helper as argumen
 
 ### wait
 
@@ -1921,7 +1954,7 @@ I.wait(2); // wait 2 secs
 
 #### Parameters
 
--   `sec` **[number][14]** number of second to wait.
+-   `sec` **[number][16]** number of second to wait.
     ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### waitForClickable
@@ -1938,7 +1971,7 @@ I.waitForClickable('.btn.continue', 5); // wait for 5 secs
 
 -   `locator` **([string][8] | [object][5])** element located by CSS|XPath|strict locator.
 -   `waitTimeout`  
--   `sec` **[number][14]?** (optional, `1` by default) time in seconds to wait
+-   `sec` **[number][16]?** (optional, `1` by default) time in seconds to wait
     ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### waitForDetached
@@ -1953,7 +1986,7 @@ I.waitForDetached('#popup');
 #### Parameters
 
 -   `locator` **([string][8] | [object][5])** element located by CSS|XPath|strict locator.
--   `sec` **[number][14]** (optional, `1` by default) time in seconds to wait
+-   `sec` **[number][16]** (optional, `1` by default) time in seconds to wait
     ⚠️ returns a _promise_ which is synchronized internally by recorder 
 
 ### waitForElement
@@ -1969,7 +2002,7 @@ I.waitForElement('.btn.continue', 5); // wait for 5 secs
 #### Parameters
 
 -   `locator` **([string][8] | [object][5])** element located by CSS|XPath|strict locator.
--   `sec` **[number][14]?** (optional, `1` by default) time in seconds to wait
+-   `sec` **[number][16]?** (optional, `1` by default) time in seconds to wait
     ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### waitForEnabled
@@ -1980,7 +2013,7 @@ Element can be located by CSS or XPath.
 #### Parameters
 
 -   `locator` **([string][8] | [object][5])** element located by CSS|XPath|strict locator.
--   `sec` **[number][14]** (optional) time in seconds to wait, 1 by default.
+-   `sec` **[number][16]** (optional) time in seconds to wait, 1 by default.
     ⚠️ returns a _promise_ which is synchronized internally by recorder 
 
 ### waitForFunction
@@ -2000,9 +2033,9 @@ I.waitForFunction((count) => window.requests == count, [3], 5) // pass args and
 
 #### Parameters
 
--   `fn` **([string][8] | [function][15])** to be executed in browser context.
--   `argsOrSec` **([Array][19]&lt;any> | [number][14])?** (optional, `1` by default) arguments for function or seconds. 
--   `sec` **[number][14]?** (optional, `1` by default) time in seconds to wait
+-   `fn` **([string][8] | [function][17])** to be executed in browser context.
+-   `argsOrSec` **([Array][20]&lt;any> | [number][16])?** (optional, `1` by default) arguments for function or seconds. 
+-   `sec` **[number][16]?** (optional, `1` by default) time in seconds to wait
     ⚠️ returns a _promise_ which is synchronized internally by recorder 
 
 ### waitForInvisible
@@ -2017,14 +2050,14 @@ I.waitForInvisible('#popup');
 #### Parameters
 
 -   `locator` **([string][8] | [object][5])** element located by CSS|XPath|strict locator.
--   `sec` **[number][14]** (optional, `1` by default) time in seconds to wait
+-   `sec` **[number][16]** (optional, `1` by default) time in seconds to wait
     ⚠️ returns a _promise_ which is synchronized internally by recorder 
 
 ### waitForNavigation
 
 Waits for navigation to finish. By default takes configured `waitForNavigation` option.
 
-See [Playwright's reference][35]
+See [Playwright's reference][36]
 
 #### Parameters
 
@@ -2041,8 +2074,8 @@ I.waitForRequest(request => request.url() === 'http://example.com' && request.me
 
 #### Parameters
 
--   `urlOrPredicate` **([string][8] | [function][15])** 
--   `sec` **[number][14]?** seconds to wait 
+-   `urlOrPredicate` **([string][8] | [function][17])** 
+-   `sec` **[number][16]?** seconds to wait 
 
 ### waitForResponse
 
@@ -2055,8 +2088,8 @@ I.waitForResponse(response => response.url() === 'https://example.com' && respon
 
 #### Parameters
 
--   `urlOrPredicate` **([string][8] | [function][15])** 
--   `sec` **[number][14]?** number of seconds to wait 
+-   `urlOrPredicate` **([string][8] | [function][17])** 
+-   `sec` **[number][16]?** number of seconds to wait 
 
 ### waitForText
 
@@ -2072,7 +2105,7 @@ I.waitForText('Thank you, form has been submitted', 5, '#modal');
 #### Parameters
 
 -   `text` **[string][8]** to wait for.
--   `sec` **[number][14]** (optional, `1` by default) time in seconds to wait 
+-   `sec` **[number][16]** (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 
 
@@ -2088,7 +2121,7 @@ I.waitForValue('//input', "GoodValue");
 
 -   `field` **([string][8] | [object][5])** input field.
 -   `value` **[string][8]** expected value.
--   `sec` **[number][14]** (optional, `1` by default) time in seconds to wait
+-   `sec` **[number][16]** (optional, `1` by default) time in seconds to wait
     ⚠️ returns a _promise_ which is synchronized internally by recorder 
 
 ### waitForVisible
@@ -2103,8 +2136,8 @@ I.waitForVisible('#popup');
 #### Parameters
 
 -   `locator` **([string][8] | [object][5])** element located by CSS|XPath|strict locator.
--   `sec` **[number][14]** (optional, `1` by default) time in seconds to wait
-    ⚠️ returns a _promise_ which is synchronized internally by recorderThis method accepts [React selectors][36]. 
+-   `sec` **[number][16]** (optional, `1` by default) time in seconds to wait
+    ⚠️ returns a _promise_ which is synchronized internally by recorderThis method accepts [React selectors][37]. 
 
 ### waitInUrl
 
@@ -2117,7 +2150,7 @@ I.waitInUrl('/info', 2);
 #### Parameters
 
 -   `urlPart` **[string][8]** value to check.
--   `sec` **[number][14]** (optional, `1` by default) time in seconds to wait
+-   `sec` **[number][16]** (optional, `1` by default) time in seconds to wait
     ⚠️ returns a _promise_ which is synchronized internally by recorder 
 
 ### waitNumberOfVisibleElements
@@ -2131,8 +2164,8 @@ I.waitNumberOfVisibleElements('a', 3);
 #### Parameters
 
 -   `locator` **([string][8] | [object][5])** element located by CSS|XPath|strict locator.
--   `num` **[number][14]** number of elements.
--   `sec` **[number][14]** (optional, `1` by default) time in seconds to wait
+-   `num` **[number][16]** number of elements.
+-   `sec` **[number][16]** (optional, `1` by default) time in seconds to wait
     ⚠️ returns a _promise_ which is synchronized internally by recorder 
 
 ### waitToHide
@@ -2147,7 +2180,7 @@ I.waitToHide('#popup');
 #### Parameters
 
 -   `locator` **([string][8] | [object][5])** element located by CSS|XPath|strict locator.
--   `sec` **[number][14]** (optional, `1` by default) time in seconds to wait
+-   `sec` **[number][16]** (optional, `1` by default) time in seconds to wait
     ⚠️ returns a _promise_ which is synchronized internally by recorder 
 
 ### waitUrlEquals
@@ -2162,7 +2195,7 @@ I.waitUrlEquals('http://127.0.0.1:8000/info');
 #### Parameters
 
 -   `urlPart` **[string][8]** value to check.
--   `sec` **[number][14]** (optional, `1` by default) time in seconds to wait
+-   `sec` **[number][16]** (optional, `1` by default) time in seconds to wait
     ⚠️ returns a _promise_ which is synchronized internally by recorder 
 
 [1]: https://github.com/microsoft/playwright
@@ -2181,70 +2214,72 @@ I.waitUrlEquals('http://127.0.0.1:8000/info');
 
 [8]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
 
-[9]: https://playwright.dev/docs/api/class-locator#locator-blur
+[9]: https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus
+
+[10]: https://playwright.dev/docs/api/class-locator#locator-blur
 
-[10]: https://playwright.dev/docs/api/class-elementhandle#element-handle-check
+[11]: https://playwright.dev/docs/api/class-elementhandle#element-handle-check
 
-[11]: https://playwright.dev/docs/api/class-locator#locator-clear
+[12]: https://playwright.dev/docs/actionability
 
-[12]: https://playwright.dev/docs/api/class-page#page-click
+[13]: https://playwright.dev/docs/api/class-locator#locator-clear
 
-[13]: https://playwright.dev/docs/api/class-page#page-drag-and-drop
+[14]: https://playwright.dev/docs/api/class-page#page-click
 
-[14]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
+[15]: https://playwright.dev/docs/api/class-page#page-drag-and-drop
 
-[15]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function
+[16]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
 
-[16]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise
+[17]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function
 
-[17]: https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus
+[18]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise
 
-[18]: https://playwright.dev/docs/api/class-locator#locator-focus
+[19]: https://playwright.dev/docs/api/class-locator#locator-focus
 
-[19]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
+[20]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
 
-[20]: https://playwright.dev/docs/api/class-consolemessage
+[21]: https://playwright.dev/docs/api/class-consolemessage
 
-[21]: https://codecept.io/helpers/FileSystem
+[22]: https://codecept.io/helpers/FileSystem
 
-[22]: https://playwright.dev/docs/api/class-apirequestcontext#api-request-context-get
+[23]: https://playwright.dev/docs/api/class-apirequestcontext#api-request-context-get
 
-[23]: https://playwright.dev/docs/api/class-browsercontext#browser-context-route
+[24]: https://playwright.dev/docs/api/class-browsercontext#browser-context-route
 
-[24]: https://playwright.dev/docs/network#handle-requests
+[25]: https://playwright.dev/docs/network#handle-requests
 
-[25]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/RegExp
+[26]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/RegExp
 
-[26]: https://github.com/microsoft/playwright/blob/main/docs/api.md#browsernewpageoptions
+[27]: https://github.com/microsoft/playwright/blob/main/docs/api.md#browsernewpageoptions
 
-[27]: #fillfield
+[28]: #fillfield
 
-[28]: https://github.com/GoogleChrome/puppeteer/issues/1313
+[29]: https://github.com/GoogleChrome/puppeteer/issues/1313
 
-[29]: #click
+[30]: #click
 
-[30]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
+[31]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
 
-[31]: https://playwright.dev/docs/api/class-elementhandle#element-handle-uncheck
+[32]: https://playwright.dev/docs/api/class-elementhandle#element-handle-uncheck
 
-[32]: https://github.com/microsoft/playwright/blob/main/docs/src/api/class-page.md
+[33]: https://github.com/microsoft/playwright/blob/main/docs/src/api/class-page.md
 
-[33]: https://github.com/microsoft/playwright/blob/main/docs/src/api/class-browsercontext.md
+[34]: https://github.com/microsoft/playwright/blob/main/docs/src/api/class-browsercontext.md
 
-[34]: https://github.com/microsoft/playwright/blob/main/docs/src/api/class-browser.md
+[35]: https://github.com/microsoft/playwright/blob/main/docs/src/api/class-browser.md
 
-[35]: https://playwright.dev/docs/api/class-page?_highlight=waitfornavi#pagewaitfornavigationoptions
+[36]: https://playwright.dev/docs/api/class-page?_highlight=waitfornavi#pagewaitfornavigationoptions
 
-[36]: https://codecept.io/react
+[37]: https://codecept.io/react
 
-[37]: https://playwright.dev/docs/api/class-browsercontext
+[38]: https://playwright.dev/docs/api/class-browsercontext
 
-[38]: https://playwright.dev/docs/api/class-page#page-set-default-timeout
+[39]: https://playwright.dev/docs/api/class-page#page-set-default-timeout
 
-[39]: https://playwright.dev/docs/trace-viewer
+[40]: https://playwright.dev/docs/trace-viewer
 
-[40]: https://playwright.dev/docs/api/class-page#page-wait-for-navigation
+[41]: https://playwright.dev/docs/api/class-page#page-wait-for-navigation
 
-[41]: https://playwright.dev/docs/browsers/#google-chrome--microsoft-edge
+[42]: https://playwright.dev/docs/browsers/#google-chrome--microsoft-edge
 
-[42]: https://playwright.dev/docs/api/class-consolemessage#console-message-type
+[43]: https://playwright.dev/docs/api/class-consolemessage#console-message-type