mirror of
https://github.com/puppeteer/puppeteer
synced 2024-06-14 14:02:48 +00:00
45 lines
2.2 KiB
Markdown
45 lines
2.2 KiB
Markdown
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||
|
|
|
||
|
|
[Home](./index.md) > [puppeteer](./puppeteer.md) > [PuppeteerNode](./puppeteer.puppeteernode.md) > [launch](./puppeteer.puppeteernode.launch.md)
|
||
|
|
|
||
|
|
## PuppeteerNode.launch() method
|
||
|
|
|
||
|
|
Launches puppeteer and launches a browser instance with given arguments and options when specified.
|
||
|
|
|
||
|
|
<b>Signature:</b>
|
||
|
|
|
||
|
|
```typescript
|
||
|
|
launch(options?: LaunchOptions & BrowserLaunchArgumentOptions & BrowserConnectOptions & {
|
||
|
|
product?: Product;
|
||
|
|
extraPrefsFirefox?: Record<string, unknown>;
|
||
|
|
}): Promise<Browser>;
|
||
|
|
```
|
||
|
|
|
||
|
|
## Parameters
|
||
|
|
|
||
|
|
| Parameter | Type | Description |
|
||
|
|
| --- | --- | --- |
|
||
|
|
| options | [LaunchOptions](./puppeteer.launchoptions.md) & [BrowserLaunchArgumentOptions](./puppeteer.browserlaunchargumentoptions.md) & [BrowserConnectOptions](./puppeteer.browserconnectoptions.md) & { product?: [Product](./puppeteer.product.md); extraPrefsFirefox?: Record<string, unknown>; } | Set of configurable options to set on the browser. |
|
||
|
|
|
||
|
|
<b>Returns:</b>
|
||
|
|
|
||
|
|
Promise<[Browser](./puppeteer.browser.md)>
|
||
|
|
|
||
|
|
Promise which resolves to browser instance.
|
||
|
|
|
||
|
|
## Remarks
|
||
|
|
|
||
|
|
|
||
|
|
## Example
|
||
|
|
|
||
|
|
You can use `ignoreDefaultArgs` to filter out `--mute-audio` from default arguments:
|
||
|
|
|
||
|
|
```js
|
||
|
|
const browser = await puppeteer.launch({
|
||
|
|
ignoreDefaultArgs: ['--mute-audio']
|
||
|
|
});
|
||
|
|
|
||
|
|
```
|
||
|
|
\*\*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](https://www.google.com/chrome/browser/canary.html) or [Dev Channel](https://www.chromium.org/getting-involved/dev-channel) build is suggested. In `puppeteer.launch([options])`, any mention of Chromium also applies to Chrome. 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.
|
||
|
|
|