29f7e161b1
* 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
32 lines
1.1 KiB
Markdown
32 lines
1.1 KiB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
|
|
[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcher](./puppeteer.browserfetcher.md) > [download](./puppeteer.browserfetcher.download.md)
|
|
|
|
## BrowserFetcher.download() method
|
|
|
|
Initiates a GET request to download the revision from the host.
|
|
|
|
<b>Signature:</b>
|
|
|
|
```typescript
|
|
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. |
|
|
|
|
<b>Returns:</b>
|
|
|
|
Promise<[BrowserFetcherRevisionInfo](./puppeteer.browserfetcherrevisioninfo.md)<!-- -->>
|
|
|
|
A promise with revision information when the revision is downloaded and extracted.
|
|
|
|
## Remarks
|
|
|
|
This method is affected by the current `product`<!-- -->.
|
|
|