Version: Next

InstallOptions interface

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`	(downloadedBytes: number, totalBytes: number) => void	Provides information about the progress of the download.
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`
platform	`optional`	BrowserPlatform	Determines which platform the browser will be suited for.	Auto-detected.
unpack	`optional`	boolean	Whether to unpack and install browser archives.	`true`