Skip to content

Commit db43fb9

Browse files
committed
DOC: Autogenerate and update documentation
1 parent 008c9fc commit db43fb9

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

docs/helpers/Playwright.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Type: [object][5]
4545
- `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.
4646
- 'browser' or **true** - closes browser and opens it again between tests.
4747
- '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
48-
- `timeout` **[number][19]?** - [timeout][40] in ms of all Playwright actions .
48+
- `timeout` **[number][19]?** - [timeout][41] in ms of all Playwright actions .
4949
- `disableScreenshots` **[boolean][32]?** don't save screenshot on failure.
5050
- `emulate` **any?** browser in device emulation mode.
5151
- `video` **[boolean][32]?** enables video recording for failed tests; videos are saved into `output/videos` folder
@@ -57,7 +57,7 @@ Type: [object][5]
5757
- `keepBrowserState` **[boolean][32]?** keep browser state between tests when `restart` is set to 'session'.
5858
- `keepCookies` **[boolean][32]?** keep cookies between tests when `restart` is set to 'session'.
5959
- `waitForAction` **[number][19]?** how long to wait after click, doubleClick or PressKey actions in ms. Default: 100.
60-
- `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].
60+
- `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].
6161
- `pressKeyDelay` **[number][19]?** Delay between key presses in ms. Used when calling Playwrights page.type(...) in fillField/appendField
6262
- `getPageTimeout` **[number][19]?** config option to set maximum navigation time in milliseconds.
6363
- `waitForTimeout` **[number][19]?** default wait* timeout in ms. Default: 1000.
@@ -1276,7 +1276,7 @@ Returns **[Promise][21]<[Array][9]<[string][8]>>** attribute value
12761276

12771277
Grab the recording WS messages
12781278

1279-
Returns **[Array][22]<any>**
1279+
Returns **[Array][9]<any>**
12801280

12811281
### handleDownloads
12821282

@@ -2305,7 +2305,7 @@ See [Playwright's reference][38]
23052305

23062306
#### Parameters
23072307

2308-
- `url` **([string][8] | [RegExp][16])** 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.
2308+
- `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.
23092309
- `options` **any**
23102310

23112311
### waitForValue
@@ -2336,8 +2336,7 @@ I.waitForVisible('#popup');
23362336

23372337
- `locator` **([string][8] | [object][5])** element located by CSS|XPath|strict locator.
23382338
- `sec` **[number][19]** (optional, `1` by default) time in seconds to wait
2339-
⚠️ returns a _promise_ which is synchronized internally by recorderThis method accepts [React selectors][38].
2340-
2339+
⚠️ returns a _promise_ which is synchronized internally by recorderThis method accepts [React selectors][39].
23412340

23422341
### waitInUrl
23432342

0 commit comments

Comments
 (0)