Skip to main content
Version: Next

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

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.

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