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'
downloadHost	optional	string	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	optional	string	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	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. At the moment, any option silences logging.	undefined
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()