fix: update documentation on configuring puppeteer (#9150 )

This PR updates the docs regarding configuring puppeteer. In addition,
some changes have been made to the documentation generator to show
default values on the documentation site.

Also fixes: https://github.com/puppeteer/puppeteer/pull/9144

2022-10-24 09:07:05 +02: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.

1.4 KiB Raw Blame History

BrowserFetcher.download() method

Signature:

Parameters

Remarks

1.4 KiB

Raw Blame History