mirror of
https://github.com/puppeteer/puppeteer
synced 2024-06-14 14:02:48 +00:00
32 lines
6.6 KiB
Markdown
32 lines
6.6 KiB
Markdown
---
|
|
sidebar_label: LaunchOptions
|
|
---
|
|
|
|
# LaunchOptions interface
|
|
|
|
Generic launch options that can be passed when launching any browser.
|
|
|
|
#### Signature:
|
|
|
|
```typescript
|
|
export interface LaunchOptions
|
|
```
|
|
|
|
## Properties
|
|
|
|
| Property | Modifiers | Type | Description | Default |
|
|
| ---------------------------------------------------------------------- | --------- | ----------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- |
|
|
| [channel?](./puppeteer.launchoptions.channel.md) | | [ChromeReleaseChannel](./puppeteer.chromereleasechannel.md) | _(Optional)_ Chrome Release Channel | |
|
|
| [dumpio?](./puppeteer.launchoptions.dumpio.md) | | boolean | _(Optional)_ If true, pipes the browser process stdout and stderr to <code>process.stdout</code> and <code>process.stderr</code>. | false |
|
|
| [env?](./puppeteer.launchoptions.env.md) | | Record<string, string \| undefined> | _(Optional)_ Specify environment variables that will be visible to the browser. | The contents of <code>process.env</code>. |
|
|
| [executablePath?](./puppeteer.launchoptions.executablepath.md) | | string | _(Optional)_ Path to a browser executable to use instead of the bundled Chromium. Note that Puppeteer is only guaranteed to work with the bundled Chromium, so use this setting at your own risk. | |
|
|
| [extraPrefsFirefox?](./puppeteer.launchoptions.extraprefsfirefox.md) | | Record<string, unknown> | _(Optional)_ [Additional preferences](https://searchfox.org/mozilla-release/source/modules/libpref/init/all.js) that can be passed when launching with Firefox. | |
|
|
| [handleSIGHUP?](./puppeteer.launchoptions.handlesighup.md) | | boolean | _(Optional)_ Close the browser process on <code>SIGHUP</code>. | <code>true</code> |
|
|
| [handleSIGINT?](./puppeteer.launchoptions.handlesigint.md) | | boolean | _(Optional)_ Close the browser process on <code>Ctrl+C</code>. | <code>true</code> |
|
|
| [handleSIGTERM?](./puppeteer.launchoptions.handlesigterm.md) | | boolean | _(Optional)_ Close the browser process on <code>SIGTERM</code>. | <code>true</code> |
|
|
| [ignoreDefaultArgs?](./puppeteer.launchoptions.ignoredefaultargs.md) | | boolean \| string\[\] | _(Optional)_ If <code>true</code>, do not use <code>puppeteer.defaultArgs()</code> when creating a browser. If an array is provided, these args will be filtered out. Use this with care - you probably want the default arguments Puppeteer uses. | false |
|
|
| [pipe?](./puppeteer.launchoptions.pipe.md) | | boolean | _(Optional)_ Connect to a browser over a pipe instead of a WebSocket. | false |
|
|
| [product?](./puppeteer.launchoptions.product.md) | | [Product](./puppeteer.product.md) | _(Optional)_ Which browser to launch. | <code>chrome</code> |
|
|
| [timeout?](./puppeteer.launchoptions.timeout.md) | | number | _(Optional)_ Maximum time in milliseconds to wait for the browser to start. Pass <code>0</code> to disable the timeout. | 30000 (30 seconds). |
|
|
| [waitForInitialPage?](./puppeteer.launchoptions.waitforinitialpage.md) | | boolean | _(Optional)_ Whether to wait for the initial page to be ready. Useful when a user explicitly disables that (e.g. <code>--no-startup-window</code> for Chrome). | true |
|