puppeteer/website/versioned_docs/version-21.3.8/api/puppeteer.configuration.md
release-please[bot] ddbb43cd09
chore: release main (#11086)
Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
2023-10-06 11:48:06 +00:00

6.6 KiB

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.

A compatible-revision of the browser.
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://edgedl.me.gvt1.com/edgedl/chrome/chrome-for-testing or https://archive.mozilla.org/pub/firefox/nightly/latest-mozilla-central, depending on the product.
downloadPath optional string

Specifies the path for the downloads folder.

Can be overridden by PUPPETEER_DOWNLOAD_PATH.

<cacheDirectory>
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
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()