puppeteer/website/versioned_docs/version-15.3.0/api/puppeteer.browserfetcher.download.md
release-please[bot] 01c76b7eb1
chore(main): release 15.3.0 (#8606)
* chore(main): release 15.3.0

* chore: generate versioned docs

Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
2022-07-01 17:02:54 +02:00

1.4 KiB

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.