puppeteer/assets/js/3940abcb.826ae4c3.js

"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[20969],{3905:(t,e,n)=>{n.d(e,{Zo:()=>s,kt:()=>m});var a=n(67294);function r(t,e,n){return e in t?Object.defineProperty(t,e,{value:n,enumerable:!0,configurable:!0,writable:!0}):t[e]=n,t}function l(t,e){var n=Object.keys(t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(t);e&&(a=a.filter((function(e){return Object.getOwnPropertyDescriptor(t,e).enumerable}))),n.push.apply(n,a)}return n}function p(t){for(var e=1;e<arguments.length;e++){var n=null!=arguments[e]?arguments[e]:{};e%2?l(Object(n),!0).forEach((function(e){r(t,e,n[e])})):Object.getOwnPropertyDescriptors?Object.defineProperties(t,Object.getOwnPropertyDescriptors(n)):l(Object(n)).forEach((function(e){Object.defineProperty(t,e,Object.getOwnPropertyDescriptor(n,e))}))}return t}function i(t,e){if(null==t)return{};var n,a,r=function(t,e){if(null==t)return{};var n,a,r={},l=Object.keys(t);for(a=0;a<l.length;a++)n=l[a],e.indexOf(n)>=0||(r[n]=t[n]);return r}(t,e);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(t);for(a=0;a<l.length;a++)n=l[a],e.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(t,n)&&(r[n]=t[n])}return r}var o=a.createContext({}),u=function(t){var e=a.useContext(o),n=e;return t&&(n="function"==typeof t?t(e):p(p({},e),t)),n},s=function(t){var e=u(t.components);return a.createElement(o.Provider,{value:e},t.children)},d={inlineCode:"code",wrapper:function(t){var e=t.children;return a.createElement(a.Fragment,{},e)}},c=a.forwardRef((function(t,e){var n=t.components,r=t.mdxType,l=t.originalType,o=t.parentName,s=i(t,["components","mdxType","originalType","parentName"]),c=u(n),m=r,k=c["".concat(o,".").concat(m)]||c[m]||d[m]||l;return n?a.createElement(k,p(p({ref:e},s),{},{components:n})):a.createElement(k,p({ref:e},s))}));function m(t,e){var n=arguments,r=e&&e.mdxType;if("string"==typeof t||r){var l=n.length,p=new Array(l);p[0]=c;var i={};for(var o in e)hasOwnProperty.call(e,o)&&(i[o]=e[o]);i.originalType=t,i.mdxType="string"==typeof t?t:r,p[1]=i;for(var u=2;u<l;u++)p[u]=n[u];return a.createElement.apply(null,p)}return a.createElement.apply(null,n)}c.displayName="MDXCreateElement"},39475:(t,e,n)=>{n.r(e),n.d(e,{assets:()=>u,contentTitle:()=>i,default:()=>c,frontMatter:()=>p,metadata:()=>o,toc:()=>s});n(67294);var a=n(3905);function r(){return r=Object.assign||function(t){for(var e=1;e<arguments.length;e++){var n=arguments[e];for(var a in n)Object.prototype.hasOwnProperty.call(n,a)&&(t[a]=n[a])}return t},r.apply(this,arguments)}function l(t,e){if(null==t)return{};var n,a,r=function(t,e){if(null==t)return{};var n,a,r={},l=Object.keys(t);for(a=0;a<l.length;a++)n=l[a],e.indexOf(n)>=0||(r[n]=t[n]);return r}(t,e);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(t);for(a=0;a<l.length;a++)n=l[a],e.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(t,n)&&(r[n]=t[n])}return r}const p={sidebar_label:"LaunchOptions"},i="LaunchOptions interface",o={unversionedId:"api/puppeteer.launchoptions",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,tags:[],version:"current",frontMatter:{sidebar_label:"LaunchOptions"},sidebar:"api",previous:{title:"launch",permalink:"/next/api/puppeteer.launch"},next:{title:"LaunchOptions.channel",permalink:"/next/api/puppeteer.launchoptions.channel"}},u={},s=[{value:"Signature:",id:"signature",level:4},{value:"Properties",id:"properties",level:2}],d={toc:s};function c(t){var{components:e}=t,n=l(t,["components"]);return(0,a.kt)("wrapper",r({},d,n,{components:e,mdxType:"MDXLayout"}),(0,a.kt)("h1",r({},{id:"launchoptions-interface"}),"LaunchOptions interface"),(0,a.kt)("p",null,"Generic launch options that can be passed when launching any browser."),(0,a.kt)("h4",r({},{id:"signature"}),"Signature:"),(0,a.kt)("pre",null,(0,a.kt)("code",r({parentName:"pre"},{className:"language-typescript"}),"export interface LaunchOptions\n")),(0,a.kt)("h2",r({},{id:"properties"}),"Properties"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",r({parentName:"tr"},{align:null}),"Property"),(0,a.kt)("th",r({parentName:"tr"},{align:null}),"Modifiers"),(0,a.kt)("th",r({parentName:"tr"},{align:null}),"Type"),(0,a.kt)("th",r({parentName:"tr"},{align:null}),"Description"),(0,a.kt)("th",r({parentName:"tr"},{align:null}),"Default"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",r({parentName:"tr"},{align:null}),(0,a.kt)("a",r({parentName:"td"},{href:"/next/api/puppeteer.launchoptions.channel"}),"channel?")),(0,a.kt)("td",r({parentName:"tr"},{align:null})),(0,a.kt)("td",r({parentName:"tr"},{align:null}),(0,a.kt)("a",r({parentName:"td"},{href:"/next/api/puppeteer.chromereleasechannel"}),"ChromeReleaseChannel")),(0,a.kt)("td",r({parentName:"tr"},{align:null}),(0,a.kt)("i",null,"(Optional)")," Chrome Release Channel"),(0,a.kt)("td",r({parentName:"tr"},{align:null}))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",r({parentName:"tr"},{align:null}),(0,a.kt)("a",r({parentName:"td"},{href:"/next/api/puppeteer.launchoptions.dumpio"}),"dumpio?")),(0,a.kt)("td",r({parentName:"tr"},{align:null})),(0,a.kt)("td",r({parentName:"tr"},{align:null}),"boolean"),(0,a.kt)("td",r({parentName:"tr"},{align:null}),(0,a.kt)("i",null,"(Optional)")," If true, pipes the browser process stdout and stderr to ",(0,a.kt)("code",null,"process.stdout")," and ",(0,a.kt)("code",null,"process.stderr"),"."),(0,a.kt)("td",r({parentName:"tr"},{align:null}),"false")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",r({parentName:"tr"},{align:null}),(0,a.kt)("a",r({parentName:"td"},{href:"/next/api/puppeteer.launchoptions.env"}),"env?")),(0,a.kt)("td",r({parentName:"tr"},{align:null})),(0,a.kt)("td",r({parentName:"tr"},{align:null}),"Record","<","string, string ","|"," undefined",">"),(0,a.kt)("td",r({parentName:"tr"},{align:null}),(0,a.kt)("i",null,"(Optional)")," Specify environment variables that will be visible to the browser."),(0,a.kt)("td",r({parentName:"tr"},{align:null}),"The contents of ",(0,a.kt)("code",null,"process.env"),".")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",r({parentName:"tr"},{align:null}),(0,a.kt)("a",r({parentName:"td"},{href:"/next/api/puppeteer.launchoptions.executablepath"}),"executablePath?")),(0,a.kt)("td",r({parentName:"tr"},{align:null})),(0,a.kt)("td",r({parentName:"tr"},{align:null}),"string"),(0,a.kt)("td",r({parentName:"tr"},{align:null}),(0,a.kt)("i",null,"(Optional)")," 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,a.kt)("td",r({parentName:"tr"},{align:null}))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",r({parentName:"tr"},{align:null}),(0,a.kt)("a",r({parentName:"td"},{href:"/next/api/puppeteer.launchoptions.extraprefsfirefox"}),"extraPrefsFirefox?")),(0,a.kt)("td",r({parentName:"tr"},{align:null})),(0,a.kt)("td",r({parentName:"tr"},{align:null}),"Record","<","string, unknown",">"),(0,a.kt)("td",r({parentName:"tr"},{align:null}),(0,a.kt)("i",null,"(Optional)")," ",(0,a.kt)("a",r({parentName:"td"},{href:"https://searchfox.org/mozilla-release/source/modules/libpref/init/all.js"}),"Additional preferences")," that can be passed when launching with Firefox."),(0,a.kt)("td",r({parentName:"tr"},{align:null}))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",r({parentName:"tr"},{align:null}),(0,a.kt)("a",r({parentName:"td"},{href:"/next/api/puppeteer.launchoptions.handlesighup"}),"handleSIGHUP?")),(0,a.kt)("td",r({parentName:"tr"},{align:null})),(0,a.kt)("td",r({parentName:"tr"},{align:null}),"boolean"),(0,a.kt)("td",r({parentName:"tr"},{align:null}),(0,a.kt)("i",null,"(Optional)")," Close the browser process on ",(0,a.kt)("code",null,"SIGHUP"),"."),(0,a.kt)("td",r({parentName:"tr"},{align:null}),(0,a.kt)("code",null,"true"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",r({parentName:"tr"},{align:null}),(0,a.kt)("a",r({parentName:"td"},{href:"/next/api/puppeteer.launchoptions.handlesigint"}),"handleSIGINT?")),(0,a.kt)("td",r({parentName:"tr"},{align:null})),(0,a.kt)("td",r({parentName:"tr"},{align:null}),"boolean"),(0,a.kt)("td",r({parentName:"tr"},{align:null}),(0,a.kt)("i",null,"(Optional)")," Close the browser process on ",(0,a.kt)("code",null,"Ctrl+C"),"."),(0,a.kt)("td",r({parentName:"tr"},{align:null}),(0,a.kt)("code",null,"true"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",r({parentName:"tr"},{align:null}),(0,a.kt)("a",r({parentName:"td"},{href:"/next/api/puppeteer.launchoptions.handlesigterm"}),"handleSIGTERM?")),(0,a.kt)("td",r({parentName:"tr"},{align:null})),(0,a.kt)("td",r({parentName:"tr"},{align:null}),"boolean"),(0,a.kt)("td",r({parentName:"tr"},{align:null}),(0,a.kt)("i",null,"(Optional)")," Close the browser process on ",(0,a.kt)("code",null,"SIGTERM"),"."),(0,a.kt)("td",r({parentName:"tr"},{align:null}),(0,a.kt)("code",null,"true"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",r({parentName:"tr"},{align:null}),(0,a.kt)("a",r({parentName:"td"},{href:"/next/api/puppeteer.launchoptions.ignoredefaultargs"}),"ignoreDefaultArgs?")),(0,a.kt)("td",r({parentName:"tr"},{align:null})),(0,a.kt)("td",r({parentName:"tr"},{align:null}),"boolean ","|"," string","[","]"),(0,a.kt)("td",r({parentName:"tr"},{align:null}),(0,a.kt)("i",null,"(Optional)")," If ",(0,a.kt)("code",null,"true"),", do not use ",(0,a.kt)("code",null,"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."),(0,a.kt)("td",r({parentName:"tr"},{align:null}),"false")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",r({parentName:"tr"},{align:null}),(0,a.kt)("a",r({parentName:"td"},{href:"/next/api/puppeteer.launchoptions.pipe"}),"pipe?")),(0,a.kt)("td",r({parentName:"tr"},{align:null})),(0,a.kt)("td",r({parentName:"tr"},{align:null}),"boolean"),(0,a.kt)("td",r({parentName:"tr"},{align:null}),(0,a.kt)("i",null,"(Optional)")," Connect to a browser over a pipe instead of a WebSocket."),(0,a.kt)("td",r({parentName:"tr"},{align:null}),"false")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",r({parentName:"tr"},{align:null}),(0,a.kt)("a",r({parentName:"td"},{href:"/next/api/puppeteer.launchoptions.product"}),"product?")),(0,a.kt)("td",r({parentName:"tr"},{align:null})),(0,a.kt)("td",r({parentName:"tr"},{align:null}),(0,a.kt)("a",r({parentName:"td"},{href:"/next/api/puppeteer.product"}),"Product")),(0,a.kt)("td",r({parentName:"tr"},{align:null}),(0,a.kt)("i",null,"(Optional)")," Which browser to launch."),(0,a.kt)("td",r({parentName:"tr"},{align:null}),(0,a.kt)("code",null,"chrome"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",r({parentName:"tr"},{align:null}),(0,a.kt)("a",r({parentName:"td"},{href:"/next/api/puppeteer.launchoptions.timeout"}),"timeout?")),(0,a.kt)("td",r({parentName:"tr"},{align:null})),(0,a.kt)("td",r({parentName:"tr"},{align:null}),"number"),(0,a.kt)("td",r({parentName:"tr"},{align:null}),(0,a.kt)("i",null,"(Optional)")," Maximum time in milliseconds to wait for the browser to start. Pass ",(0,a.kt)("code",null,"0")," to disable the timeout."),(0,a.kt)("td",r({parentName:"tr"},{align:null}),"30000 (30 seconds).")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",r({parentName:"tr"},{align:null}),(0,a.kt)("a",r({parentName:"td"},{href:"/next/api/puppeteer.launchoptions.waitforinitialpage"}),"waitForInitialPage?")),(0,a.kt)("td",r({parentName:"tr"},{align:null})),(0,a.kt)("td",r({parentName:"tr"},{align:null}),"boolean"),(0,a.kt)("td",r({parentName:"tr"},{align:null}),(0,a.kt)("i",null,"(Optional)")," Whether to wait for the initial page to be ready. Useful when a user explicitly disables that (e.g. ",(0,a.kt)("code",null,"--no-startup-window")," for Chrome)."),(0,a.kt)("td",r({parentName:"tr"},{align:null}),"true")))))}c.isMDXComponent=!0}}]);