Skip to main content
Version: 20.6.0

Configuration interface

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

See individual properties for more information.

Signature:

export interface Configuration

Properties

PropertyModifiersTypeDescriptionDefault
browserRevisionoptionalstring

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.
cacheDirectoryoptionalstring

Defines the directory to be used by Puppeteer for caching.

Can be overridden by PUPPETEER_CACHE_DIR.

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

Specifies which browser you'd like Puppeteer to use.

Can be overridden by PUPPETEER_PRODUCT.

chrome
downloadBaseUrloptionalstring

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.
downloadPathoptionalstring

Specifies the path for the downloads folder.

Can be overridden by PUPPETEER_DOWNLOAD_PATH.

<cacheDirectory>
executablePathoptionalstring

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

Can be overridden by PUPPETEER_EXECUTABLE_PATH.

Auto-computed.
experimentsoptionalExperimentsConfigurationDefines experimental options for Puppeteer.
logLeveloptional'silent' | 'error' | 'warn'Tells Puppeteer to log at the given level.warn
skipDownloadoptionalboolean

Tells Puppeteer to not download during installation.

Can be overridden by PUPPETEER_SKIP_DOWNLOAD.

temporaryDirectoryoptionalstring

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

Can be overridden by PUPPETEER_TMP_DIR.

os.tmpdir()