github/puppeteer
0
0
Fork 0
mirror of https://github.com/puppeteer/puppeteer synced 2024-06-14 14:02:48 +00:00
Code Issues Packages Projects Releases Wiki Activity
163394d735
puppeteer/website/versioned_docs/version-21.3.6/browsers-api/browsers.installoptions.md
release-please[bot] eedbb13ada
chore: release main (#11051) 
Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
2023-09-28 15:03:09 +02:00

3.5 KiB
Raw Blame History

sidebar_label
InstallOptions

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

- https://edgedl.me.gvt1.com/edgedl/chrome/chrome-for-testing 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.
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