Skip to content

Commit 97be52c

Browse files
committed
updated readme for config
1 parent 820dde6 commit 97be52c

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

Readme.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,25 @@ modules:
4747
browser: 'chromium'
4848
show: true
4949
```
50+
Most common config values are:
51+
52+
* `url` - base url to open pages from
53+
* `browser` - either `chromium`, `firefox`, `webkit`
54+
* `show` - (default: `true`) to show browser or set to `false` to run tests in headless mode
55+
* `timeout` - (default: `5000`) timeout (in ms) for all Playwright operations
56+
* `pw_start` - (default: `true`) start Playwright Server (Proxy to CodeceptJS) automatically. Set to `false` and run server manually in case server doesn't start.
57+
* `pw_server` - (default: 'http://localhost:8191') url of Playwright Server
58+
* `pw_debug` - (default: `false`) print Playwright Server debug information
59+
* `video` - save video on fail
60+
* `trace` - save traces on fail
61+
62+
More configuration options are is listed on [CodeceptJS Playwright page](https://codecept.io/helpers/Playwright/#configuration)
63+
64+
5065
> [!Tip]
5166
> This module is designed as drop-in WebDriver module replacement, you can change `WebDriver` to `Playwright` in your tests and try how it works!
5267

68+
5369
## Usage
5470

5571
Playwright module requires NodeJS server to be running. Playwright module will start it and stop automatically. Default port is **8191**.
@@ -90,7 +106,9 @@ modules:
90106

91107
This module provides the same API as WebDriver module. You can try to use it in your tests without any changes.
92108

93-
Complete API reference is available in [CodeceptJS Playwright Helper](https://codecept.io/helpers/Playwright/)
109+
For the full command list see [WebDriver module reference](https://codeception.com/docs/modules/WebDriver#dontSeeElement).
110+
111+
Playwright-specific commands are also available in [CodeceptJS Playwright Helper](https://codecept.io/helpers/Playwright/)
94112

95113
## Example
96114

0 commit comments

Comments
 (0)