From c51a1f96e50826cd30bfd6946cc98e49d6758833 Mon Sep 17 00:00:00 2001 From: Yury Semikhatsky Date: Tue, 2 Feb 2021 10:57:22 -0800 Subject: [PATCH] docs: update type of env in the remaining places (#5254) --- docs/src/api/class-browsertype.md | 30 +++++++++++++----------------- docs/src/api/params.md | 12 ++++++++++++ 2 files changed, 25 insertions(+), 17 deletions(-) diff --git a/docs/src/api/class-browsertype.md b/docs/src/api/class-browsertype.md index b73f7f1817..5436b29a04 100644 --- a/docs/src/api/class-browsertype.md +++ b/docs/src/api/class-browsertype.md @@ -145,11 +145,19 @@ deleted when browser is closed. Enable Chromium sandboxing. Defaults to `false`. ### option: BrowserType.launch.firefoxUserPrefs +* langs: js, python - `firefoxUserPrefs` <[Object]<[string], [string]|[float]|[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). +### option: BrowserType.launch.firefoxUserPrefs +* langs: csharp, java +- `firefoxUserPrefs` <[Object]<[string], [any]>> + +Firefox user preferences. Learn more about the Firefox user preferences at +[`about:config`](https://support.mozilla.org/en-US/kb/about-config-editor-firefox). + ### option: BrowserType.launch.handleSIGINT - `handleSIGINT` <[boolean]> @@ -177,17 +185,9 @@ Logger sink for Playwright logging. Maximum time in milliseconds to wait for the browser instance to start. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. -### option: BrowserType.launch.env -* langs: csharp, java -- `env` <[Object]<[string], [string]>> +### option: BrowserType.launch.env = %%-csharp-java-browser-option-env-%% -Specify environment variables that will be visible to the browser. Defaults to `process.env`. - -### option: BrowserType.launch.env -* langs: js, python -- `env` <[Object]<[string], [string]|[float]|[boolean]>> - -Specify environment variables that will be visible to the browser. Defaults to `process.env`. +### option: BrowserType.launch.env = %%-js-python-browser-option-env-%% ### option: BrowserType.launch.devtools - `devtools` <[boolean]> @@ -272,10 +272,9 @@ Close the browser process on SIGHUP. Defaults to `true`. Maximum time in milliseconds to wait for the browser instance to start. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. -### option: BrowserType.launchPersistentContext.env -- `env` <[Object]<[string], [string]|[float]|[boolean]>> +### option: BrowserType.launchPersistentContext.env = %%-csharp-java-browser-option-env-%% -Specify environment variables that will be visible to the browser. Defaults to `process.env`. +### option: BrowserType.launchPersistentContext.env = %%-js-python-browser-option-env-%% ### option: BrowserType.launchPersistentContext.devtools - `devtools` <[boolean]> @@ -387,10 +386,7 @@ Logger sink for Playwright logging. Maximum time in milliseconds to wait for the browser instance to start. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. -### option: BrowserType.launchServer.env -- `env` <[Object]<[string], [string]|[float]|[boolean]>> - -Specify environment variables that will be visible to the browser. Defaults to `process.env`. +### option: BrowserType.launchServer.env = %%-js-python-browser-option-env-%% ### option: BrowserType.launchServer.devtools - `devtools` <[boolean]> diff --git a/docs/src/api/params.md b/docs/src/api/params.md index 522b8e0858..122dde970f 100644 --- a/docs/src/api/params.md +++ b/docs/src/api/params.md @@ -131,6 +131,18 @@ Dangerous option; use with care. Defaults to `false`. Network proxy settings. +## csharp-java-browser-option-env +* langs: csharp, java +- `env` <[Object]<[string], [string]>> + +Specify environment variables that will be visible to the browser. Defaults to `process.env`. + +## js-python-browser-option-env +* langs: js, python +- `env` <[Object]<[string], [string]|[float]|[boolean]>> + +Specify environment variables that will be visible to the browser. Defaults to `process.env`. + ## context-option-storage-state - `storageState` <[path]|[Object]> - `cookies` <[Array]<[Object]>> Optional cookies to set for context