Skip to main content
Version: 21.5.2

InstallOptions interface

Signature:

export interface InstallOptions

Properties

PropertyModifiersTypeDescriptionDefault
baseUrloptionalstringDetermines the host that will be used for downloading.

Either

- https://edgedl.me.gvt1.com/edgedl/chrome/chrome-for-testing or - https://archive.mozilla.org/pub/firefox/nightly/latest-mozilla-central

browserBrowserDetermines which browser to install.
buildIdstringDetermines which buildId to download. BuildId should uniquely identify binaries and they are used for caching.
cacheDirstringDetermines the path to download browsers to.
downloadProgressCallbackoptional(downloadedBytes: number, totalBytes: number) => voidProvides information about the progress of the download.
platformoptionalBrowserPlatformDetermines which platform the browser will be suited for.Auto-detected.
unpackoptionalbooleanWhether to unpack and install browser archives.true