puppeteer/docs/api/puppeteer.puppeteernode.launch.md
jrandolf ec201744f0
feat: use configuration files (#9140)
This PR adds configurations files to `puppeteer`'s methods for
configuration. Under the hood, `puppeteer` relies on
https://www.npmjs.com/package/cosmiconfig which resolves several formats
of configuration:

- a `puppeteer` property in package.json
- a `.puppeteerrc` file in JSON or YAML format
- a `.puppeteerrc.json`, `.puppeteerrc.yaml`, `.puppeteerrc.yml`,
`.puppeteerrc.js`, or `.puppeteerrc.cjs` file
- a `puppeteer.config.js` or `puppeteer.config.cjs` CommonJS module
exporting an object

Documentation will be added later.

Fixed: #9128
2022-10-21 15:09:21 +02:00

1.8 KiB

sidebar_label
PuppeteerNode.launch

PuppeteerNode.launch() method

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) 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 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 , 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'],
});