mirror of https://github.com/puppeteer/puppeteer synced 2024-06-14 14:02:48 +00:00

fix: update documentation on configuring puppeteer (#9150 )

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

2022-10-24 09:07:05 +02:00

2.7 KiB

Raw Blame History

sidebar_label
BrowserFetcher

BrowserFetcher class

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

Signature:

export declare class BrowserFetcher

Remarks

BrowserFetcher is not designed to work concurrently with other instances of BrowserFetcher that share the same downloads directory.

Example

An example of using BrowserFetcher to download a specific version of Chromium and running Puppeteer against it:

const browserFetcher = new BrowserFetcher({path: 'path/to/download/folder'});
const revisionInfo = await browserFetcher.download('533271');
const browser = await puppeteer.launch({
  executablePath: revisionInfo.executablePath,
});

Constructors

Constructor	Modifiers	Description
(constructor)(options)		Constructs a browser fetcher for the given options.

Methods

Method	Modifiers	Description
canDownload(revision)		Initiates a HEAD request to check if the revision is available.
download(revision, progressCallback)		Initiates a GET request to download the revision from the host.
host()
localRevisions()
platform()
product()
remove(revision)
revisionInfo(revision)

2.7 KiB Raw Blame History