InstallOptions interface
Signature
export interface InstallOptions
Properties
Property | Modifiers | Type | Description | Default |
|---|---|---|---|---|
| baseUrl |
| string | Determines the host that will be used for downloading. | Either |
| 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 |
| string | An alias for the provided | |
| cacheDir | string | Determines the path to download browsers to. | ||
| downloadProgressCallback |
| '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. | |
| installDeps |
| 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 |
|
| platform |
| Determines which platform the browser will be suited for. | Auto-detected. | |
| unpack |
| boolean | Whether to unpack and install browser archives. |
|