puppeteer/website/versioned_docs/version-17.1.1/api/puppeteer.puppeteernode.launch.md
release-please[bot] 8e1c8b9be6
chore(main): release 17.1.1 (#8900)
* chore(main): release 17.1.1

* chore: generate versioned docs

Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
2022-09-05 12:49:30 +00:00

1.9 KiB

sidebar_label
PuppeteerNode.launch

PuppeteerNode.launch() method

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

Signature:

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

Parameters

Parameter Type Description
options PuppeteerLaunchOptions (Optional) Set of configurable options to set on the browser.

Returns:

Promise<Browser>

Promise which resolves to browser instance.

Remarks

NOTE Puppeteer can also be used to control the Chrome browser, but it works best with the version of Chromium it is bundled with. There is no guarantee it will work with any other version. Use executablePath option with extreme caution. If Google Chrome (rather than Chromium) is preferred, a Chrome Canary or Dev Channel build is suggested. In puppeteer.launch([options]), any mention of Chromium also applies to Chrome. 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 ignoreDefaultArgs to filter out --mute-audio from default arguments:

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