puppeteer/new-docs/puppeteer.browserfetcher.download.md
Jack Franklin 29f7e161b1
chore(docs): reduce warnings when generating docs (#6138)
* chore(docs): reduce warnings when generating docs

This is a bunch of small miscellaneous fixes that reduce the amount of
warnings logged when generating our new docs. The long term goal is to
get this list down to 0 warnings, but I'll do it in multiple PRs.

* satisfy doclint
2020-07-02 12:15:39 +01:00

1.1 KiB

Home > puppeteer > BrowserFetcher > download

BrowserFetcher.download() method

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

Signature:

download(revision: string, progressCallback?: (x: number, y: number) => void): Promise<BrowserFetcherRevisionInfo>;

Parameters

Parameter Type Description
revision string The revision to download.
progressCallback (x: number, y: number) => void 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>

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

Remarks

This method is affected by the current product.