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
615cd37f96
puppeteer/new-docs/puppeteer.browserfetcher.download.md

32 lines
1.1 KiB
Markdown
Raw Normal View History

chore: commit base new-docs (#5973) This adds the new docs that are generated by API Extractor via TSDoc. They are sparse because we do not yet use TSDoc in the codebase. This is the starting point and from here we can work through all the different classes and improve the documentation.
2020-06-04 14:56:45 +00:00
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [BrowserFetcher](./puppeteer.browserfetcher.md) &gt; [download](./puppeteer.browserfetcher.download.md)
## BrowserFetcher.download() method
docs(new): add TSDoc comments to BrowserFetcher (#6078)
2020-06-24 08:33:19 +00:00
Initiates a GET request to download the revision from the host.
chore: commit base new-docs (#5973) This adds the new docs that are generated by API Extractor via TSDoc. They are sparse because we do not yet use TSDoc in the codebase. This is the starting point and from here we can work through all the different classes and improve the documentation.
2020-06-04 14:56:45 +00:00
<b>Signature:</b>
```typescript
chore: fix ESLint violation and lessen rule strictness (#6081)
2020-06-23 11:55:42 +00:00
download(revision: string, progressCallback?: (x: number, y: number) => void): Promise<BrowserFetcherRevisionInfo>;
chore: commit base new-docs (#5973) This adds the new docs that are generated by API Extractor via TSDoc. They are sparse because we do not yet use TSDoc in the codebase. This is the starting point and from here we can work through all the different classes and improve the documentation.
2020-06-04 14:56:45 +00:00
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
docs(new): add TSDoc comments to BrowserFetcher (#6078)
2020-06-24 08:33:19 +00:00
| 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. |
chore: commit base new-docs (#5973) This adds the new docs that are generated by API Extractor via TSDoc. They are sparse because we do not yet use TSDoc in the codebase. This is the starting point and from here we can work through all the different classes and improve the documentation.
2020-06-04 14:56:45 +00:00
<b>Returns:</b>
chore(docs): reduce warnings when generating docs (#6138) * 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
2020-07-02 11:15:39 +00:00
Promise&lt;[BrowserFetcherRevisionInfo](./puppeteer.browserfetcherrevisioninfo.md)<!-- -->&gt;
chore: commit base new-docs (#5973) This adds the new docs that are generated by API Extractor via TSDoc. They are sparse because we do not yet use TSDoc in the codebase. This is the starting point and from here we can work through all the different classes and improve the documentation.
2020-06-04 14:56:45 +00:00
docs(new): add TSDoc comments to BrowserFetcher (#6078)
2020-06-24 08:33:19 +00:00
A promise with revision information when the revision is downloaded and extracted.
## Remarks
This method is affected by the current `product`<!-- -->.
docs: replace @return with @returns (#6006) The former is not understood by TSDoc.
2020-06-12 10:38:24 +00:00
Reference in New Issue Copy Permalink