<titledata-rh="true">LaunchOptions interface | Puppeteer</title><metadata-rh="true"name="viewport"content="width=device-width,initial-scale=1"><metadata-rh="true"name="twitter:card"content="summary_large_image"><metadata-rh="true"property="og:url"content="https://pptr.dev/api/puppeteer.launchoptions"><metadata-rh="true"property="og:locale"content="en"><metadata-rh="true"name="docsearch:language"content="en"><metadata-rh="true"name="docsearch:counter"content="2"><metadata-rh="true"property="og:title"content="LaunchOptions interface | Puppeteer"><metadata-rh="true"name="description"content="Generic launch options that can be passed when launching any browser."><metadata-rh="true"property="og:description"content="Generic launch options that can be passed when launching any browser."><linkdata-rh="true"rel="icon"href="/img/favicon.ico"><linkdata-rh="true"rel="canonical"href="https://pptr.dev/api/puppeteer.launchoptions"><linkdata-rh="true"rel="alternate"href="https://pptr.dev/api/puppeteer.launchoptions"hreflang="en"><linkdata-rh="true"rel="alternate"href="https://pptr.dev/api/puppeteer.launchoptions"hreflang="x-default"><linkdata-rh="true"rel="preconnect"href="https://DVKY664LG7-dsn.algolia.net"crossorigin="anonymous"><linkrel="search"type="application/opensearchdescription+xml"title="Puppeteer"href="/opensearch.xml">
<h4class="anchor anchorWithStickyNavbar_FNw8"id="signature">Signature:<aclass="hash-link"aria-label="Direct link to Signature:"title="Direct link to Signature:"href="/api/puppeteer.launchoptions#signature"></a></h4>
<h2class="anchor anchorWithStickyNavbar_FNw8"id="properties">Properties<aclass="hash-link"aria-label="Direct link to Properties"title="Direct link to Properties"href="/api/puppeteer.launchoptions#properties"></a></h2>
<table><thead><tr><th><p>Property</p></th><th><p>Modifiers</p></th><th><p>Type</p></th><th><p>Description</p></th><th><p>Default</p></th></tr></thead><tbody><tr><td><spanid="channel">channel</span></td><td><p><code>optional</code></p></td><td><p><ahref="/api/puppeteer.chromereleasechannel">ChromeReleaseChannel</a></p></td><td><p>Chrome Release Channel</p></td><td></td></tr><tr><td><spanid="dumpio">dumpio</span></td><td><p><code>optional</code></p></td><td><p>boolean</p></td><td><p>If true, pipes the browser process stdout and stderr to <code>process.stdout</code> and <code>process.stderr</code>.</p></td><td><p><code>false</code></p></td></tr><tr><td><spanid="env">env</span></td><td><p><code>optional</code></p></td><td><p>Record<string, string | undefined></p></td><td><p>Specify environment variables that will be visible to the browser.</p></td><td><p>The contents of <code>process.env</code>.</p></td></tr><tr><td><spanid="executablepath">executablePath</span></td><td><p><code>optional</code></p></td><td><p>string</p></td><td><p>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.</p></td><td></td></tr><tr><td><spanid="extraprefsfirefox">extraPrefsFirefox</span></td><td><p><code>optional</code></p></td><td><p>Record<string, unknown></p></td><td><p><ahref="https://searchfox.org/mozilla-release/source/modules/libpref/init/all.js"target="_blank"rel="noopener noreferrer">Additional preferences</a> that can be passed when launching with Firefox.</p></td><td></td></tr><tr><td><spanid="handlesighup">handleSIGHUP</span></td><td><p><code>optional</code></p></td><td><p>boolean</p></td><td><p>Close the browser process on <code>SIGHUP</code>.</p></td><td><p><code>true</code></p></td></tr><tr><td><spanid="handlesigint">handleSIGINT</span></td><td><p><code>optional</code></p></td><td><p>boolean</p></td><td><p>Close the browser process on <code>Ctrl+C</code>.</p></td><td><p><code>true</code></p></td></tr><tr><td><spanid="handlesigterm">handleSIGTERM</span></td><td><p><code>optional</code></p></td><td><p>boolean</p></td><td><p>Close the browser process on <code>SIGTERM</code>.</p></td><td><p><code>true</code></p></td></tr><tr><td><spanid="ignoredefaultargs">ignoreDefaultArgs</span></td><td><p><code>optional</code></p></td><td><p>boolean | string[]</p></td><td><p>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.</p></td><td><p><code>false</code></p></td></tr><tr><td><spanid="pipe">pipe</span></td><td><p><code>optional</code></p></td><td><p>boolean</p></td><td><p>Connect to a browser over a pipe instead of a WebSocket.</p></td><td><p><code>false</code></p></td></tr><tr><td><spanid="product">product</span></td><td><p><code>optional</code></p></td><td><p><ahref="/api/puppeteer.product">Product</a></p></td><td><p>Which browser to launch.</p></td><td><p><code>chrome</code></p></td></tr><tr><td><spanid="timeout">timeout</span></td><td><p><code>optional</code></p></td><td><p>number</p></td><td><p>Maximum time in milliseconds to wait for the browser to start. Pass <code>0</code> to disable the timeout.</p></td><td><p><code>30_000</code> (30 seconds).</p></td></tr><tr><td><spanid="waitforinitialpage">waitForInitialPage</span></td><td><p><code>optional</code></p></td><td><p>boolean</p></td><td><p>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).</p></td><td><p><code>true</code></p></td></tr></tbody></table></div></article><navclass="pagination-nav docusaurus-mt-lg"aria-label="Docs pages"><aclass="pagination-nav__link pagination-nav__link--prev"href="/api/puppeteer.launch"><divclass="pagination-nav__sublabel">Previous</div><divclass="pagination-nav__label">launch</div></a><aclass="pagination-nav__linkpagination-nav_
