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
fc77c1517f
puppeteer/docs/api/puppeteer.browserfetcher.download.md
jrandolf 066f440ba7
feat: add documentation (#8593)
2022-07-01 11:52:39 +00:00

1.4 KiB
Raw Blame History

sidebar_label
BrowserFetcher.download

BrowserFetcher.download() method

Initiates a GET request to download the revision from the host.

Signature:

class BrowserFetcher {
  download(
    revision: string,
    progressCallback?: (x: number, y: number) => void
  ): Promise<BrowserFetcherRevisionInfo | undefined>;
}

Parameters

Parameter Type Description
revision string The revision to download.
progressCallback (x: number, y: number) => void (Optional) A function that will be called with two arguments: How many bytes have been downloaded and the total number of bytes of the download.

Returns:

Promise<BrowserFetcherRevisionInfo | undefined>

A promise with revision information when the revision is downloaded and extracted.

Remarks

This method is affected by the current product.