github/puppeteer
0
0
Fork 0
mirror of https://github.com/puppeteer/puppeteer synced 2024-06-14 14:02:48 +00:00
Code Issues Packages Projects Releases Wiki Activity
08bc8542ea
puppeteer/docs/api/puppeteer.configuration.md
dependabot[bot] 93e9acc410
chore(deps-dev): Bump the dev-dependencies group with 3 updates (#12101) 
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Nikolay Vitkov <nvitkov@chromium.org>
2024-03-20 15:03:14 +00:00

3.4 KiB
Raw Blame History

sidebar_label
Configuration

Configuration interface

Defines options to configure Puppeteer's behavior during installation and runtime.

See individual properties for more information.

Signature:

export interface Configuration

Properties

Property

Modifiers

Type

Description

Default

browserRevision

optional

string

Specifies a certain version of the browser you'd like Puppeteer to use.

Can be overridden by PUPPETEER_BROWSER_REVISION.

See puppeteer.launch 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.

The pinned browser version supported by the current Puppeteer version.

cacheDirectory

optional

string

Defines the directory to be used by Puppeteer for caching.

Can be overridden by PUPPETEER_CACHE_DIR.

path.join(os.homedir(), '.cache', 'puppeteer')

defaultProduct

optional

Product

Specifies which browser you'd like Puppeteer to use.

Can be overridden by PUPPETEER_PRODUCT.

chrome

downloadBaseUrl

optional

string

Specifies the URL prefix that is used to download the browser.

Can be overridden by PUPPETEER_DOWNLOAD_BASE_URL.

Either https://storage.googleapis.com/chrome-for-testing-public or https://archive.mozilla.org/pub/firefox/nightly/latest-mozilla-central, depending on the product.

executablePath

optional

string

Specifies an executable path to be used in puppeteer.launch.

Can be overridden by PUPPETEER_EXECUTABLE_PATH.

Auto-computed.

experiments

optional

ExperimentsConfiguration

Defines experimental options for Puppeteer.

logLevel

optional

'silent' | 'error' | 'warn'

Tells Puppeteer to log at the given level.

warn

skipChromeDownload

optional

boolean

Tells Puppeteer to not Chrome download during installation.

Can be overridden by PUPPETEER_SKIP_CHROME_DOWNLOAD.

skipChromeHeadlessShellDownload

optional

boolean

Tells Puppeteer to not chrome-headless-shell download during installation.

Can be overridden by PUPPETEER_SKIP_CHROME_HEADLESS_SHELL_DOWNLOAD.

skipDownload

optional

boolean

Tells Puppeteer to not download during installation.

Can be overridden by PUPPETEER_SKIP_DOWNLOAD.

temporaryDirectory

optional

string

Defines the directory to be used by Puppeteer for creating temporary files.

Can be overridden by PUPPETEER_TMP_DIR.

os.tmpdir()