Skip to content
Permalink
Browse files

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

  • Loading branch information
AVGP committed Jun 24, 2020
1 parent 37f6032 commit 73b97956cc898f0a5c99a0bffe7878e4630d7cd6

This file was deleted.

This file was deleted.

@@ -4,6 +4,8 @@

## BrowserFetcher.canDownload() method

Initiates a HEAD request to check if the revision is available.

<b>Signature:</b>

```typescript
@@ -14,9 +16,15 @@ canDownload(revision: string): Promise<boolean>;

| Parameter | Type | Description |
| --- | --- | --- |
| revision | string | |
| revision | string | The revision to check availability for. |

<b>Returns:</b>

Promise&lt;boolean&gt;

A promise that resolves to `true` if the revision could be downloaded from the host.

## Remarks

This method is affected by the current `product`<!-- -->.

@@ -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`<!-- -->.

@@ -13,3 +13,5 @@ host(): string;

string

The download host being used.

@@ -13,3 +13,9 @@ localRevisions(): Promise<string[]>;

Promise&lt;string\[\]&gt;

A promise with a list of all revision strings (for the current `product`<!-- -->) available locally on disk.

## Remarks

This method is affected by the current `product`<!-- -->.

@@ -4,25 +4,38 @@

## BrowserFetcher class

BrowserFetcher can download and manage different versions of Chromium and Firefox.

<b>Signature:</b>

```typescript
export declare class BrowserFetcher
```
## Constructors
## Remarks
| Constructor | Modifiers | Description |
| --- | --- | --- |
| [(constructor)(projectRoot, options)](./puppeteer.browserfetcher._constructor_.md) | | Constructs a new instance of the <code>BrowserFetcher</code> class |
BrowserFetcher operates on revision strings that specify a precise version of Chromium, e.g. `"533271"`<!-- -->. Revision strings can be obtained from [omahaproxy.appspot.com](http://omahaproxy.appspot.com/)<!-- -->. In the Firefox case, BrowserFetcher downloads Firefox Nightly and operates on version numbers such as `"75"`<!-- -->.
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `BrowserFetcher` class.
## Example
An example of using BrowserFetcher to download a specific version of Chromium and running Puppeteer against it:
```js
const browserFetcher = puppeteer.createBrowserFetcher();
const revisionInfo = await browserFetcher.download('533271');
const browser = await puppeteer.launch({executablePath: revisionInfo.executablePath})
```
\*\*NOTE\*\* BrowserFetcher is not designed to work concurrently with other instances of BrowserFetcher that share the same downloads directory.

## Methods

| Method | Modifiers | Description |
| --- | --- | --- |
| [\_getFolderPath(revision)](./puppeteer.browserfetcher._getfolderpath.md) | | |
| [canDownload(revision)](./puppeteer.browserfetcher.candownload.md) | | |
| [download(revision, progressCallback)](./puppeteer.browserfetcher.download.md) | | |
| [canDownload(revision)](./puppeteer.browserfetcher.candownload.md) | | Initiates a HEAD request to check if the revision is available. |
| [download(revision, progressCallback)](./puppeteer.browserfetcher.download.md) | | Initiates a GET request to download the revision from the host. |
| [host()](./puppeteer.browserfetcher.host.md) | | |
| [localRevisions()](./puppeteer.browserfetcher.localrevisions.md) | | |
| [platform()](./puppeteer.browserfetcher.platform.md) | | |
@@ -7,9 +7,11 @@
<b>Signature:</b>

```typescript
platform(): string;
platform(): Platform;
```
<b>Returns:</b>

string
Platform

Returns the current `Platform`<!-- -->.

@@ -7,9 +7,11 @@
<b>Signature:</b>

```typescript
product(): string;
product(): Product;
```
<b>Returns:</b>

string
Product

Returns the current `Product`<!-- -->.

@@ -14,9 +14,15 @@ remove(revision: string): Promise<void>;

| Parameter | Type | Description |
| --- | --- | --- |
| revision | string | |
| revision | string | A revision to remove for the current <code>product</code>. |

<b>Returns:</b>

Promise&lt;void&gt;

A promise that resolves when the revision has been removes or throws if the revision has not been downloaded.

## Remarks

This method is affected by the current `product`<!-- -->.

@@ -14,9 +14,11 @@ revisionInfo(revision: string): BrowserFetcherRevisionInfo;

| Parameter | Type | Description |
| --- | --- | --- |
| revision | string | |
| revision | string | The revision to get info for. |

<b>Returns:</b>

BrowserFetcherRevisionInfo

The revision info for the given revision.

@@ -11,7 +11,7 @@
| [Accessibility](./puppeteer.accessibility.md) | The Accessibility class provides methods for inspecting Chromium's accessibility tree. The accessibility tree is used by assistive technology such as [screen readers](https://en.wikipedia.org/wiki/Screen_reader) or [switches](https://en.wikipedia.org/wiki/Switch_access)<!-- -->. |
| [Browser](./puppeteer.browser.md) | A Browser is created when Puppeteer connects to a Chromium instance, either through [Puppeteer.launch()](./puppeteer.puppeteer.launch.md) or [Puppeteer.connect()](./puppeteer.puppeteer.connect.md)<!-- -->. |
| [BrowserContext](./puppeteer.browsercontext.md) | BrowserContexts provide a way to operate multiple independent browser sessions. When a browser is launched, it has a single BrowserContext used by default. The method [Browser.newPage](./puppeteer.browser.newpage.md) creates a page in the default browser context. |
| [BrowserFetcher](./puppeteer.browserfetcher.md) | |
| [BrowserFetcher](./puppeteer.browserfetcher.md) | BrowserFetcher can download and manage different versions of Chromium and Firefox. |
| [CDPSession](./puppeteer.cdpsession.md) | The <code>CDPSession</code> instances are used to talk raw Chrome Devtools Protocol. |
| [Connection](./puppeteer.connection.md) | |
| [ConsoleMessage](./puppeteer.consolemessage.md) | ConsoleMessage objects are dispatched by page via the 'console' event. |

0 comments on commit 73b9795

Please sign in to comment.
You can’t perform that action at this time.