Skip to main content
Version: 22.4.1

LaunchOptions interface

Generic launch options that can be passed when launching any browser.

Signature:

export interface LaunchOptions

Properties

PropertyModifiersTypeDescriptionDefault
channeloptionalChromeReleaseChannelChrome Release Channel
dumpiooptionalbooleanIf true, pipes the browser process stdout and stderr to process.stdout and process.stderr.false
envoptionalRecord<string, string | undefined>Specify environment variables that will be visible to the browser.The contents of process.env.
executablePathoptionalstringPath 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.
extraPrefsFirefoxoptionalRecord<string, unknown>Additional preferences that can be passed when launching with Firefox.
handleSIGHUPoptionalbooleanClose the browser process on SIGHUP.true
handleSIGINToptionalbooleanClose the browser process on Ctrl+C.true
handleSIGTERMoptionalbooleanClose the browser process on SIGTERM.true
ignoreDefaultArgsoptionalboolean | 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
pipeoptionalbooleanConnect to a browser over a pipe instead of a WebSocket.false
productoptionalProductWhich browser to launch.chrome
timeoutoptionalnumberMaximum time in milliseconds to wait for the browser to start. Pass 0 to disable the timeout.30_000 (30 seconds).
waitForInitialPageoptionalbooleanWhether to wait for the initial page to be ready. Useful when a user explicitly disables that (e.g. --no-startup-window for Chrome).true