Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
3.4 KiB
sidebar_label |
---|
LaunchOptions |
LaunchOptions interface
Generic launch options that can be passed when launching any browser.
Signature:
export interface LaunchOptions
Properties
Property |
Modifiers |
Type |
Description |
Default |
---|---|---|---|---|
channel |
|
Chrome Release Channel | ||
dumpio |
|
boolean |
If true, pipes the browser process stdout and stderr to |
|
env |
|
Record<string, string | undefined> |
Specify environment variables that will be visible to the browser. |
The contents of |
executablePath |
|
string |
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 |
|
Record<string, unknown> |
Additional preferences that can be passed when launching with Firefox. | |
handleSIGHUP |
|
boolean |
Close the browser process on |
|
handleSIGINT |
|
boolean |
Close the browser process on |
|
handleSIGTERM |
|
boolean |
Close the browser process on |
|
ignoreDefaultArgs |
|
boolean | string[] |
If |
|
pipe |
|
boolean |
Connect to a browser over a pipe instead of a WebSocket. |
|
product |
|
Which browser to launch. |
| |
timeout |
|
number |
Maximum time in milliseconds to wait for the browser to start. Pass |
|
waitForInitialPage |
|
boolean |
Whether to wait for the initial page to be ready. Useful when a user explicitly disables that (e.g. |
|