mirror of
https://github.com/puppeteer/puppeteer
synced 2024-06-14 14:02:48 +00:00
5.9 KiB
5.9 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 | optional |
ChromeReleaseChannel | Chrome Release Channel | |
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 Chromium. Note that Puppeteer is only guaranteed to work with the bundled Chromium, so use this setting at your own risk. | |
extraPrefsFirefox | optional |
Record<string, unknown> | Additional preferences 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 |
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. | false |
product | optional |
Product | Which browser to launch. | chrome |
timeout | optional |
number | Maximum time in milliseconds to wait for the browser to start. Pass 0 to disable the timeout. |
30_000 (30 seconds). |
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 |