diff --git a/docs/out/api/class-browsercontext.md b/docs/out/api/class-browsercontext.md index c71a7e5505..aa3f9acda5 100644 --- a/docs/out/api/class-browsercontext.md +++ b/docs/out/api/class-browsercontext.md @@ -92,7 +92,7 @@ await browserContext.addCookies([cookieObject1, cookieObject2]); ## browserContext.addInitScript(script[, arg]) - `script` <[function]|[string]|[Object]> Script to be evaluated in all pages in the browser context. - - `path` <[path]> Path to the JavaScript file. If `path` is a relative path, then it is resolved relative to the current working directory. Optional. + - `path` <[string]> Path to the JavaScript file. If `path` is a relative path, then it is resolved relative to the current working directory. Optional. - `content` <[string]> Raw script content. Optional. - `arg` <[Serializable]> Optional argument to pass to `script` (only supported when passing a function). - returns: <[Promise]> @@ -372,7 +372,7 @@ Provide credentials for [HTTP authentication](https://developer.mozilla.org/en-U ## browserContext.storageState([options]) - `options` <[Object]> - - `path` <[path]> The file path to save the storage state to. If `path` is a relative path, then it is resolved relative to [current working directory](https://nodejs.org/api/process.html#process_process_cwd). If no path is provided, storage state is still returned, but won't be saved to the disk. + - `path` <[string]> The file path to save the storage state to. If `path` is a relative path, then it is resolved relative to [current working directory](https://nodejs.org/api/process.html#process_process_cwd). If no path is provided, storage state is still returned, but won't be saved to the disk. - returns: <[Promise]<[Object]>> - `cookies` <[Array]<[Object]>> - `name` <[string]> diff --git a/docs/out/api/class-browsertype.md b/docs/out/api/class-browsertype.md index 7b17673d44..c15bf587a7 100644 --- a/docs/out/api/class-browsertype.md +++ b/docs/out/api/class-browsertype.md @@ -46,9 +46,9 @@ A path where Playwright expects to find a bundled browser executable. - `args` <[Array]<[string]>> Additional arguments to pass to the browser instance. The list of Chromium flags can be found [here](http://peter.sh/experiments/chromium-command-line-switches/). - `chromiumSandbox` <[boolean]> Enable Chromium sandboxing. Defaults to `false`. - `devtools` <[boolean]> **Chromium-only** Whether to auto-open a Developer Tools panel for each tab. If this option is `true`, the `headless` option will be set `false`. - - `downloadsPath` <[path]> If specified, accepted downloads are downloaded into this directory. Otherwise, temporary directory is created and is deleted when browser is closed. + - `downloadsPath` <[string]> If specified, accepted downloads are downloaded into this directory. Otherwise, temporary directory is created and is deleted when browser is closed. - `env` <[Object]<[string], [string]|[number]|[boolean]>> Specify environment variables that will be visible to the browser. Defaults to `process.env`. - - `executablePath` <[path]> Path to a browser executable to run instead of the bundled one. If `executablePath` is a relative path, then it is resolved relative to the current working directory. Note that Playwright only works with the bundled Chromium, Firefox or WebKit, use at your own risk. + - `executablePath` <[string]> Path to a browser executable to run instead of the bundled one. If `executablePath` is a relative path, then it is resolved relative to the current working directory. Note that Playwright only works with the bundled Chromium, Firefox or WebKit, use at your own risk. - `firefoxUserPrefs` <[Object]<[string], [string]|[number]|[boolean]>> Firefox user preferences. Learn more about the Firefox user preferences at [`about:config`](https://support.mozilla.org/en-US/kb/about-config-editor-firefox). - `handleSIGHUP` <[boolean]> Close the browser process on SIGHUP. Defaults to `true`. - `handleSIGINT` <[boolean]> Close the browser process on Ctrl-C. Defaults to `true`. @@ -84,7 +84,7 @@ const browser = await chromium.launch({ // Or 'firefox' or 'webkit'. > See [`this article`](https://www.howtogeek.com/202825/what%E2%80%99s-the-difference-between-chromium-and-chrome/) for a description of the differences between Chromium and Chrome. [`This article`](https://chromium.googlesource.com/chromium/src/+/lkgr/docs/chromium_browser_vs_google_chrome.md) describes some differences for Linux users. ## browserType.launchPersistentContext(userDataDir[, options]) -- `userDataDir` <[path]> Path to a User Data Directory, which stores browser session data like cookies and local storage. More details for [Chromium](https://chromium.googlesource.com/chromium/src/+/master/docs/user_data_dir.md) and [Firefox](https://developer.mozilla.org/en-US/docs/Mozilla/Command_Line_Options#User_Profile). +- `userDataDir` <[string]> Path to a User Data Directory, which stores browser session data like cookies and local storage. More details for [Chromium](https://chromium.googlesource.com/chromium/src/+/master/docs/user_data_dir.md) and [Firefox](https://developer.mozilla.org/en-US/docs/Mozilla/Command_Line_Options#User_Profile). - `options` <[Object]> - `acceptDownloads` <[boolean]> Whether to automatically download all the attachments. Defaults to `false` where all the downloads are canceled. - `args` <[Array]<[string]>> Additional arguments to pass to the browser instance. The list of Chromium flags can be found [here](http://peter.sh/experiments/chromium-command-line-switches/). @@ -93,9 +93,9 @@ const browser = await chromium.launch({ // Or 'firefox' or 'webkit'. - `colorScheme` <"light"|"dark"|"no-preference"> Emulates `'prefers-colors-scheme'` media feature, supported values are `'light'`, `'dark'`, `'no-preference'`. See [page.emulateMedia(params)](api/class-page.md#pageemulatemediaparams) for more details. Defaults to '`light`'. - `deviceScaleFactor` <[number]> Specify device scale factor (can be thought of as dpr). Defaults to `1`. - `devtools` <[boolean]> **Chromium-only** Whether to auto-open a Developer Tools panel for each tab. If this option is `true`, the `headless` option will be set `false`. - - `downloadsPath` <[path]> If specified, accepted downloads are downloaded into this directory. Otherwise, temporary directory is created and is deleted when browser is closed. + - `downloadsPath` <[string]> If specified, accepted downloads are downloaded into this directory. Otherwise, temporary directory is created and is deleted when browser is closed. - `env` <[Object]<[string], [string]|[number]|[boolean]>> Specify environment variables that will be visible to the browser. Defaults to `process.env`. - - `executablePath` <[path]> Path to a browser executable to run instead of the bundled one. If `executablePath` is a relative path, then it is resolved relative to the current working directory. **BEWARE**: Playwright is only guaranteed to work with the bundled Chromium, Firefox or WebKit, use at your own risk. + - `executablePath` <[string]> Path to a browser executable to run instead of the bundled one. If `executablePath` is a relative path, then it is resolved relative to the current working directory. **BEWARE**: Playwright is only guaranteed to work with the bundled Chromium, Firefox or WebKit, use at your own risk. - `extraHTTPHeaders` <[Object]<[string], [string]>> An object containing additional HTTP headers to be sent with every request. All header values must be strings. - `geolocation` <[Object]> - `latitude` <[number]> Latitude between -90 and 90. @@ -152,9 +152,9 @@ Launches browser that uses persistent storage located at `userDataDir` and retur - `args` <[Array]<[string]>> Additional arguments to pass to the browser instance. The list of Chromium flags can be found [here](http://peter.sh/experiments/chromium-command-line-switches/). - `chromiumSandbox` <[boolean]> Enable Chromium sandboxing. Defaults to `true`. - `devtools` <[boolean]> **Chromium-only** Whether to auto-open a Developer Tools panel for each tab. If this option is `true`, the `headless` option will be set `false`. - - `downloadsPath` <[path]> If specified, accepted downloads are downloaded into this directory. Otherwise, temporary directory is created and is deleted when browser is closed. + - `downloadsPath` <[string]> If specified, accepted downloads are downloaded into this directory. Otherwise, temporary directory is created and is deleted when browser is closed. - `env` <[Object]<[string], [string]|[number]|[boolean]>> Specify environment variables that will be visible to the browser. Defaults to `process.env`. - - `executablePath` <[path]> Path to a browser executable to run instead of the bundled one. If `executablePath` is a relative path, then it is resolved relative to the current working directory. **BEWARE**: Playwright is only guaranteed to work with the bundled Chromium, Firefox or WebKit, use at your own risk. + - `executablePath` <[string]> Path to a browser executable to run instead of the bundled one. If `executablePath` is a relative path, then it is resolved relative to the current working directory. **BEWARE**: Playwright is only guaranteed to work with the bundled Chromium, Firefox or WebKit, use at your own risk. - `firefoxUserPrefs` <[Object]<[string], [string]|[number]|[boolean]>> Firefox user preferences. Learn more about the Firefox user preferences at [`about:config`](https://support.mozilla.org/en-US/kb/about-config-editor-firefox). - `handleSIGHUP` <[boolean]> Close the browser process on SIGHUP. Defaults to `true`. - `handleSIGINT` <[boolean]> Close the browser process on Ctrl-C. Defaults to `true`. diff --git a/docs/out/api/class-chromiumbrowser.md b/docs/out/api/class-chromiumbrowser.md index e5bd35da84..0cfb4d4313 100644 --- a/docs/out/api/class-chromiumbrowser.md +++ b/docs/out/api/class-chromiumbrowser.md @@ -34,7 +34,7 @@ Returns the newly created browser session. - `page` <[Page]> Optional, if specified, tracing includes screenshots of the given page. - `options` <[Object]> - `categories` <[Array]<[string]>> specify custom categories to use instead of default. - - `path` <[path]> A path to write the trace file to. + - `path` <[string]> A path to write the trace file to. - `screenshots` <[boolean]> captures screenshots in the trace. - returns: <[Promise]> diff --git a/docs/out/api/class-download.md b/docs/out/api/class-download.md index dbe8387240..189c20fce7 100644 --- a/docs/out/api/class-download.md +++ b/docs/out/api/class-download.md @@ -52,7 +52,7 @@ Returns download error if any. Returns path to the downloaded file in case of successful download. ## download.saveAs(path) -- `path` <[path]> Path where the download should be saved. +- `path` <[string]> Path where the download should be saved. - returns: <[Promise]> Saves the download to a user-specified path. diff --git a/docs/out/api/class-elementhandle.md b/docs/out/api/class-elementhandle.md index 89a253c861..62805f2028 100644 --- a/docs/out/api/class-elementhandle.md +++ b/docs/out/api/class-elementhandle.md @@ -323,7 +323,7 @@ Shortcuts such as `key: "Control+o"` or `key: "Control+Shift+T"` are supported a ## elementHandle.screenshot([options]) - `options` <[Object]> - `omitBackground` <[boolean]> Hides default white background and allows capturing screenshots with transparency. Not applicable to `jpeg` images. Defaults to `false`. - - `path` <[path]> The file path to save the image to. The screenshot type will be inferred from file extension. If `path` is a relative path, then it is resolved relative to the current working directory. If no path is provided, the image won't be saved to the disk. + - `path` <[string]> The file path to save the image to. The screenshot type will be inferred from file extension. If `path` is a relative path, then it is resolved relative to the current working directory. If no path is provided, the image won't be saved to the disk. - `quality` <[number]> The quality of the image, between 0-100. Not applicable to `png` images. - `timeout` <[number]> Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed by using the [browserContext.setDefaultTimeout(timeout)](api/class-browsercontext.md#browsercontextsetdefaulttimeouttimeout) or [page.setDefaultTimeout(timeout)](api/class-page.md#pagesetdefaulttimeouttimeout) methods. - `type` <"png"|"jpeg"> Specify screenshot type, defaults to `png`. diff --git a/docs/out/api/class-frame.md b/docs/out/api/class-frame.md index 6c6c8308ff..8ce6c106fd 100644 --- a/docs/out/api/class-frame.md +++ b/docs/out/api/class-frame.md @@ -140,7 +140,7 @@ const divsCounts = await frame.$$eval('div', (divs, min) => divs.length >= min, ## frame.addScriptTag(params) - `params` <[Object]> - `url` <[string]> URL of a script to be added. Optional. - - `path` <[path]> Path to the JavaScript file to be injected into frame. If `path` is a relative path, then it is resolved relative to the current working directory. Optional. + - `path` <[string]> Path to the JavaScript file to be injected into frame. If `path` is a relative path, then it is resolved relative to the current working directory. Optional. - `content` <[string]> Raw JavaScript content to be injected into frame. Optional. - `type` <[string]> Script type. Use 'module' in order to load a Javascript ES6 module. See [script](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/script) for more details. Optional. - returns: <[Promise]<[ElementHandle]>> @@ -152,7 +152,7 @@ Adds a `