mirror of
https://github.com/puppeteer/puppeteer
synced 2024-06-14 14:02:48 +00:00
a63b8305ac
Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
191 lines
1.8 KiB
Markdown
191 lines
1.8 KiB
Markdown
---
|
|
sidebar_label: InstallOptions
|
|
---
|
|
|
|
# InstallOptions interface
|
|
|
|
#### Signature:
|
|
|
|
```typescript
|
|
export interface InstallOptions
|
|
```
|
|
|
|
## Properties
|
|
|
|
<table><thead><tr><th>
|
|
|
|
Property
|
|
|
|
</th><th>
|
|
|
|
Modifiers
|
|
|
|
</th><th>
|
|
|
|
Type
|
|
|
|
</th><th>
|
|
|
|
Description
|
|
|
|
</th><th>
|
|
|
|
Default
|
|
|
|
</th></tr></thead>
|
|
<tbody><tr><td>
|
|
|
|
baseUrl
|
|
|
|
</td><td>
|
|
|
|
`optional`
|
|
|
|
</td><td>
|
|
|
|
string
|
|
|
|
</td><td>
|
|
|
|
Determines the host that will be used for downloading.
|
|
|
|
</td><td>
|
|
|
|
Either
|
|
|
|
- https://storage.googleapis.com/chrome-for-testing-public or - https://archive.mozilla.org/pub/firefox/nightly/latest-mozilla-central
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
browser
|
|
|
|
</td><td>
|
|
|
|
</td><td>
|
|
|
|
[Browser](./browsers.browser.md)
|
|
|
|
</td><td>
|
|
|
|
Determines which browser to install.
|
|
|
|
</td><td>
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
buildId
|
|
|
|
</td><td>
|
|
|
|
</td><td>
|
|
|
|
string
|
|
|
|
</td><td>
|
|
|
|
Determines which buildId to download. BuildId should uniquely identify binaries and they are used for caching.
|
|
|
|
</td><td>
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
buildIdAlias
|
|
|
|
</td><td>
|
|
|
|
`optional`
|
|
|
|
</td><td>
|
|
|
|
string
|
|
|
|
</td><td>
|
|
|
|
An alias for the provided `buildId`. It will be used to maintain local metadata to support aliases in the `launch` command.
|
|
|
|
</td><td>
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
cacheDir
|
|
|
|
</td><td>
|
|
|
|
</td><td>
|
|
|
|
string
|
|
|
|
</td><td>
|
|
|
|
Determines the path to download browsers to.
|
|
|
|
</td><td>
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
downloadProgressCallback
|
|
|
|
</td><td>
|
|
|
|
`optional`
|
|
|
|
</td><td>
|
|
|
|
(downloadedBytes: number, totalBytes: number) => void
|
|
|
|
</td><td>
|
|
|
|
Provides information about the progress of the download.
|
|
|
|
</td><td>
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
platform
|
|
|
|
</td><td>
|
|
|
|
`optional`
|
|
|
|
</td><td>
|
|
|
|
[BrowserPlatform](./browsers.browserplatform.md)
|
|
|
|
</td><td>
|
|
|
|
Determines which platform the browser will be suited for.
|
|
|
|
</td><td>
|
|
|
|
**Auto-detected.**
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
unpack
|
|
|
|
</td><td>
|
|
|
|
`optional`
|
|
|
|
</td><td>
|
|
|
|
boolean
|
|
|
|
</td><td>
|
|
|
|
Whether to unpack and install browser archives.
|
|
|
|
</td><td>
|
|
|
|
`true`
|
|
|
|
</td></tr>
|
|
</tbody></table>
|