puppeteer/docs/api/puppeteer.puppeteernode.launch.md

42 lines
1.9 KiB
Markdown
Raw Normal View History

2022-07-05 13:41:43 +00:00
---
sidebar_label: PuppeteerNode.launch
---
# PuppeteerNode.launch() method
Launches a browser instance with given arguments and options when specified.
2022-07-05 13:41:43 +00:00
When using with `puppeteer-core`, [options.executablePath](./puppeteer.launchoptions.md) or [options.channel](./puppeteer.launchoptions.md) must be provided.
#### Signature:
2022-07-05 13:41:43 +00:00
```typescript
class PuppeteerNode {
launch(options?: PuppeteerLaunchOptions): Promise<Browser>;
}
```
## Parameters
| Parameter | Type | Description |
| --------- | --------------------------------------------------------------- | ----------------------------------------------------- |
| options | [PuppeteerLaunchOptions](./puppeteer.puppeteerlaunchoptions.md) | _(Optional)_ Options to configure launching behavior. |
2022-07-05 13:41:43 +00:00
**Returns:**
Promise&lt;[Browser](./puppeteer.browser.md)&gt;
## 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](https://www.google.com/chrome/browser/canary.html) or [Dev Channel](https://www.chromium.org/getting-involved/dev-channel) build is suggested. See [this article](https://www.howtogeek.com/202825/what%E2%80%99s-the-difference-between-chromium-and-chrome/) for a description of the differences between Chromium and Chrome. [This article](https://chromium.googlesource.com/chromium/src/+/lkgr/docs/chromium_browser_vs_google_chrome.md) describes some differences for Linux users.
2022-07-05 13:41:43 +00:00
## Example
You can use [options.ignoreDefaultArgs](./puppeteer.launchoptions.md) to filter out `--mute-audio` from default arguments:
2022-07-05 13:41:43 +00:00
```ts
const browser = await puppeteer.launch({
ignoreDefaultArgs: ['--mute-audio'],
});
```