puppeteer/website/versioned_docs/version-19.4.0/api/puppeteer.launchoptions.md
release-please[bot] 931d4fced5
chore: release main (#9322)
🤖 I have created a release *beep* *boop*
---


<details><summary>puppeteer: 19.4.0</summary>

##
[19.4.0](https://github.com/puppeteer/puppeteer/compare/puppeteer-v19.3.0...puppeteer-v19.4.0)
(2022-12-07)


### Features

* **chromium:** roll to Chromium 109.0.5412.0 (r1069273)
([#9364](https://github.com/puppeteer/puppeteer/issues/9364))
([1875da6](1875da6191)),
closes [#9233](https://github.com/puppeteer/puppeteer/issues/9233)


### Dependencies

* The following workspace dependencies were updated
  * dependencies
    * puppeteer-core bumped from 19.3.0 to 19.4.0
</details>

<details><summary>puppeteer-core: 19.4.0</summary>

##
[19.4.0](https://github.com/puppeteer/puppeteer/compare/puppeteer-core-v19.3.0...puppeteer-core-v19.4.0)
(2022-12-07)


### Features

* ability to send headers via ws connection to browser in node.js
environment
([#9314](https://github.com/puppeteer/puppeteer/issues/9314))
([937fffa](937fffaedc)),
closes [#7218](https://github.com/puppeteer/puppeteer/issues/7218)
* **chromium:** roll to Chromium 109.0.5412.0 (r1069273)
([#9364](https://github.com/puppeteer/puppeteer/issues/9364))
([1875da6](1875da6191)),
closes [#9233](https://github.com/puppeteer/puppeteer/issues/9233)
* **puppeteer-core:** keydown supports commands
([#9357](https://github.com/puppeteer/puppeteer/issues/9357))
([b7ebc5d](b7ebc5d9bb))


### Bug Fixes

* **puppeteer-core:** avoid type instantiation errors
([#9370](https://github.com/puppeteer/puppeteer/issues/9370))
([17f31a9](17f31a9ee4)),
closes [#9369](https://github.com/puppeteer/puppeteer/issues/9369)
</details>

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
2022-12-07 19:35:29 +01:00

32 lines
6.7 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) | <i>(Optional)</i> Chrome Release Channel | |
| [dumpio?](./puppeteer.launchoptions.dumpio.md) | | boolean | <i>(Optional)</i> 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&lt;string, string \| undefined&gt; | <i>(Optional)</i> Specify environment variables that will be visible to the browser. | The contents of <code>process.env</code>. |
| [executablePath?](./puppeteer.launchoptions.executablepath.md) | | string | <i>(Optional)</i> 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&lt;string, unknown&gt; | <i>(Optional)</i> [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 | <i>(Optional)</i> Close the browser process on <code>SIGHUP</code>. | <code>true</code> |
| [handleSIGINT?](./puppeteer.launchoptions.handlesigint.md) | | boolean | <i>(Optional)</i> Close the browser process on <code>Ctrl+C</code>. | <code>true</code> |
| [handleSIGTERM?](./puppeteer.launchoptions.handlesigterm.md) | | boolean | <i>(Optional)</i> Close the browser process on <code>SIGTERM</code>. | <code>true</code> |
| [ignoreDefaultArgs?](./puppeteer.launchoptions.ignoredefaultargs.md) | | boolean \| string\[\] | <i>(Optional)</i> 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 | <i>(Optional)</i> Connect to a browser over a pipe instead of a WebSocket. | false |
| [product?](./puppeteer.launchoptions.product.md) | | [Product](./puppeteer.product.md) | <i>(Optional)</i> Which browser to launch. | <code>chrome</code> |
| [timeout?](./puppeteer.launchoptions.timeout.md) | | number | <i>(Optional)</i> 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 | <i>(Optional)</i> 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 |