mirror of
https://github.com/puppeteer/puppeteer
synced 2024-06-14 14:02:48 +00:00
e0932e5cce
🤖 I have created a release *beep* *boop* --- <details><summary>browsers: 2.2.2</summary> ## [2.2.2](https://github.com/puppeteer/puppeteer/compare/browsers-v2.2.1...browsers-v2.2.2) (2024-04-15) ### Bug Fixes * remove NetworkServiceInProcess2 set by default ([#12261](https://github.com/puppeteer/puppeteer/issues/12261)) ([ff4f70f](ff4f70f4ae)), closes [#12257](https://github.com/puppeteer/puppeteer/issues/12257) </details> <details><summary>puppeteer: 22.6.5</summary> ## [22.6.5](https://github.com/puppeteer/puppeteer/compare/puppeteer-v22.6.4...puppeteer-v22.6.5) (2024-04-15) ### Miscellaneous Chores * **puppeteer:** Synchronize puppeteer versions ### Dependencies * The following workspace dependencies were updated * dependencies * puppeteer-core bumped from 22.6.4 to 22.6.5 * @puppeteer/browsers bumped from 2.2.1 to 2.2.2 </details> <details><summary>puppeteer-core: 22.6.5</summary> ## [22.6.5](https://github.com/puppeteer/puppeteer/compare/puppeteer-core-v22.6.4...puppeteer-core-v22.6.5) (2024-04-15) ### Bug Fixes * remove NetworkServiceInProcess2 set by default ([#12261](https://github.com/puppeteer/puppeteer/issues/12261)) ([ff4f70f](ff4f70f4ae)), closes [#12257](https://github.com/puppeteer/puppeteer/issues/12257) * use setImmediate to reduce flakiness when processing events ([#12264](https://github.com/puppeteer/puppeteer/issues/12264)) ([73403b3](73403b323e)) ### Dependencies * The following workspace dependencies were updated * dependencies * @puppeteer/browsers bumped from 2.2.1 to 2.2.2 </details> --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
286 lines
3.8 KiB
Markdown
286 lines
3.8 KiB
Markdown
---
|
|
sidebar_label: Configuration
|
|
---
|
|
|
|
# Configuration interface
|
|
|
|
Defines options to configure Puppeteer's behavior during installation and runtime.
|
|
|
|
See individual properties for more information.
|
|
|
|
#### Signature:
|
|
|
|
```typescript
|
|
export interface Configuration
|
|
```
|
|
|
|
## Properties
|
|
|
|
<table><thead><tr><th>
|
|
|
|
Property
|
|
|
|
</th><th>
|
|
|
|
Modifiers
|
|
|
|
</th><th>
|
|
|
|
Type
|
|
|
|
</th><th>
|
|
|
|
Description
|
|
|
|
</th><th>
|
|
|
|
Default
|
|
|
|
</th></tr></thead>
|
|
<tbody><tr><td>
|
|
|
|
<span id="browserrevision">browserRevision</span>
|
|
|
|
</td><td>
|
|
|
|
`optional`
|
|
|
|
</td><td>
|
|
|
|
string
|
|
|
|
</td><td>
|
|
|
|
Specifies a certain version of the browser you'd like Puppeteer to use.
|
|
|
|
Can be overridden by `PUPPETEER_BROWSER_REVISION`.
|
|
|
|
See [puppeteer.launch](./puppeteer.puppeteernode.launch.md) on how executable path is inferred.
|
|
|
|
Use a specific browser version (e.g., 119.0.6045.105). If you use an alias such `stable` or `canary` it will only work during the installation of Puppeteer and it will fail when launching the browser.
|
|
|
|
</td><td>
|
|
|
|
The pinned browser version supported by the current Puppeteer version.
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
<span id="cachedirectory">cacheDirectory</span>
|
|
|
|
</td><td>
|
|
|
|
`optional`
|
|
|
|
</td><td>
|
|
|
|
string
|
|
|
|
</td><td>
|
|
|
|
Defines the directory to be used by Puppeteer for caching.
|
|
|
|
Can be overridden by `PUPPETEER_CACHE_DIR`.
|
|
|
|
</td><td>
|
|
|
|
`path.join(os.homedir(), '.cache', 'puppeteer')`
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
<span id="defaultproduct">defaultProduct</span>
|
|
|
|
</td><td>
|
|
|
|
`optional`
|
|
|
|
</td><td>
|
|
|
|
[Product](./puppeteer.product.md)
|
|
|
|
</td><td>
|
|
|
|
Specifies which browser you'd like Puppeteer to use.
|
|
|
|
Can be overridden by `PUPPETEER_PRODUCT`.
|
|
|
|
</td><td>
|
|
|
|
`chrome`
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
<span id="downloadbaseurl">downloadBaseUrl</span>
|
|
|
|
</td><td>
|
|
|
|
`optional`
|
|
|
|
</td><td>
|
|
|
|
string
|
|
|
|
</td><td>
|
|
|
|
Specifies the URL prefix that is used to download the browser.
|
|
|
|
Can be overridden by `PUPPETEER_DOWNLOAD_BASE_URL`.
|
|
|
|
</td><td>
|
|
|
|
Either https://storage.googleapis.com/chrome-for-testing-public or https://archive.mozilla.org/pub/firefox/nightly/latest-mozilla-central, depending on the product.
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
<span id="executablepath">executablePath</span>
|
|
|
|
</td><td>
|
|
|
|
`optional`
|
|
|
|
</td><td>
|
|
|
|
string
|
|
|
|
</td><td>
|
|
|
|
Specifies an executable path to be used in [puppeteer.launch](./puppeteer.puppeteernode.launch.md).
|
|
|
|
Can be overridden by `PUPPETEER_EXECUTABLE_PATH`.
|
|
|
|
</td><td>
|
|
|
|
**Auto-computed.**
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
<span id="experiments">experiments</span>
|
|
|
|
</td><td>
|
|
|
|
`optional`
|
|
|
|
</td><td>
|
|
|
|
[ExperimentsConfiguration](./puppeteer.experimentsconfiguration.md)
|
|
|
|
</td><td>
|
|
|
|
Defines experimental options for Puppeteer.
|
|
|
|
</td><td>
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
<span id="loglevel">logLevel</span>
|
|
|
|
</td><td>
|
|
|
|
`optional`
|
|
|
|
</td><td>
|
|
|
|
'silent' \| 'error' \| 'warn'
|
|
|
|
</td><td>
|
|
|
|
Tells Puppeteer to log at the given level.
|
|
|
|
</td><td>
|
|
|
|
`warn`
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
<span id="skipchromedownload">skipChromeDownload</span>
|
|
|
|
</td><td>
|
|
|
|
`optional`
|
|
|
|
</td><td>
|
|
|
|
boolean
|
|
|
|
</td><td>
|
|
|
|
Tells Puppeteer to not Chrome download during installation.
|
|
|
|
Can be overridden by `PUPPETEER_SKIP_CHROME_DOWNLOAD`.
|
|
|
|
</td><td>
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
<span id="skipchromeheadlessshelldownload">skipChromeHeadlessShellDownload</span>
|
|
|
|
</td><td>
|
|
|
|
`optional`
|
|
|
|
</td><td>
|
|
|
|
boolean
|
|
|
|
</td><td>
|
|
|
|
Tells Puppeteer to not chrome-headless-shell download during installation.
|
|
|
|
Can be overridden by `PUPPETEER_SKIP_CHROME_HEADLESS_SHELL_DOWNLOAD`.
|
|
|
|
</td><td>
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
<span id="skipdownload">skipDownload</span>
|
|
|
|
</td><td>
|
|
|
|
`optional`
|
|
|
|
</td><td>
|
|
|
|
boolean
|
|
|
|
</td><td>
|
|
|
|
Tells Puppeteer to not download during installation.
|
|
|
|
Can be overridden by `PUPPETEER_SKIP_DOWNLOAD`.
|
|
|
|
</td><td>
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
<span id="temporarydirectory">temporaryDirectory</span>
|
|
|
|
</td><td>
|
|
|
|
`optional`
|
|
|
|
</td><td>
|
|
|
|
string
|
|
|
|
</td><td>
|
|
|
|
Defines the directory to be used by Puppeteer for creating temporary files.
|
|
|
|
Can be overridden by `PUPPETEER_TMP_DIR`.
|
|
|
|
</td><td>
|
|
|
|
`os.tmpdir()`
|
|
|
|
</td></tr>
|
|
</tbody></table>
|