github/puppeteer
0
0
Fork 0
mirror of https://github.com/puppeteer/puppeteer synced 2024-06-14 14:02:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(new): add TSDoc comments to BrowserFetcher (#6078)

Browse Source
This commit is contained in:
Martin Splitt
2020-06-24 10:33:19 +02:00
committed by GitHub
parent 37f6032003
commit 73b97956cc
13 changed files with 148 additions and 88 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
new-docs/puppeteer.browserfetcher.download.md
View File

@@ -4,6 +4,8 @@
## BrowserFetcher.download() method
Initiates a GET request to download the revision from the host.
<b>Signature:</b>
```typescript
@@ -14,12 +16,16 @@ download(revision: string, progressCallback?: (x: number, y: number) => void): P
| Parameter | Type | Description |
| --- | --- | --- |
| revision | string | |
| progressCallback | (x: number, y: number) =&gt; void | |
| revision | string | The revision to download. |
| progressCallback | (x: number, y: number) =&gt; 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&lt;BrowserFetcherRevisionInfo&gt;
{<!-- -->!Promise<!-- -->&lt;<!-- -->!BrowserFetcher.RevisionInfo<!-- -->&gt;<!-- -->}
A promise with revision information when the revision is downloaded and extracted.
## Remarks
This method is affected by the current `product`<!-- -->.