puppeteer/assets/js/3940abcb.8b4062dc.js

/*! For license information please see 3940abcb.8b4062dc.js.LICENSE.txt */
"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[20969],{17045:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>o,contentTitle:()=>i,default:()=>a,frontMatter:()=>d,metadata:()=>c,toc:()=>l});var n=t(85893),s=t(11151);const d={sidebar_label:"LaunchOptions"},i="LaunchOptions interface",c={id:"api/puppeteer.launchoptions",title:"LaunchOptions interface",description:"Generic launch options that can be passed when launching any browser.",source:"@site/../docs/api/puppeteer.launchoptions.md",sourceDirName:"api",slug:"/api/puppeteer.launchoptions",permalink:"/next/api/puppeteer.launchoptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{sidebar_label:"LaunchOptions"},sidebar:"api",previous:{title:"launch",permalink:"/next/api/puppeteer.launch"},next:{title:"Locator",permalink:"/next/api/puppeteer.locator"}},o={},l=[{value:"Signature:",id:"signature",level:4},{value:"Properties",id:"properties",level:2}];function h(e){const r={a:"a",code:"code",h1:"h1",h2:"h2",h4:"h4",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,s.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.h1,{id:"launchoptions-interface",children:"LaunchOptions interface"}),"\n",(0,n.jsx)(r.p,{children:"Generic launch options that can be passed when launching any browser."}),"\n",(0,n.jsx)(r.h4,{id:"signature",children:"Signature:"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-typescript",children:"export interface LaunchOptions\n"})}),"\n",(0,n.jsx)(r.h2,{id:"properties",children:"Properties"}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Property"}),(0,n.jsx)(r.th,{children:"Modifiers"}),(0,n.jsx)(r.th,{children:"Type"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Default"})]})}),(0,n.jsxs)(r.tbody,{children:[(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"channel"}),(0,n.jsx)(r.td,{children:(0,n.jsx)("code",{children:"optional"})}),(0,n.jsx)(r.td,{children:(0,n.jsx)(r.a,{href:"/next/api/puppeteer.chromereleasechannel",children:"ChromeReleaseChannel"})}),(0,n.jsx)(r.td,{children:"Chrome Release Channel"}),(0,n.jsx)(r.td,{})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"dumpio"}),(0,n.jsx)(r.td,{children:(0,n.jsx)("code",{children:"optional"})}),(0,n.jsx)(r.td,{children:"boolean"}),(0,n.jsxs)(r.td,{children:["If true, pipes the browser process stdout and stderr to ",(0,n.jsx)("code",{children:"process.stdout"})," and ",(0,n.jsx)("code",{children:"process.stderr"}),"."]}),(0,n.jsx)(r.td,{children:(0,n.jsx)("code",{children:"false"})})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"env"}),(0,n.jsx)(r.td,{children:(0,n.jsx)("code",{children:"optional"})}),(0,n.jsx)(r.td,{children:"Record<string, string | undefined>"}),(0,n.jsx)(r.td,{children:"Specify environment variables that will be visible to the browser."}),(0,n.jsxs)(r.td,{children:["The contents of ",(0,n.jsx)("code",{children:"process.env"}),"."]})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"executablePath"}),(0,n.jsx)(r.td,{children:(0,n.jsx)("code",{children:"optional"})}),(0,n.jsx)(r.td,{children:"string"}),(0,n.jsx)(r.td,{children:"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."}),(0,n.jsx)(r.td,{})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"extraPrefsFirefox"}),(0,n.jsx)(r.td,{children:(0,n.jsx)("code",{children:"optional"})}),(0,n.jsx)(r.td,{children:"Record<string, unknown>"}),(0,n.jsxs)(r.td,{children:[(0,n.jsx)(r.a,{href:"https://searchfox.org/mozilla-release/source/modules/libpref/init/all.js",children:"Additional preferences"})," that can be passed when launching with Firefox."]}),(0,n.jsx)(r.td,{})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"handleSIGHUP"}),(0,n.jsx)(r.td,{children:(0,n.jsx)("code",{children:"optional"})}),(0,n.jsx)(r.td,{children:"boolean"}),(0,n.jsxs)(r.td,{children:["Close the brow