puppeteer/assets/js/c7c6bf8b.969c074d.js

/*! For license information please see c7c6bf8b.969c074d.js.LICENSE.txt */
"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[73191],{77102:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>i,metadata:()=>l,toc:()=>a});var s=t(85893),n=t(11151);const i={sidebar_label:"InstallOptions"},o="InstallOptions interface",l={id:"browsers-api/browsers.installoptions",title:"InstallOptions interface",description:"Signature:",source:"@site/../docs/browsers-api/browsers.installoptions.md",sourceDirName:"browsers-api",slug:"/browsers-api/browsers.installoptions",permalink:"/next/browsers-api/browsers.installoptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{sidebar_label:"InstallOptions"},sidebar:"browsersApi",previous:{title:"InstalledBrowser",permalink:"/next/browsers-api/browsers.installedbrowser"},next:{title:"LaunchOptions",permalink:"/next/browsers-api/browsers.launchoptions"}},d={},a=[{value:"Signature:",id:"signature",level:4},{value:"Properties",id:"properties",level:2}];function c(e){const r={a:"a",code:"code",h1:"h1",h2:"h2",h4:"h4",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,n.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(r.h1,{id:"installoptions-interface",children:"InstallOptions interface"}),"\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 InstallOptions\n"})}),"\n",(0,s.jsx)(r.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsxs)(r.table,{children:[(0,s.jsx)(r.thead,{children:(0,s.jsxs)(r.tr,{children:[(0,s.jsx)(r.th,{children:"Property"}),(0,s.jsx)(r.th,{children:"Modifiers"}),(0,s.jsx)(r.th,{children:"Type"}),(0,s.jsx)(r.th,{children:"Description"}),(0,s.jsx)(r.th,{children:"Default"})]})}),(0,s.jsxs)(r.tbody,{children:[(0,s.jsxs)(r.tr,{children:[(0,s.jsx)(r.td,{children:"baseUrl"}),(0,s.jsx)(r.td,{children:(0,s.jsx)("code",{children:"optional"})}),(0,s.jsx)(r.td,{children:"string"}),(0,s.jsx)(r.td,{children:"Determines the host that will be used for downloading."}),(0,s.jsxs)(r.td,{children:[(0,s.jsx)("p",{children:"Either"}),(0,s.jsxs)("p",{children:["- ",(0,s.jsx)(r.a,{href:"https://storage.googleapis.com/chrome-for-testing-public",children:"https://storage.googleapis.com/chrome-for-testing-public"})," or - ",(0,s.jsx)(r.a,{href:"https://archive.mozilla.org/pub/firefox/nightly/latest-mozilla-central",children:"https://archive.mozilla.org/pub/firefox/nightly/latest-mozilla-central"})]})]})]}),(0,s.jsxs)(r.tr,{children:[(0,s.jsx)(r.td,{children:"browser"}),(0,s.jsx)(r.td,{}),(0,s.jsx)(r.td,{children:(0,s.jsx)(r.a,{href:"/next/browsers-api/browsers.browser",children:"Browser"})}),(0,s.jsx)(r.td,{children:"Determines which browser to install."}),(0,s.jsx)(r.td,{})]}),(0,s.jsxs)(r.tr,{children:[(0,s.jsx)(r.td,{children:"buildId"}),(0,s.jsx)(r.td,{}),(0,s.jsx)(r.td,{children:"string"}),(0,s.jsx)(r.td,{children:"Determines which buildId to download. BuildId should uniquely identify binaries and they are used for caching."}),(0,s.jsx)(r.td,{})]}),(0,s.jsxs)(r.tr,{children:[(0,s.jsx)(r.td,{children:"cacheDir"}),(0,s.jsx)(r.td,{}),(0,s.jsx)(r.td,{children:"string"}),(0,s.jsx)(r.td,{children:"Determines the path to download browsers to."}),(0,s.jsx)(r.td,{})]}),(0,s.jsxs)(r.tr,{children:[(0,s.jsx)(r.td,{children:"downloadProgressCallback"}),(0,s.jsx)(r.td,{children:(0,s.jsx)("code",{children:"optional"})}),(0,s.jsx)(r.td,{children:"(downloadedBytes: number, totalBytes: number) => void"}),(0,s.jsx)(r.td,{children:"Provides information about the progress of the download."}),(0,s.jsx)(r.td,{})]}),(0,s.jsxs)(r.tr,{children:[(0,s.jsx)(r.td,{children:"platform"}),(0,s.jsx)(r.td,{children:(0,s.jsx)("code",{children:"optional"})}),(0,s.jsx)(r.td,{children:(0,s.jsx)(r.a,{href:"/next/browsers-api/browsers.browserplatform",children:"BrowserPlatform"})}),(0,s.jsx)(r.td,{children:"Determines which platform the browser will be suited for."}),(0,s.jsx)(r.td,{children:(0,s.jsx)(r.strong,{children:"Auto-detected."})})]}),(0,s.jsxs)(r.tr