puppeteer/assets/js/ac27853b.3d24cc84.js

"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[34808],{3905:(t,e,r)=>{r.d(e,{Zo:()=>u,kt:()=>m});var n=r(67294);function a(t,e,r){return e in t?Object.defineProperty(t,e,{value:r,enumerable:!0,configurable:!0,writable:!0}):t[e]=r,t}function l(t,e){var r=Object.keys(t);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(t);e&&(n=n.filter((function(e){return Object.getOwnPropertyDescriptor(t,e).enumerable}))),r.push.apply(r,n)}return r}function o(t){for(var e=1;e<arguments.length;e++){var r=null!=arguments[e]?arguments[e]:{};e%2?l(Object(r),!0).forEach((function(e){a(t,e,r[e])})):Object.getOwnPropertyDescriptors?Object.defineProperties(t,Object.getOwnPropertyDescriptors(r)):l(Object(r)).forEach((function(e){Object.defineProperty(t,e,Object.getOwnPropertyDescriptor(r,e))}))}return t}function i(t,e){if(null==t)return{};var r,n,a=function(t,e){if(null==t)return{};var r,n,a={},l=Object.keys(t);for(n=0;n<l.length;n++)r=l[n],e.indexOf(r)>=0||(a[r]=t[r]);return a}(t,e);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(t);for(n=0;n<l.length;n++)r=l[n],e.indexOf(r)>=0||Object.prototype.propertyIsEnumerable.call(t,r)&&(a[r]=t[r])}return a}var s=n.createContext({}),p=function(t){var e=n.useContext(s),r=e;return t&&(r="function"==typeof t?t(e):o(o({},e),t)),r},u=function(t){var e=p(t.components);return n.createElement(s.Provider,{value:e},t.children)},d={inlineCode:"code",wrapper:function(t){var e=t.children;return n.createElement(n.Fragment,{},e)}},c=n.forwardRef((function(t,e){var r=t.components,a=t.mdxType,l=t.originalType,s=t.parentName,u=i(t,["components","mdxType","originalType","parentName"]),c=p(r),m=a,b=c["".concat(s,".").concat(m)]||c[m]||d[m]||l;return r?n.createElement(b,o(o({ref:e},u),{},{components:r})):n.createElement(b,o({ref:e},u))}));function m(t,e){var r=arguments,a=e&&e.mdxType;if("string"==typeof t||a){var l=r.length,o=new Array(l);o[0]=c;var i={};for(var s in e)hasOwnProperty.call(e,s)&&(i[s]=e[s]);i.originalType=t,i.mdxType="string"==typeof t?t:a,o[1]=i;for(var p=2;p<l;p++)o[p]=r[p];return n.createElement.apply(null,o)}return n.createElement.apply(null,r)}c.displayName="MDXCreateElement"},99186:(t,e,r)=>{r.r(e),r.d(e,{assets:()=>p,contentTitle:()=>i,default:()=>c,frontMatter:()=>o,metadata:()=>s,toc:()=>u});r(67294);var n=r(3905);function a(){return a=Object.assign||function(t){for(var e=1;e<arguments.length;e++){var r=arguments[e];for(var n in r)Object.prototype.hasOwnProperty.call(r,n)&&(t[n]=r[n])}return t},a.apply(this,arguments)}function l(t,e){if(null==t)return{};var r,n,a=function(t,e){if(null==t)return{};var r,n,a={},l=Object.keys(t);for(n=0;n<l.length;n++)r=l[n],e.indexOf(r)>=0||(a[r]=t[r]);return a}(t,e);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(t);for(n=0;n<l.length;n++)r=l[n],e.indexOf(r)>=0||Object.prototype.propertyIsEnumerable.call(t,r)&&(a[r]=t[r])}return a}const o={sidebar_label:"InstallOptions"},i="InstallOptions interface",s={unversionedId:"browsers-api/browsers.installoptions",id:"version-21.1.0/browsers-api/browsers.installoptions",title:"InstallOptions interface",description:"Signature:",source:"@site/versioned_docs/version-21.1.0/browsers-api/browsers.installoptions.md",sourceDirName:"browsers-api",slug:"/browsers-api/browsers.installoptions",permalink:"/browsers-api/browsers.installoptions",draft:!1,tags:[],version:"21.1.0",frontMatter:{sidebar_label:"InstallOptions"},sidebar:"browsersApi",previous:{title:"InstalledBrowser",permalink:"/browsers-api/browsers.installedbrowser"},next:{title:"LaunchOptions",permalink:"/browsers-api/browsers.launchoptions"}},p={},u=[{value:"Signature:",id:"signature",level:4},{value:"Properties",id:"properties",level:2}],d={toc:u};function c(t){var{components:e}=t,r=l(t,["components"]);return(0,n.kt)("wrapper",a({},d,r,{components:e,mdxType:"MDXLayout"}),(0,n.kt)("h1",a({},{id:"installoptions-interface"}),"InstallOptions interface"),(0,n.kt)("h4",a({},{id:"signature"}),"Signature:"),(0,n.kt)("pre",null,(0,n.kt)("code",a({parentName:"pre"},{className:"language-typescript"}),"export interface InstallOptions\n")),(0,n.kt)("h2",a({},{id:"properties"}),"Properties"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",a({parentName:"tr"},{align:null}),"Property"),(0,n.kt)("th",a({parentName:"tr"},{align:null}),"Modifiers"),(0,n.kt)("th",a({parentName:"tr"},{align:null}),"Type"),(0,n.kt)("th",a({parentName:"tr"},{align:null}),"Description"),(0,n.kt)("th",a({parentName:"tr"},{align:null}),"Default"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",a({parentName:"tr"},{align:null}),"baseUrl"),(0,n.kt)("td",a({parentName:"tr"},{align:null}),(0,n.kt)("code",null,"optional")),(0,n.kt)("td",a({parentName:"tr"},{align:null}),"string"),(0,n.kt)("td",a({parentName:"tr"},{align:null}),"Determines the host that will be used for downloading."),(0,n.kt)("td",a({parentName:"tr"},{align:null}),(0,n.kt)("p",null,"Either"),(0,n.kt)("p",null,"- ",(0,n.kt)("a",a({parentName:"td"},{href:"https://edgedl.me.gvt1.com/edgedl/chrome/chrome-for-testing"}),"https://edgedl.me.gvt1.com/edgedl/chrome/chrome-for-testing")," or - ",(0,n.kt)("a",a({parentName:"td"},{href:"https://archive.mozilla.org/pub/firefox/nightly/latest-mozilla-central"}),"https://archive.mozilla.org/pub/firefox/nightly/latest-mozilla-central")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",a({parentName:"tr"},{align:null}),"browser"),(0,n.kt)("td",a({parentName:"tr"},{align:null})),(0,n.kt)("td",a({parentName:"tr"},{align:null}),(0,n.kt)("a",a({parentName:"td"},{href:"/browsers-api/browsers.browser"}),"Browser")),(0,n.kt)("td",a({parentName:"tr"},{align:null}),"Determines which browser to install."),(0,n.kt)("td",a({parentName:"tr"},{align:null}))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",a({parentName:"tr"},{align:null}),"buildId"),(0,n.kt)("td",a({parentName:"tr"},{align:null})),(0,n.kt)("td",a({parentName:"tr"},{align:null}),"string"),(0,n.kt)("td",a({parentName:"tr"},{align:null}),"Determines which buildId to download. BuildId should uniquely identify binaries and they are used for caching."),(0,n.kt)("td",a({parentName:"tr"},{align:null}))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",a({parentName:"tr"},{align:null}),"cacheDir"),(0,n.kt)("td",a({parentName:"tr"},{align:null})),(0,n.kt)("td",a({parentName:"tr"},{align:null}),"string"),(0,n.kt)("td",a({parentName:"tr"},{align:null}),"Determines the path to download browsers to."),(0,n.kt)("td",a({parentName:"tr"},{align:null}))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",a({parentName:"tr"},{align:null}),"downloadProgressCallback"),(0,n.kt)("td",a({parentName:"tr"},{align:null}),(0,n.kt)("code",null,"optional")),(0,n.kt)("td",a({parentName:"tr"},{align:null}),"(downloadedBytes: number, totalBytes: number) =",">"," void"),(0,n.kt)("td",a({parentName:"tr"},{align:null}),"Provides information about the progress of the download."),(0,n.kt)("td",a({parentName:"tr"},{align:null}))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",a({parentName:"tr"},{align:null}),"platform"),(0,n.kt)("td",a({parentName:"tr"},{align:null}),(0,n.kt)("code",null,"optional")),(0,n.kt)("td",a({parentName:"tr"},{align:null}),(0,n.kt)("a",a({parentName:"td"},{href:"/browsers-api/browsers.browserplatform"}),"BrowserPlatform")),(0,n.kt)("td",a({parentName:"tr"},{align:null}),"Determines which platform the browser will be suited for."),(0,n.kt)("td",a({parentName:"tr"},{align:null}),(0,n.kt)("strong",{parentName:"td"},"Auto-detected."))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",a({parentName:"tr"},{align:null}),"unpack"),(0,n.kt)("td",a({parentName:"tr"},{align:null}),(0,n.kt)("code",null,"optional")),(0,n.kt)("td",a({parentName:"tr"},{align:null}),"boolean"),(0,n.kt)("td",a({parentName:"tr"},{align:null}),"Whether to unpack and install browser archives."),(0,n.kt)("td",a({parentName:"tr"},{align:null}),(0,n.kt)("code",null,"true"))))))}c.isMDXComponent=!0}}]);