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

1.9 KiB

Raw Blame History

sidebar_label
PuppeteerNode.launch

PuppeteerNode.launch() method

Launches a browser instance with given arguments and options when specified.

When using with puppeteer-core, options.executablePath or options.channel must be provided.

Signature:

class PuppeteerNode {
  launch(options?: PuppeteerLaunchOptions): Promise<Browser>;
}

Parameters

Parameter	Type	Description
options	PuppeteerLaunchOptions	(Optional) Options to configure launching behavior.

Returns:

Promise<Browser>

Remarks

Puppeteer can also be used to control the Chrome browser, but it works best with the version of Chromium downloaded by default by Puppeteer. There is no guarantee it will work with any other version. If Google Chrome (rather than Chromium) is preferred, a Chrome Canary or Dev Channel build is suggested. See this article for a description of the differences between Chromium and Chrome. This article describes some differences for Linux users.

Example

You can use options.ignoreDefaultArgs to filter out --mute-audio from default arguments:

const browser = await puppeteer.launch({
  ignoreDefaultArgs: ['--mute-audio'],
});

1.9 KiB Raw Blame History