diff --git a/docs/helpers/Playwright.md b/docs/helpers/Playwright.md index c892c90f3..7e55a5d23 100644 --- a/docs/helpers/Playwright.md +++ b/docs/helpers/Playwright.md @@ -40,7 +40,7 @@ Type: [object][5] ### Properties - `url` **[string][8]** base url of website to be tested -- `browser` **[string][8]?** a browser to test on, either: `chromium`, `firefox`, `webkit`, `electron`. Default: chromium. +- `browser` **(`"chromium"` | `"firefox"` | `"webkit"` | `"electron"`)?** a browser to test on, either: `chromium`, `firefox`, `webkit`, `electron`. Default: chromium. - `show` **[boolean][26]?** show browser window. - `restart` **([string][8] | [boolean][26])?** restart strategy between tests. Possible values:- 'context' or **false** - restarts [browser context][33] but keeps running browser. Recommended by Playwright team to keep tests isolated. - 'browser' or **true** - closes browser and opens it again between tests. @@ -57,13 +57,13 @@ Type: [object][5] - `keepBrowserState` **[boolean][26]?** keep browser state between tests when `restart` is set to 'session'. - `keepCookies` **[boolean][26]?** keep cookies between tests when `restart` is set to 'session'. - `waitForAction` **[number][12]?** how long to wait after click, doubleClick or PressKey actions in ms. Default: 100. -- `waitForNavigation` **[string][8]?** When to consider navigation succeeded. Possible options: `load`, `domcontentloaded`, `networkidle`. Choose one of those options is possible. See [Playwright API][36]. +- `waitForNavigation` **(`"load"` | `"domcontentloaded"` | `"networkidle"`)?** When to consider navigation succeeded. Possible options: `load`, `domcontentloaded`, `networkidle`. Choose one of those options is possible. See [Playwright API][36]. - `pressKeyDelay` **[number][12]?** Delay between key presses in ms. Used when calling Playwrights page.type(...) in fillField/appendField - `getPageTimeout` **[number][12]?** config option to set maximum navigation time in milliseconds. - `waitForTimeout` **[number][12]?** 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` **[string][8]?** default color scheme. Possible values: `dark` | `light` | `no-preference`. +- `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][26]?** do not start browser before a test, start it manually inside a helper with `this.helpers["Playwright"]._startBrowser()`. diff --git a/lib/helper/Playwright.js b/lib/helper/Playwright.js index fbb24ed9d..2adf24f83 100644 --- a/lib/helper/Playwright.js +++ b/lib/helper/Playwright.js @@ -54,7 +54,7 @@ const pathSeparator = path.sep; * @typedef PlaywrightConfig * @type {object} * @prop {string} url - base url of website to be tested - * @prop {string} [browser] - a browser to test on, either: `chromium`, `firefox`, `webkit`, `electron`. Default: chromium. + * @prop {'chromium' | 'firefox'| 'webkit' | 'electron'} [browser='chromium'] - a browser to test on, either: `chromium`, `firefox`, `webkit`, `electron`. Default: chromium. * @prop {boolean} [show=false] - show browser window. * @prop {string|boolean} [restart=false] - restart strategy between tests. Possible values: * * 'context' or **false** - restarts [browser context](https://playwright.dev/docs/api/class-browsercontext) but keeps running browser. Recommended by Playwright team to keep tests isolated. @@ -72,13 +72,13 @@ const pathSeparator = path.sep; * @prop {boolean} [keepBrowserState=false] - keep browser state between tests when `restart` is set to 'session'. * @prop {boolean} [keepCookies=false] - keep cookies between tests when `restart` is set to 'session'. * @prop {number} [waitForAction] - how long to wait after click, doubleClick or PressKey actions in ms. Default: 100. - * @prop {string} [waitForNavigation] - When to consider navigation succeeded. Possible options: `load`, `domcontentloaded`, `networkidle`. Choose one of those options is possible. See [Playwright API](https://playwright.dev/docs/api/class-page#page-wait-for-navigation). + * @prop {'load' | 'domcontentloaded' | 'networkidle'} [waitForNavigation] - When to consider navigation succeeded. Possible options: `load`, `domcontentloaded`, `networkidle`. Choose one of those options is possible. See [Playwright API](https://playwright.dev/docs/api/class-page#page-wait-for-navigation). * @prop {number} [pressKeyDelay=10] - Delay between key presses in ms. Used when calling Playwrights page.type(...) in fillField/appendField * @prop {number} [getPageTimeout] - config option to set maximum navigation time in milliseconds. * @prop {number} [waitForTimeout] - default wait* timeout in ms. Default: 1000. * @prop {object} [basicAuth] - the basic authentication to pass to base url. Example: {username: 'username', password: 'password'} * @prop {string} [windowSize] - default window size. Set a dimension like `640x480`. - * @prop {string} [colorScheme] - default color scheme. Possible values: `dark` | `light` | `no-preference`. + * @prop {'dark' | 'light' | 'no-preference'} [colorScheme] - default color scheme. Possible values: `dark` | `light` | `no-preference`. * @prop {string} [userAgent] - user-agent string. * @prop {string} [locale] - locale string. Example: 'en-GB', 'de-DE', 'fr-FR', ... * @prop {boolean} [manualStart] - do not start browser before a test, start it manually inside a helper with `this.helpers["Playwright"]._startBrowser()`.