codeceptjs 3.5.4-beta.1 → 3.5.4

package/docs/helpers/Playwright.md

@@ -42,25 +42,25 @@ Type: [object][5]
 -   `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][32]?** show browser window.
--   `restart` **([string][8] | [boolean][32])?** restart strategy between tests. Possible values:-   'context' or **false** - restarts [browser context][39] but keeps running browser. Recommended by Playwright team to keep tests isolated.
+-   `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][18]?** -   [timeout][40] in ms of all Playwright actions .
+-   `timeout` **[number][19]?** -   [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
 -   `keepVideoForPassedTests` **[boolean][32]?** save videos for passed tests; videos are saved into `output/videos` folder
--   `trace` **[boolean][32]?** record [tracing information][41] with screenshots and snapshots.
+-   `trace` **[boolean][32]?** record [tracing information][42] with screenshots and snapshots.
 -   `keepTraceForPassedTests` **[boolean][32]?** save trace for passed tests.
 -   `fullPageScreenshots` **[boolean][32]?** make full page screenshots on failure.
 -   `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][18]?** 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][42].
--   `pressKeyDelay` **[number][18]?** Delay between key presses in ms. Used when calling Playwrights page.type(...) in fillField/appendField
--   `getPageTimeout` **[number][18]?** config option to set maximum navigation time in milliseconds.
--   `waitForTimeout` **[number][18]?** default wait* timeout in ms. Default: 1000.
+-   `waitForAction` **[number][19]?** 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.
 -   `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][22]<[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][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].
 -   `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
+-   `highlightElement` **[boolean][32]?** highlight the interacting elements. Default: false
 
 
 
@@ -165,6 +165,7 @@ Traces will be saved to `output/trace`
      url: "http://localhost",
      show: true // headless mode not supported for extensions
      chromium: {
+       // Note: due to this would launch persistent context, so to avoid the error when running tests with run-workers a timestamp would be appended to the defined folder name. For instance: playwright-tmp_1692715649511
        userDataDir: '/tmp/playwright-tmp', // necessary to launch the browser in normal mode instead of incognito,
        args: [
           `--disable-extensions-except=${pathToExtension}`,
@@ -437,7 +438,7 @@ I.attachFile('form input[name=avatar]', 'data/avatar.jpg');
 
 ### blockTraffic
 
-Blocks traffic for URL.
+Blocks traffic of a given URL or a list of URLs.
 
 Examples:
 
@@ -448,14 +449,18 @@ I.blockTraffic('http://example.com/**');
 I.blockTraffic(/.css$/);
 ```
 
+```js
+I.blockTraffic(['http://example.com/css/style.css', 'http://example.com/css/*.css']);
+```
+
 #### Parameters
 
--   `url`  URL to block . URL can contain * for wildcards. Example: [https://www.example.com**][9] to block all traffic for that domain. Regexp are also supported.
+-   `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.
 
 ### blur
 
 Remove focus from a text input, button, etc.
-Calls [blur][10] on the element.
+Calls [blur][12] on the element.
 
 Examples:
 
@@ -473,7 +478,7 @@ 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][11] for available options object as 2nd argument. 
+-   `options` **any?** Playwright only: [Additional options][13] for available options object as 2nd argument. 
 
 ### cancelPopup
 
@@ -496,7 +501,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][12] for check available as 3rd argument.Examples:```js
+    ⚠️ 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 
@@ -530,12 +535,12 @@ I.clearField('.text-area')
 I.clearField('#submit', { force: true })
 ```
 
-Use `force` to bypass the [actionability][13] checks.
+Use `force` to bypass the [actionability][15] checks.
 
 #### Parameters
 
 -   `locator` **([string][8] | [object][5])** field located by label|name|CSS|XPath|strict locator.
--   `options` **any?** [Additional options][14] for available options object as 2nd argument. 
+-   `options` **any?** [Additional options][16] for available options object as 2nd argument. 
 
 ### click
 
@@ -566,7 +571,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][15] for click available as 3rd argument.Examples:```js
+-   `options` **any?** [Additional options][17] for click available as 3rd argument.Examples:```js
     // click on element at position
     I.click('canvas', '.model', { position: { x: 20, y: 40 } })
 
@@ -706,7 +711,7 @@ I.dontSeeInField({ css: 'form input.email' }, 'user@user.com'); // field by CSS
 #### Parameters
 
 -   `field` **([string][8] | [object][5])** located by label|name|CSS|XPath|strict locator.
--   `value` **[string][8]** value to check.
+-   `value` **([string][8] | [object][5])** value to check.
     ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### dontSeeInSource
@@ -751,7 +756,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][16])** Expected URL of request in network traffic. Can be a string or a regular expression.
+    -   `opts.url` **([string][8] | [RegExp][10])** Expected URL of request in network traffic. Can be a string or a regular expression.
 
 ### doubleClick
 
@@ -784,7 +789,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][17] can be passed as 3rd argument.```js
+-   `options` **any?** [Additional options][18] 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`
@@ -802,7 +807,7 @@ I.dragSlider('#slider', -70);
 #### Parameters
 
 -   `locator` **([string][8] | [object][5])** located by label|name|CSS|XPath|strict locator.
--   `offsetX` **[number][18]** position to drag.
+-   `offsetX` **[number][19]** position to drag.
     ⚠️ returns a _promise_ which is synchronized internally by recorder 
 
 ### executeScript
@@ -830,10 +835,10 @@ If a function returns a Promise it will wait for its resolution.
 
 #### Parameters
 
--   `fn` **([string][8] | [function][19])** function to be executed in browser context.
+-   `fn` **([string][8] | [function][20])** function to be executed in browser context.
 -   `arg` **any?** optional argument to pass to the function
 
-Returns **[Promise][20]<any>** 
+Returns **[Promise][21]<any>** 
 
 ### fillField
 
@@ -861,9 +866,13 @@ I.fillField({css: 'form#login input[name=username]'}, 'John');
 
 Resets all recorded network requests.
 
+### flushWebSocketMessages
+
+Resets all recorded WS messages.
+
 ### focus
 
-Calls [focus][10] on the matching element.
+Calls [focus][12] on the matching element.
 
 Examples:
 
@@ -876,7 +885,7 @@ I.see('#add-to-cart-bnt');
 #### Parameters
 
 -   `locator` **([string][8] | [object][5])** field located by label|name|CSS|XPath|strict locator.
--   `options` **any?** Playwright only: [Additional options][21] for available options object as 2nd argument. 
+-   `options` **any?** Playwright only: [Additional options][22] for available options object as 2nd argument. 
 
 ### forceClick
 
@@ -926,7 +935,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][20]<[string][8]>** attribute value
+Returns **[Promise][21]<[string][8]>** attribute value
 
 ### grabAttributeFromAll
 
@@ -942,7 +951,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][20]<[Array][22]<[string][8]>>** attribute value
+Returns **[Promise][21]<[Array][9]<[string][8]>>** attribute value
 
 ### grabBrowserLogs
 
@@ -956,7 +965,7 @@ console.log(JSON.stringify(errors));
 
 [Learn more about console messages][23]
 
-Returns **[Promise][20]<[Array][22]<any>>** 
+Returns **[Promise][21]<[Array][9]<any>>** 
 
 ### grabCookie
 
@@ -973,7 +982,7 @@ assert(cookie.value, '123456');
 
 -   `name` **[string][8]?** cookie name. 
 
-Returns **([Promise][20]<[string][8]> | [Promise][20]<[Array][22]<[string][8]>>)** attribute valueReturns cookie in JSON format. If name not passed returns all cookies for this domain.
+Returns **([Promise][21]<[string][8]> | [Promise][21]<[Array][9]<[string][8]>>)** attribute valueReturns cookie in JSON format. If name not passed returns all cookies for this domain.
 
 ### grabCssPropertyFrom
 
@@ -990,7 +999,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][20]<[string][8]>** CSS value
+Returns **[Promise][21]<[string][8]>** CSS value
 
 ### grabCssPropertyFromAll
 
@@ -1006,7 +1015,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][20]<[Array][22]<[string][8]>>** CSS value
+Returns **[Promise][21]<[Array][9]<[string][8]>>** CSS value
 
 ### grabCurrentUrl
 
@@ -1018,7 +1027,7 @@ let url = await I.grabCurrentUrl();
 console.log(`Current URL is [${url}]`);
 ```
 
-Returns **[Promise][20]<[string][8]>** current URL
+Returns **[Promise][21]<[string][8]>** current URL
 
 ### grabDataFromPerformanceTiming
 
@@ -1043,7 +1052,7 @@ let data = await I.grabDataFromPerformanceTiming();
 }
 ```
 
-Returns **[Promise][20]<any>** automatically synchronized promise through #recorder
+Returns **[Promise][21]<any>** automatically synchronized promise through #recorder
 
 ### grabElementBoundingRect
 
@@ -1071,7 +1080,7 @@ const width = await I.grabElementBoundingRect('h3', 'width');
 -   `prop`  
 -   `elementSize` **[string][8]?** x, y, width or height of the given element.
 
-Returns **([Promise][20]<DOMRect> | [Promise][20]<[number][18]>)** Element bounding rectangle
+Returns **([Promise][21]<DOMRect> | [Promise][21]<[number][19]>)** Element bounding rectangle
 
 ### grabHTMLFrom
 
@@ -1088,7 +1097,7 @@ let postHTML = await I.grabHTMLFrom('#post');
 -   `locator`  
 -   `element` **([string][8] | [object][5])** located by CSS|XPath|strict locator.
 
-Returns **[Promise][20]<[string][8]>** HTML code for an element
+Returns **[Promise][21]<[string][8]>** HTML code for an element
 
 ### grabHTMLFromAll
 
@@ -1104,7 +1113,61 @@ let postHTMLs = await I.grabHTMLFromAll('.post');
 -   `locator`  
 -   `element` **([string][8] | [object][5])** located by CSS|XPath|strict locator.
 
-Returns **[Promise][20]<[Array][22]<[string][8]>>** HTML code for an element
+Returns **[Promise][21]<[Array][9]<[string][8]>>** HTML code for an element
+
+### grabMetrics
+
+Return a performance metric from the chrome cdp session.
+Note: Chrome-only
+
+Examples:
+
+```js
+const metrics = await I.grabMetrics();
+
+// returned metrics
+
+[
+  { name: 'Timestamp', value: 1584904.203473 },
+  { name: 'AudioHandlers', value: 0 },
+  { name: 'AudioWorkletProcessors', value: 0 },
+  { name: 'Documents', value: 22 },
+  { name: 'Frames', value: 10 },
+  { name: 'JSEventListeners', value: 366 },
+  { name: 'LayoutObjects', value: 1240 },
+  { name: 'MediaKeySessions', value: 0 },
+  { name: 'MediaKeys', value: 0 },
+  { name: 'Nodes', value: 4505 },
+  { name: 'Resources', value: 141 },
+  { name: 'ContextLifecycleStateObservers', value: 34 },
+  { name: 'V8PerContextDatas', value: 4 },
+  { name: 'WorkerGlobalScopes', value: 0 },
+  { name: 'UACSSResources', value: 0 },
+  { name: 'RTCPeerConnections', value: 0 },
+  { name: 'ResourceFetchers', value: 22 },
+  { name: 'AdSubframes', value: 0 },
+  { name: 'DetachedScriptStates', value: 2 },
+  { name: 'ArrayBufferContents', value: 1 },
+  { name: 'LayoutCount', value: 0 },
+  { name: 'RecalcStyleCount', value: 0 },
+  { name: 'LayoutDuration', value: 0 },
+  { name: 'RecalcStyleDuration', value: 0 },
+  { name: 'DevToolsCommandDuration', value: 0.000013 },
+  { name: 'ScriptDuration', value: 0 },
+  { name: 'V8CompileDuration', value: 0 },
+  { name: 'TaskDuration', value: 0.000014 },
+  { name: 'TaskOtherDuration', value: 0.000001 },
+  { name: 'ThreadTime', value: 0.000046 },
+  { name: 'ProcessTime', value: 0.616852 },
+  { name: 'JSHeapUsedSize', value: 19004908 },
+  { name: 'JSHeapTotalSize', value: 26820608 },
+  { name: 'FirstMeaningfulPaint', value: 0 },
+  { name: 'DomContentLoaded', value: 1584903.690491 },
+  { name: 'NavigationStart', value: 1584902.841845 }
+]
+```
+
+Returns **[Promise][21]<[Array][9]<[Object][5]>>** 
 
 ### grabNumberOfOpenTabs
 
@@ -1115,7 +1178,7 @@ Resumes test execution, so **should be used inside async function with `await`**
 let tabs = await I.grabNumberOfOpenTabs();
 ```
 
-Returns **[Promise][20]<[number][18]>** number of open tabs
+Returns **[Promise][21]<[number][19]>** number of open tabs
 
 ### grabNumberOfVisibleElements
 
@@ -1130,7 +1193,7 @@ let numOfElements = await I.grabNumberOfVisibleElements('p');
 
 -   `locator` **([string][8] | [object][5])** located by CSS|XPath|strict locator.
 
-Returns **[Promise][20]<[number][18]>** number of visible elements
+Returns **[Promise][21]<[number][19]>** number of visible elements
 
 ### grabPageScrollPosition
 
@@ -1141,7 +1204,7 @@ Resumes test execution, so **should be used inside an async function with `await
 let { x, y } = await I.grabPageScrollPosition();
 ```
 
-Returns **[Promise][20]<PageScrollPosition>** scroll position
+Returns **[Promise][21]<PageScrollPosition>** scroll position
 
 ### grabPopupText
 
@@ -1151,13 +1214,20 @@ Grab the text within the popup. If no popup is visible then it will return null
 await I.grabPopupText();
 ```
 
-Returns **[Promise][20]<([string][8] | null)>** 
+Returns **[Promise][21]<([string][8] | null)>** 
 
 ### grabRecordedNetworkTraffics
 
 Grab the recording network traffics
 
-Returns **[Array][22]<any>** 
+```js
+const traffics = await I.grabRecordedNetworkTraffics();
+expect(traffics[0].url).to.equal('https://reqres.in/api/comments/1');
+expect(traffics[0].response.status).to.equal(200);
+expect(traffics[0].response.body).to.contain({ name: 'this was mocked' });
+```
+
+Returns **[Promise][21]<[Array][9]<any>>** 
 
 ### grabSource
 
@@ -1168,7 +1238,7 @@ Resumes test execution, so **should be used inside async function with `await`**
 let pageSource = await I.grabSource();
 ```
 
-Returns **[Promise][20]<[string][8]>** source code
+Returns **[Promise][21]<[string][8]>** source code
 
 ### grabTextFrom
 
@@ -1185,7 +1255,7 @@ If multiple elements found returns first element.
 
 -   `locator` **([string][8] | [object][5])** element located by CSS|XPath|strict locator.
 
-Returns **[Promise][20]<[string][8]>** attribute value
+Returns **[Promise][21]<[string][8]>** attribute value
 
 ### grabTextFromAll
 
@@ -1200,7 +1270,7 @@ let pins = await I.grabTextFromAll('#pin li');
 
 -   `locator` **([string][8] | [object][5])** element located by CSS|XPath|strict locator.
 
-Returns **[Promise][20]<[Array][22]<[string][8]>>** attribute value
+Returns **[Promise][21]<[Array][9]<[string][8]>>** attribute value
 
 ### grabTitle
 
@@ -1211,7 +1281,7 @@ Resumes test execution, so **should be used inside async with `await`** operator
 let title = await I.grabTitle();
 ```
 
-Returns **[Promise][20]<[string][8]>** title
+Returns **[Promise][21]<[string][8]>** title
 
 ### grabTrafficUrl
 
@@ -1219,12 +1289,12 @@ Returns full URL of request matching parameter "urlMatch".
 
 #### Parameters
 
--   `urlMatch` **([string][8] | [RegExp][16])** Expected URL of request in network traffic. Can be a string or a regular expression.Examples:```js
+-   `urlMatch` **([string][8] | [RegExp][10])** 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][20]<any>** 
+Returns **[Promise][21]<any>** 
 
 ### grabValueFrom
 
@@ -1240,7 +1310,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][20]<[string][8]>** attribute value
+Returns **[Promise][21]<[string][8]>** attribute value
 
 ### grabValueFromAll
 
@@ -1255,7 +1325,13 @@ let inputs = await I.grabValueFromAll('//form/input');
 
 -   `locator` **([string][8] | [object][5])** field located by label|name|CSS|XPath|strict locator.
 
-Returns **[Promise][20]<[Array][22]<[string][8]>>** attribute value
+Returns **[Promise][21]<[Array][9]<[string][8]>>** attribute value
+
+### grabWebSocketMessages
+
+Grab the recording WS messages
+
+Returns **[Array][9]<any>** 
 
 ### handleDownloads
 
@@ -1275,7 +1351,7 @@ I.waitForFile('avatar.jpg', 5);
 
 -   `fileName` **[string][8]** set filename for downloaded file
 
-Returns **[Promise][20]<void>** 
+Returns **[Promise][21]<void>** 
 
 ### haveRequestHeaders
 
@@ -1310,7 +1386,7 @@ I.makeApiRequest('PATCH', )
 -   `url` **[string][8]** endpoint
 -   `options` **[object][5]** request options depending on method used
 
-Returns **[Promise][20]<[object][5]>** response
+Returns **[Promise][21]<[object][5]>** response
 
 ### mockRoute
 
@@ -1324,8 +1400,8 @@ This method allows intercepting and mocking requests & responses. [Learn more ab
 
 #### Parameters
 
--   `url` **([string][8] | [RegExp][16])?** URL, regex or pattern for to match URL
--   `handler` **[function][19]?** a function to process reques
+-   `url` **([string][8] | [RegExp][10])?** URL, regex or pattern for to match URL
+-   `handler` **[function][20]?** a function to process reques
 
 ### mockTraffic
 
@@ -1359,8 +1435,8 @@ I.moveCursorTo('#submit', 5,5);
 #### Parameters
 
 -   `locator` **([string][8] | [object][5])** located by CSS|XPath|strict locator.
--   `offsetX` **[number][18]** (optional, `0` by default) X-axis offset. 
--   `offsetY` **[number][18]** (optional, `0` by default) Y-axis offset.
+-   `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 
 
 ### openNewTab
@@ -1445,7 +1521,7 @@ Some of the supported key names are:
 
 #### Parameters
 
--   `key` **([string][8] | [Array][22]<[string][8]>)** key or array of keys to press.
+-   `key` **([string][8] | [Array][9]<[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]).
 
 ### pressKeyDown
@@ -1499,8 +1575,8 @@ First parameter can be set to `maximize`.
 
 #### Parameters
 
--   `width` **[number][18]** width in pixels or `maximize`.
--   `height` **[number][18]** height in pixels.
+-   `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
@@ -1610,8 +1686,8 @@ I.scrollTo('#submit', 5, 5);
 #### Parameters
 
 -   `locator` **([string][8] | [object][5])** located by CSS|XPath|strict locator.
--   `offsetX` **[number][18]** (optional, `0` by default) X-axis offset. 
--   `offsetY` **[number][18]** (optional, `0` by default) Y-axis offset.
+-   `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 
 
 ### see
@@ -1759,7 +1835,7 @@ I.seeInField('#searchform input','Search');
 #### Parameters
 
 -   `field` **([string][8] | [object][5])** located by label|name|CSS|XPath|strict locator.
--   `value` **[string][8]** value to check.
+-   `value` **([string][8] | [object][5])** value to check.
     ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### seeInPopup
@@ -1814,7 +1890,7 @@ I.seeNumberOfElements('#submitBtn', 1);
 #### Parameters
 
 -   `locator` **([string][8] | [object][5])** element located by CSS|XPath|strict locator.
--   `num` **[number][18]** number of elements.
+-   `num` **[number][19]** number of elements.
     ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### seeNumberOfVisibleElements
@@ -1829,7 +1905,7 @@ I.seeNumberOfVisibleElements('.buttons', 3);
 #### Parameters
 
 -   `locator` **([string][8] | [object][5])** element located by CSS|XPath|strict locator.
--   `num` **[number][18]** number of elements.
+-   `num` **[number][19]** number of elements.
     ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### seeTextEquals
@@ -1897,9 +1973,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][18]?** Timeout to wait for request in seconds. Default is 10 seconds. 
+    -   `opts.timeout` **[number][19]?** Timeout to wait for request in seconds. Default is 10 seconds. 
 
-Returns **[Promise][20]<any>** 
+Returns **[Promise][21]<any>** 
 
 ### selectOption
 
@@ -1925,7 +2001,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][22]<any>)** visible text or value of option.
+-   `option` **([string][8] | [Array][9]<any>)** visible text or value of option.
     ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### setCookie
@@ -1946,19 +2022,28 @@ I.setCookie([
 
 #### Parameters
 
--   `cookie` **(Cookie | [Array][22]<Cookie>)** a cookie object or array of cookie objects.
+-   `cookie` **(Cookie | [Array][9]<Cookie>)** a cookie object or array of cookie objects.
     ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### startRecordingTraffic
 
-Starts recording of network traffic.
+Starts recording the network traffics.
 This also resets recorded network requests.
 
 ```js
 I.startRecordingTraffic();
 ```
 
-Returns **[Promise][20]<void>** 
+Returns **void** 
+
+### startRecordingWebSocketMessages
+
+Starts recording of websocket messages.
+This also resets recorded websocket messages.
+
+```js
+await I.startRecordingWebSocketMessages();
+```
 
 ### stopMockingRoute
 
@@ -1973,8 +2058,8 @@ If no handler is passed, all mock requests for the rote are disabled.
 
 #### Parameters
 
--   `url` **([string][8] | [RegExp][16])?** URL, regex or pattern for to match URL
--   `handler` **[function][19]?** a function to process reques
+-   `url` **([string][8] | [RegExp][10])?** URL, regex or pattern for to match URL
+-   `handler` **[function][20]?** a function to process reques
 
 ### stopRecordingTraffic
 
@@ -1984,6 +2069,14 @@ Stops recording of network traffic. Recorded traffic is not flashed.
 I.stopRecordingTraffic();
 ```
 
+### stopRecordingWebSocketMessages
+
+Stops recording WS messages. Recorded WS messages is not flashed.
+
+```js
+await I.stopRecordingWebSocketMessages();
+```
+
 ### switchTo
 
 Switches frame or in case of null locator reverts to parent.
@@ -2009,7 +2102,7 @@ I.switchToNextTab(2);
 
 #### Parameters
 
--   `num` **[number][18]**  
+-   `num` **[number][19]**  
 
 ### switchToPreviousTab
 
@@ -2022,7 +2115,7 @@ I.switchToPreviousTab(2);
 
 #### Parameters
 
--   `num` **[number][18]**  
+-   `num` **[number][19]**  
 
 ### type
 
@@ -2047,9 +2140,9 @@ I.type(secret('123456'));
 #### Parameters
 
 -   `keys`  
--   `delay` **[number][18]?** (optional) delay in ms between key presses
+-   `delay` **[number][19]?** (optional) delay in ms between key presses
     ⚠️ returns a _promise_ which is synchronized internally by recorder 
--   `key` **([string][8] | [Array][22]<[string][8]>)** or array of keys to type.
+-   `key` **([string][8] | [Array][9]<[string][8]>)** or array of keys to type.
 
 ### uncheckOption
 
@@ -2092,7 +2185,7 @@ I.usePlaywrightTo('emulate offline mode', async ({ browserContext }) => {
 #### Parameters
 
 -   `description` **[string][8]** used to show in logs.
--   `fn` **[function][19]** async function that executed with Playwright helper as argumen
+-   `fn` **[function][20]** async function that executed with Playwright helper as argumen
 
 ### wait
 
@@ -2104,7 +2197,7 @@ I.wait(2); // wait 2 secs
 
 #### Parameters
 
--   `sec` **[number][18]** number of second to wait.
+-   `sec` **[number][19]** number of second to wait.
     ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### waitForClickable
@@ -2121,7 +2214,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][18]?** (optional, `1` by default) time in seconds to wait
+-   `sec` **[number][19]?** (optional, `1` by default) time in seconds to wait
     ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### waitForDetached
@@ -2136,7 +2229,7 @@ I.waitForDetached('#popup');
 #### Parameters
 
 -   `locator` **([string][8] | [object][5])** element located by CSS|XPath|strict locator.
--   `sec` **[number][18]** (optional, `1` by default) time in seconds to wait
+-   `sec` **[number][19]** (optional, `1` by default) time in seconds to wait
     ⚠️ returns a _promise_ which is synchronized internally by recorder 
 
 ### waitForElement
@@ -2152,7 +2245,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][18]?** (optional, `1` by default) time in seconds to wait
+-   `sec` **[number][19]?** (optional, `1` by default) time in seconds to wait
     ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### waitForEnabled
@@ -2163,7 +2256,7 @@ Element can be located by CSS or XPath.
 #### Parameters
 
 -   `locator` **([string][8] | [object][5])** element located by CSS|XPath|strict locator.
--   `sec` **[number][18]** (optional) time in seconds to wait, 1 by default.
+-   `sec` **[number][19]** (optional) time in seconds to wait, 1 by default.
     ⚠️ returns a _promise_ which is synchronized internally by recorder 
 
 ### waitForFunction
@@ -2183,9 +2276,9 @@ I.waitForFunction((count) => window.requests == count, [3], 5) // pass args and
 
 #### Parameters
 
--   `fn` **([string][8] | [function][19])** to be executed in browser context.
--   `argsOrSec` **([Array][22]<any> | [number][18])?** (optional, `1` by default) arguments for function or seconds. 
--   `sec` **[number][18]?** (optional, `1` by default) time in seconds to wait
+-   `fn` **([string][8] | [function][20])** to be executed in browser context.
+-   `argsOrSec` **([Array][9]<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 
 
 ### waitForInvisible
@@ -2200,12 +2293,12 @@ I.waitForInvisible('#popup');
 #### Parameters
 
 -   `locator` **([string][8] | [object][5])** element located by CSS|XPath|strict locator.
--   `sec` **[number][18]** (optional, `1` by default) time in seconds to wait
+-   `sec` **[number][19]** (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.
+Waits for navigation to finish. By default, it takes configured `waitForNavigation` option.
 
 See [Playwright's reference][37]
 
@@ -2224,8 +2317,8 @@ I.waitForRequest(request => request.url() === 'http://example.com' && request.me
 
 #### Parameters
 
--   `urlOrPredicate` **([string][8] | [function][19])** 
--   `sec` **[number][18]?** seconds to wait 
+-   `urlOrPredicate` **([string][8] | [function][20])** 
+-   `sec` **[number][19]?** seconds to wait 
 
 ### waitForResponse
 
@@ -2238,8 +2331,8 @@ I.waitForResponse(response => response.url() === 'https://example.com' && respon
 
 #### Parameters
 
--   `urlOrPredicate` **([string][8] | [function][19])** 
--   `sec` **[number][18]?** number of seconds to wait 
+-   `urlOrPredicate` **([string][8] | [function][20])** 
+-   `sec` **[number][19]?** number of seconds to wait 
 
 ### waitForText
 
@@ -2255,10 +2348,21 @@ I.waitForText('Thank you, form has been submitted', 5, '#modal');
 #### Parameters
 
 -   `text` **[string][8]** to wait for.
--   `sec` **[number][18]** (optional, `1` by default) time in seconds to wait 
+-   `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 
 
+### waitForURL
+
+Waits for page navigates to a new URL or reloads. By default, it takes configured `waitForNavigation` option.
+
+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.
+-   `options` **any**  
+
 ### waitForValue
 
 Waits for the specified value to be in value attribute.
@@ -2271,7 +2375,7 @@ I.waitForValue('//input', "GoodValue");
 
 -   `field` **([string][8] | [object][5])** input field.
 -   `value` **[string][8]** expected value.
--   `sec` **[number][18]** (optional, `1` by default) time in seconds to wait
+-   `sec` **[number][19]** (optional, `1` by default) time in seconds to wait
     ⚠️ returns a _promise_ which is synchronized internally by recorder 
 
 ### waitForVisible
@@ -2286,8 +2390,8 @@ I.waitForVisible('#popup');
 #### Parameters
 
 -   `locator` **([string][8] | [object][5])** element located by CSS|XPath|strict locator.
--   `sec` **[number][18]** (optional, `1` by default) time in seconds to wait
-    ⚠️ returns a _promise_ which is synchronized internally by recorderThis method accepts [React selectors][38]. 
+-   `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]. 
 
 ### waitInUrl
 
@@ -2300,7 +2404,7 @@ I.waitInUrl('/info', 2);
 #### Parameters
 
 -   `urlPart` **[string][8]** value to check.
--   `sec` **[number][18]** (optional, `1` by default) time in seconds to wait
+-   `sec` **[number][19]** (optional, `1` by default) time in seconds to wait
     ⚠️ returns a _promise_ which is synchronized internally by recorder 
 
 ### waitNumberOfVisibleElements
@@ -2314,8 +2418,8 @@ I.waitNumberOfVisibleElements('a', 3);
 #### Parameters
 
 -   `locator` **([string][8] | [object][5])** element located by CSS|XPath|strict locator.
--   `num` **[number][18]** number of elements.
--   `sec` **[number][18]** (optional, `1` by default) time in seconds to wait
+-   `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 
 
 ### waitToHide
@@ -2330,7 +2434,7 @@ I.waitToHide('#popup');
 #### Parameters
 
 -   `locator` **([string][8] | [object][5])** element located by CSS|XPath|strict locator.
--   `sec` **[number][18]** (optional, `1` by default) time in seconds to wait
+-   `sec` **[number][19]** (optional, `1` by default) time in seconds to wait
     ⚠️ returns a _promise_ which is synchronized internally by recorder 
 
 ### waitUrlEquals
@@ -2345,7 +2449,7 @@ I.waitUrlEquals('http://127.0.0.1:8000/info');
 #### Parameters
 
 -   `urlPart` **[string][8]** value to check.
--   `sec` **[number][18]** (optional, `1` by default) time in seconds to wait
+-   `sec` **[number][19]** (optional, `1` by default) time in seconds to wait
     ⚠️ returns a _promise_ which is synchronized internally by recorder 
 
 [1]: https://github.com/microsoft/playwright
@@ -2364,33 +2468,33 @@ I.waitUrlEquals('http://127.0.0.1:8000/info');
 
 [8]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
 
-[9]: https://www.example.com**
+[9]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
 
-[10]: https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus
+[10]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/RegExp
 
-[11]: https://playwright.dev/docs/api/class-locator#locator-blur
+[11]: https://www.example.com**
 
-[12]: https://playwright.dev/docs/api/class-elementhandle#element-handle-check
+[12]: https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus
 
-[13]: https://playwright.dev/docs/actionability
+[13]: https://playwright.dev/docs/api/class-locator#locator-blur
 
-[14]: https://playwright.dev/docs/api/class-locator#locator-clear
+[14]: https://playwright.dev/docs/api/class-elementhandle#element-handle-check
 
-[15]: https://playwright.dev/docs/api/class-page#page-click
+[15]: https://playwright.dev/docs/actionability
 
-[16]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/RegExp
+[16]: https://playwright.dev/docs/api/class-locator#locator-clear
 
-[17]: https://playwright.dev/docs/api/class-page#page-drag-and-drop
+[17]: https://playwright.dev/docs/api/class-page#page-click
 
-[18]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
+[18]: https://playwright.dev/docs/api/class-page#page-drag-and-drop
 
-[19]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function
+[19]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
 
-[20]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise
+[20]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function
 
-[21]: https://playwright.dev/docs/api/class-locator#locator-focus
+[21]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise
 
-[22]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
+[22]: https://playwright.dev/docs/api/class-locator#locator-focus
 
 [23]: https://playwright.dev/docs/api/class-consolemessage
 
@@ -2422,15 +2526,15 @@ I.waitUrlEquals('http://127.0.0.1:8000/info');
 
 [37]: https://playwright.dev/docs/api/class-page?_highlight=waitfornavi#pagewaitfornavigationoptions
 
-[38]: https://codecept.io/react
+[38]: https://playwright.dev/docs/api/class-page#page-wait-for-url
 
-[39]: https://playwright.dev/docs/api/class-browsercontext
+[39]: https://codecept.io/react
 
-[40]: https://playwright.dev/docs/api/class-page#page-set-default-timeout
+[40]: https://playwright.dev/docs/api/class-browsercontext
 
-[41]: https://playwright.dev/docs/trace-viewer
+[41]: https://playwright.dev/docs/api/class-page#page-set-default-timeout
 
-[42]: https://playwright.dev/docs/api/class-page#page-wait-for-navigation
+[42]: https://playwright.dev/docs/trace-viewer
 
 [43]: https://playwright.dev/docs/browsers/#google-chrome--microsoft-edge