InstallOptions interface

Signature

export interface InstallOptions

Properties

Property	Modifiers	Type	Description	Default
baseUrl	optional	string	Determines the host that will be used for downloading.	Either https://storage.googleapis.com/chrome-for-testing-public or - https://archive.mozilla.org/pub/firefox/nightly/latest-mozilla-central
browser		Browser	Determines which browser to install.
buildId		string	Determines which buildId to download. BuildId should uniquely identify binaries and they are used for caching.
buildIdAlias	optional	string	An alias for the provided buildId. It will be used to maintain local metadata to support aliases in the launch command.
cacheDir		string	Determines the path to download browsers to.
downloadProgressCallback	optional	'default' | ((downloadedBytes: number, totalBytes: number) => void)	Provides information about the progress of the download. If set to 'default', the default callback implementing a progress bar will be used.
expectedHash	optional	string	Expected SHA-256 checksum (lowercase hex) of the downloaded browser archive. If provided, installation will fail when the downloaded file does not match. If omitted, the download proceeds without integrity verification.
installDeps	optional	boolean	Whether to attempt to install system-level dependencies required for the browser. Only supported for Chrome on Debian or Ubuntu. Requires system-level privileges to run apt-get.	false
logger	optional	Logger
platform	optional	BrowserPlatform	Determines which platform the browser will be suited for.	Auto-detected.
providers	optional	BrowserProvider[]	Custom provider implementation for alternative download sources. If not provided, uses the default provider. Multiple providers can be chained - they will be tried in order. The default provider is automatically added as the final fallback. ⚠️ IMPORTANT: Custom providers are NOT officially supported by Puppeteer. By using custom providers, you accept full responsibility for: Version compatibility: Different platforms may receive different binary versions - Archive compatibility: Binary structure must match Puppeteer's expectations - Feature integration: Browser launch and other Puppeteer features may not work - Testing: You must validate that downloaded binaries work with Puppeteer Puppeteer only tests and guarantees compatibility with default binaries.
unpack	optional	boolean	Whether to unpack and install browser archives.	true