f07ad2c661
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
36 lines
1.4 KiB
Markdown
36 lines
1.4 KiB
Markdown
---
|
|
sidebar_label: BrowserFetcher.download
|
|
---
|
|
|
|
# BrowserFetcher.download() method
|
|
|
|
Initiates a GET request to download the revision from the host.
|
|
|
|
#### Signature:
|
|
|
|
```typescript
|
|
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 | <i>(Optional)</i> 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](./puppeteer.browserfetcherrevisioninfo.md) \| undefined>
|
|
|
|
A promise with revision information when the revision is downloaded and extracted.
|
|
|
|
## Remarks
|
|
|
|
This method is affected by the current `product`.
|