yujunjun/playwright
1
0
Fork 0
mirror of https://github.com/microsoft/playwright.git synced 2025-06-26 21:40:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update type of env in the remaining places (#5254)

Browse Source
This commit is contained in:
Yury Semikhatsky 2021-02-02 10:57:22 -08:00 committed by GitHub
parent cee394d6e0
commit c51a1f96e5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 25 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
docs/src/api/class-browsertype.md
View File

@ -145,11 +145,19 @@ deleted when browser is closed.
Enable Chromium sandboxing. Defaults to `false`. Enable Chromium sandboxing. Defaults to `false`.
### option: BrowserType.launch.firefoxUserPrefs ### option: BrowserType.launch.firefoxUserPrefs
* langs: js, python
- `firefoxUserPrefs` <[Object]<[string], [string]|[float]|[boolean]>> - `firefoxUserPrefs` <[Object]<[string], [string]|[float]|[boolean]>>
Firefox user preferences. Learn more about the Firefox user preferences at Firefox user preferences. Learn more about the Firefox user preferences at
[`about:config`](https://support.mozilla.org/en-US/kb/about-config-editor-firefox). [`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 ### option: BrowserType.launch.handleSIGINT
- `handleSIGINT` <[boolean]> - `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 Maximum time in milliseconds to wait for the browser instance to start. Defaults to `30000` (30 seconds). Pass `0` to
disable timeout. disable timeout.
### option: BrowserType.launch.env ### option: BrowserType.launch.env = %%-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`. ### option: BrowserType.launch.env = %%-js-python-browser-option-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.devtools ### option: BrowserType.launch.devtools
- `devtools` <[boolean]> - `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 Maximum time in milliseconds to wait for the browser instance to start. Defaults to `30000` (30 seconds). Pass `0` to
disable timeout. disable timeout.
### option: BrowserType.launchPersistentContext.env ### option: BrowserType.launchPersistentContext.env = %%-csharp-java-browser-option-env-%%
- `env` <[Object]<[string], [string]|[float]|[boolean]>>
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 ### option: BrowserType.launchPersistentContext.devtools
- `devtools` <[boolean]> - `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 Maximum time in milliseconds to wait for the browser instance to start. Defaults to `30000` (30 seconds). Pass `0` to
disable timeout. disable timeout.
### option: BrowserType.launchServer.env ### option: BrowserType.launchServer.env = %%-js-python-browser-option-env-%%
- `env` <[Object]<[string], [string]|[float]|[boolean]>>
Specify environment variables that will be visible to the browser. Defaults to `process.env`.
### option: BrowserType.launchServer.devtools ### option: BrowserType.launchServer.devtools
- `devtools` <[boolean]> - `devtools` <[boolean]>

12
docs/src/api/params.md
View File

@ -131,6 +131,18 @@ Dangerous option; use with care. Defaults to `false`.
Network proxy settings. 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 ## context-option-storage-state
- `storageState` <[path]|[Object]> - `storageState` <[path]|[Object]>
- `cookies` <[Array]<[Object]>> Optional cookies to set for context - `cookies` <[Array]<[Object]>> Optional cookies to set for context