Generic launch options that can be passed when launching any browser.
export interface LaunchOptions extends ConnectOptions
Extends: ConnectOptions
| Property | Modifiers | Type | Description | Default |
|---|---|---|---|---|
| args | `optional` | string\[\] | Additional command line arguments to pass to the browser instance. | |
| browser | `optional` | [SupportedBrowser](./puppeteer.supportedbrowser.md) | Which browser to launch. | `chrome` |
| channel | `optional` | [ChromeReleaseChannel](./puppeteer.chromereleasechannel.md) | If specified for Chrome, looks for a regular Chrome installation at a known system location instead of using the bundled Chrome binary. | |
| debuggingPort | `optional` | number | Specify the debugging port number to use | |
| devtools | `optional` | boolean | Whether to auto-open a DevTools panel for each tab. If this is set to `true`, then `headless` will be forced to `false`. | `false` |
| dumpio | `optional` | boolean | If true, pipes the browser process stdout and stderr to `process.stdout` and `process.stderr`. | `false` |
| env | `optional` | Record<string, string \| undefined> | Specify environment variables that will be visible to the browser. | The contents of `process.env`. |
| executablePath | `optional` | string | Path to a browser executable to use instead of the bundled browser. Note that Puppeteer is only guaranteed to work with the bundled browser, so use this setting at your own risk. **Remarks:** When using this is recommended to set the `browser` property as well as Puppeteer will default to `chrome` by default. | |
| extraPrefsFirefox | `optional` | Record<string, unknown> | [Additional preferences](https://searchfox.org/mozilla-release/source/modules/libpref/init/all.js) that can be passed when launching with Firefox. | |
| handleSIGHUP | `optional` | boolean | Close the browser process on `SIGHUP`. | `true` |
| handleSIGINT | `optional` | boolean | Close the browser process on `Ctrl+C`. | `true` |
| handleSIGTERM | `optional` | boolean | Close the browser process on `SIGTERM`. | `true` |
| headless | `optional` | boolean \| 'shell' | Whether to run the browser in headless mode. **Remarks:** - `true` launches the browser in the [new headless](https://developer.chrome.com/articles/new-headless/) mode. - `'shell'` launches [shell](https://developer.chrome.com/blog/chrome-headless-shell) known as the old headless mode. | `true` |
| ignoreDefaultArgs | `optional` | boolean \| string\[\] | If `true`, do not use `puppeteer.defaultArgs()` 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 | `optional` | boolean | Connect to a browser over a pipe instead of a WebSocket. Only supported with Chrome. | `false` |
| timeout | `optional` | number | Maximum time in milliseconds to wait for the browser to start. Pass `0` to disable the timeout. | `30_000` (30 seconds). |
| userDataDir | `optional` | string | Path to a user data directory. [see the Chromium docs](https://chromium.googlesource.com/chromium/src/+/refs/heads/main/docs/user_data_dir.md) for more info. | |
| waitForInitialPage | `optional` | boolean | Whether to wait for the initial page to be ready. Useful when a user explicitly disables that (e.g. `--no-startup-window` for Chrome). | `true` |