puppeteer/assets/js/499c971e.5af8378f.js

/*! For license information please see 499c971e.5af8378f.js.LICENSE.txt */
"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[30370],{28125:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>l,contentTitle:()=>d,default:()=>a,frontMatter:()=>i,metadata:()=>o,toc:()=>c});var s=n(85893),t=n(11151);const i={sidebar_label:"BrowserLaunchArgumentOptions"},d="BrowserLaunchArgumentOptions interface",o={id:"api/puppeteer.browserlaunchargumentoptions",title:"BrowserLaunchArgumentOptions interface",description:"Launcher options that only apply to Chrome.",source:"@site/versioned_docs/version-22.8.2/api/puppeteer.browserlaunchargumentoptions.md",sourceDirName:"api",slug:"/api/puppeteer.browserlaunchargumentoptions",permalink:"/api/puppeteer.browserlaunchargumentoptions",draft:!1,unlisted:!1,tags:[],version:"22.8.2",frontMatter:{sidebar_label:"BrowserLaunchArgumentOptions"},sidebar:"api",previous:{title:"BrowserEvents",permalink:"/api/puppeteer.browserevents"},next:{title:"CDPEvents",permalink:"/api/puppeteer.cdpevents"}},l={},c=[{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",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(r.h1,{id:"browserlaunchargumentoptions-interface",children:"BrowserLaunchArgumentOptions interface"}),"\n",(0,s.jsx)(r.p,{children:"Launcher options that only apply to Chrome."}),"\n",(0,s.jsx)(r.h4,{id:"signature",children:"Signature:"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-typescript",children:"export interface BrowserLaunchArgumentOptions\n"})}),"\n",(0,s.jsx)(r.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsxs)("table",{children:[(0,s.jsx)("thead",{children:(0,s.jsxs)("tr",{children:[(0,s.jsx)("th",{children:(0,s.jsx)(r.p,{children:"Property"})}),(0,s.jsx)("th",{children:(0,s.jsx)(r.p,{children:"Modifiers"})}),(0,s.jsx)("th",{children:(0,s.jsx)(r.p,{children:"Type"})}),(0,s.jsx)("th",{children:(0,s.jsx)(r.p,{children:"Description"})}),(0,s.jsx)("th",{children:(0,s.jsx)(r.p,{children:"Default"})})]})}),(0,s.jsxs)("tbody",{children:[(0,s.jsxs)("tr",{children:[(0,s.jsx)("td",{children:(0,s.jsx)("span",{id:"args",children:"args"})}),(0,s.jsx)("td",{children:(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"optional"})})}),(0,s.jsx)("td",{children:(0,s.jsx)(r.p,{children:"string[]"})}),(0,s.jsx)("td",{children:(0,s.jsx)(r.p,{children:"Additional command line arguments to pass to the browser instance."})}),(0,s.jsx)("td",{})]}),(0,s.jsxs)("tr",{children:[(0,s.jsx)("td",{children:(0,s.jsx)("span",{id:"debuggingport",children:"debuggingPort"})}),(0,s.jsx)("td",{children:(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"optional"})})}),(0,s.jsx)("td",{children:(0,s.jsx)(r.p,{children:"number"})}),(0,s.jsx)("td",{children:(0,s.jsx)(r.p,{children:"Specify the debugging port number to use"})}),(0,s.jsx)("td",{})]}),(0,s.jsxs)("tr",{children:[(0,s.jsx)("td",{children:(0,s.jsx)("span",{id:"devtools",children:"devtools"})}),(0,s.jsx)("td",{children:(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"optional"})})}),(0,s.jsx)("td",{children:(0,s.jsx)(r.p,{children:"boolean"})}),(0,s.jsx)("td",{children:(0,s.jsxs)(r.p,{children:["Whether to auto-open a DevTools panel for each tab. If this is set to ",(0,s.jsx)(r.code,{children:"true"}),", then ",(0,s.jsx)(r.code,{children:"headless"})," will be forced to ",(0,s.jsx)(r.code,{children:"false"}),"."]})}),(0,s.jsx)("td",{children:(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"false"})})})]}),(0,s.jsxs)("tr",{children:[(0,s.jsx)("td",{children:(0,s.jsx)("span",{id:"headless",children:"headless"})}),(0,s.jsx)("td",{children:(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"optional"})})}),(0,s.jsx)("td",{children:(0,s.jsx)(r.p,{children:"boolean | 'shell'"})}),(0,s.jsxs)("td",{children:[(0,s.jsx)(r.p,{children:"Whether to run the browser in headless mode."}),(0,s.jsx)(r.p,{children:(0,s.jsx)(r.strong,{children:"Remarks:"})}),(0,s.jsxs)(r.ul,{children:["\n",(0,s.jsxs)(r.li,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"true"})," launches the browser in the ",(0,s.jsx)(r.a,{href:"https://developer.chrome.com/articles/new-headless/",children:"new headless"})," mode."]}),"\n"]}),"\n",(0,s.jsxs)(r.li,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"'shell'"})," launches ",(0,s.jsx)(r.a,{href:"https://developer.chrome.com/blog/chrome-headless-shell",children:"shell"})," known as the old headless mode."]}),"\n"]}),"\n"]})]}),(0,s.jsx)("td",{children:(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"true"})})})]}),(0,s.jsxs)("tr",{children:[(0,s.jsx)("td",{children:(0,s.jsx)("span",{id:"userdatadir",children:"userDataDir"})}),(0,s.jsx)("td",{children:(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"optional"})})}),(0,s.jsx)("td",{children:(0,s.jsx)(r.p,{children:"string"})}),(0,s.jsx)("td",{children:(0,s.jsxs)(r.p,{children:["Path to a user data directory. ",(0,s.jsx)(r.a,{href:"https://chromium.googlesource.com/chromium/src/+/refs/heads/main/docs/user_data_dir.md",children:"see the Chromium docs"})," for more info."]})}),(0,s.jsx)("td",{})]})]})]})]})}function a(e={}){const{wrapper:r}={...(0,t.a)(),...e.components};return r?(0,s.jsx)(r,{...e,children:(0,s.jsx)(h,{...e})}):h(e)}},75251:(e,r,n)=>{var s=n(67294),t=Symbol.for("react.element"),i=Symbol.for("react.fragment"),d=Object.prototype.hasOwnProperty,o=s.__SECRET_INTERNALS_DO_NOT_USE_OR_YOU_WILL_BE_FIRED.ReactCurrentOwner,l={key:!0,ref:!0,__self:!0,__source:!0};function c(e,r,n){var s,i={},c=null,h=null;for(s in void 0!==n&&(c=""+n),void 0!==r.key&&(c=""+r.key),void 0!==r.ref&&(h=r.ref),r)d.call(r,s)&&!l.hasOwnProperty(s)&&(i[s]=r[s]);if(e&&e.defaultProps)for(s in r=e.defaultProps)void 0===i[s]&&(i[s]=r[s]);return{$$typeof:t,type:e,key:c,ref:h,props:i,_owner:o.current}}r.Fragment=i,r.jsx=c,r.jsxs=c},85893:(e,r,n)=>{e.exports=n(75251)},11151:(e,r,n)=>{n.d(r,{Z:()=>o,a:()=>d});var s=n(67294);const t={},i=s.createContext(t);function d(e){const r=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function o(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:d(e.components),s.createElement(i.Provider,{value:r},e.children)}}}]);