2022-07-05 13:41:43 +00:00
---
sidebar_label: LaunchOptions
---
# LaunchOptions interface
Generic launch options that can be passed when launching any browser.
2022-10-24 07:07:05 +00:00
#### Signature:
2022-07-05 13:41:43 +00:00
```typescript
export interface LaunchOptions
```
## Properties
2024-03-20 15:03:14 +00:00
< table > < thead > < tr > < th >
Property
< / th > < th >
Modifiers
< / th > < th >
Type
< / th > < th >
Description
< / th > < th >
Default
< / th > < / tr > < / thead >
< tbody > < tr > < td >
2024-04-11 11:01:13 +00:00
< span id = "channel" > channel< / span >
2024-03-20 15:03:14 +00:00
< / td > < td >
`optional`
< / td > < td >
[ChromeReleaseChannel ](./puppeteer.chromereleasechannel.md )
< / td > < td >
Chrome Release Channel
< / td > < td >
< / td > < / tr >
< tr > < td >
2024-04-11 11:01:13 +00:00
< span id = "dumpio" > dumpio< / span >
2024-03-20 15:03:14 +00:00
< / td > < td >
`optional`
< / td > < td >
boolean
< / td > < td >
If true, pipes the browser process stdout and stderr to `process.stdout` and `process.stderr` .
< / td > < td >
`false`
< / td > < / tr >
< tr > < td >
2024-04-11 11:01:13 +00:00
< span id = "env" > env< / span >
2024-03-20 15:03:14 +00:00
< / td > < td >
`optional`
< / td > < td >
Record< string, string \| undefined>
< / td > < td >
Specify environment variables that will be visible to the browser.
< / td > < td >
The contents of `process.env` .
< / td > < / tr >
< tr > < td >
2024-04-11 11:01:13 +00:00
< span id = "executablepath" > executablePath< / span >
2024-03-20 15:03:14 +00:00
< / td > < td >
`optional`
< / td > < td >
string
< / td > < td >
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.
< / td > < td >
< / td > < / tr >
< tr > < td >
2024-04-11 11:01:13 +00:00
< span id = "extraprefsfirefox" > extraPrefsFirefox< / span >
2024-03-20 15:03:14 +00:00
< / td > < td >
`optional`
< / td > < td >
Record< string, unknown>
< / td > < td >
[Additional preferences ](https://searchfox.org/mozilla-release/source/modules/libpref/init/all.js ) that can be passed when launching with Firefox.
< / td > < td >
< / td > < / tr >
< tr > < td >
2024-04-11 11:01:13 +00:00
< span id = "handlesighup" > handleSIGHUP< / span >
2024-03-20 15:03:14 +00:00
< / td > < td >
`optional`
< / td > < td >
boolean
< / td > < td >
Close the browser process on `SIGHUP` .
< / td > < td >
`true`
< / td > < / tr >
< tr > < td >
2024-04-11 11:01:13 +00:00
< span id = "handlesigint" > handleSIGINT< / span >
2024-03-20 15:03:14 +00:00
< / td > < td >
`optional`
< / td > < td >
boolean
< / td > < td >
Close the browser process on `Ctrl+C` .
< / td > < td >
`true`
< / td > < / tr >
< tr > < td >
2024-04-11 11:01:13 +00:00
< span id = "handlesigterm" > handleSIGTERM< / span >
2024-03-20 15:03:14 +00:00
< / td > < td >
`optional`
< / td > < td >
boolean
< / td > < td >
Close the browser process on `SIGTERM` .
< / td > < td >
`true`
< / td > < / tr >
< tr > < td >
2024-04-11 11:01:13 +00:00
< span id = "ignoredefaultargs" > ignoreDefaultArgs< / span >
2024-03-20 15:03:14 +00:00
< / td > < td >
`optional`
< / td > < td >
boolean \| string\[\]
< / td > < td >
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.
< / td > < td >
`false`
< / td > < / tr >
< tr > < td >
2024-04-11 11:01:13 +00:00
< span id = "pipe" > pipe< / span >
2024-03-20 15:03:14 +00:00
< / td > < td >
`optional`
< / td > < td >
boolean
< / td > < td >
Connect to a browser over a pipe instead of a WebSocket.
< / td > < td >
`false`
< / td > < / tr >
< tr > < td >
2024-04-11 11:01:13 +00:00
< span id = "product" > product< / span >
2024-03-20 15:03:14 +00:00
< / td > < td >
`optional`
< / td > < td >
[Product ](./puppeteer.product.md )
< / td > < td >
Which browser to launch.
< / td > < td >
`chrome`
< / td > < / tr >
< tr > < td >
2024-04-11 11:01:13 +00:00
< span id = "timeout" > timeout< / span >
2024-03-20 15:03:14 +00:00
< / td > < td >
`optional`
< / td > < td >
number
< / td > < td >
Maximum time in milliseconds to wait for the browser to start. Pass `0` to disable the timeout.
< / td > < td >
`30_000` (30 seconds).
< / td > < / tr >
< tr > < td >
2024-04-11 11:01:13 +00:00
< span id = "waitforinitialpage" > waitForInitialPage< / span >
2024-03-20 15:03:14 +00:00
< / td > < td >
`optional`
< / td > < td >
boolean
< / td > < td >
Whether to wait for the initial page to be ready. Useful when a user explicitly disables that (e.g. `--no-startup-window` for Chrome).
< / td > < td >
`true`
< / td > < / tr >
< / tbody > < / table >