puppeteer/website/versioned_docs/version-19.7.2/api/puppeteer.configuration.md
release-please[bot] e0330d82bd
chore: release main (#9716)
Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
2023-02-20 18:30:51 +01:00

7.3 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? string

(Optional) 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? string

(Optional) Defines the directory to be used by Puppeteer for caching.

Can be overridden by PUPPETEER_CACHE_DIR.

path.join(os.homedir(), '.cache', 'puppeteer')
defaultProduct? Product

(Optional) Specifies which browser you'd like Puppeteer to use.

Can be overridden by PUPPETEER_PRODUCT.

'chrome'
downloadHost? string

(Optional) Specifies the URL prefix that is used to download Chromium.

Can be overridden by PUPPETEER_DOWNLOAD_HOST.

Either https://storage.googleapis.com or https://archive.mozilla.org/pub/firefox/nightly/latest-mozilla-central, depending on the product.
downloadPath? string

(Optional) Specifies the path for the downloads folder.

Can be overridden by PUPPETEER_DOWNLOAD_PATH.

<cache>/<product> where <cache> is Puppeteer's cache directory and <product> is the name of the browser.
executablePath? string

(Optional) Specifies an executable path to be used in puppeteer.launch.

Can be overridden by PUPPETEER_EXECUTABLE_PATH.

Auto-computed.
experiments? ExperimentsConfiguration (Optional) Defines experimental options for Puppeteer.
logLevel? 'silent' | 'error' | 'warn'

(Optional) Tells Puppeteer to log at the given level.

At the moment, any option silences logging.

undefined
skipDownload? boolean

(Optional) Tells Puppeteer to not download during installation.

Can be overridden by PUPPETEER_SKIP_DOWNLOAD.

temporaryDirectory? string

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

Can be overridden by PUPPETEER_TMP_DIR.

os.tmpdir()