From e2aaadca5ad64268862135d025f9f3839fea5e5c Mon Sep 17 00:00:00 2001 From: Randolf Date: Mon, 24 Oct 2022 05:39:15 +0200 Subject: [PATCH] fix: update documentation --- README.md | 95 +-- docs/api/index.md | 3 +- docs/api/puppeteer.accessibility.md | 2 +- docs/api/puppeteer.accessibility.snapshot.md | 2 +- docs/api/puppeteer.actionresult.md | 2 +- docs/api/puppeteer.awaitable.md | 2 +- docs/api/puppeteer.boundingbox.height.md | 2 +- docs/api/puppeteer.boundingbox.md | 10 +- docs/api/puppeteer.boundingbox.width.md | 2 +- docs/api/puppeteer.boxmodel.border.md | 2 +- docs/api/puppeteer.boxmodel.content.md | 2 +- docs/api/puppeteer.boxmodel.height.md | 2 +- docs/api/puppeteer.boxmodel.margin.md | 2 +- docs/api/puppeteer.boxmodel.md | 18 +- docs/api/puppeteer.boxmodel.padding.md | 2 +- docs/api/puppeteer.boxmodel.width.md | 2 +- docs/api/puppeteer.browser.browsercontexts.md | 2 +- docs/api/puppeteer.browser.close.md | 2 +- ...r.browser.createincognitobrowsercontext.md | 2 +- ...puppeteer.browser.defaultbrowsercontext.md | 2 +- docs/api/puppeteer.browser.disconnect.md | 2 +- docs/api/puppeteer.browser.isconnected.md | 2 +- docs/api/puppeteer.browser.md | 2 +- docs/api/puppeteer.browser.newpage.md | 2 +- docs/api/puppeteer.browser.pages.md | 2 +- docs/api/puppeteer.browser.process.md | 2 +- docs/api/puppeteer.browser.target.md | 2 +- docs/api/puppeteer.browser.targets.md | 2 +- docs/api/puppeteer.browser.useragent.md | 2 +- docs/api/puppeteer.browser.version.md | 2 +- docs/api/puppeteer.browser.waitfortarget.md | 2 +- docs/api/puppeteer.browser.wsendpoint.md | 2 +- ...r.browserconnectoptions.defaultviewport.md | 2 +- ...browserconnectoptions.ignorehttpserrors.md | 6 +- docs/api/puppeteer.browserconnectoptions.md | 14 +- .../puppeteer.browserconnectoptions.slowmo.md | 2 +- ...teer.browserconnectoptions.targetfilter.md | 2 +- docs/api/puppeteer.browsercontext.browser.md | 2 +- ...browsercontext.clearpermissionoverrides.md | 2 +- docs/api/puppeteer.browsercontext.close.md | 2 +- docs/api/puppeteer.browsercontext.id.md | 2 +- .../puppeteer.browsercontext.isincognito.md | 2 +- docs/api/puppeteer.browsercontext.md | 2 +- docs/api/puppeteer.browsercontext.newpage.md | 2 +- ...teer.browsercontext.overridepermissions.md | 2 +- docs/api/puppeteer.browsercontext.pages.md | 2 +- docs/api/puppeteer.browsercontext.targets.md | 2 +- .../puppeteer.browsercontext.waitfortarget.md | 2 +- .../puppeteer.browsercontextemittedevents.md | 2 +- docs/api/puppeteer.browsercontextoptions.md | 10 +- ...r.browsercontextoptions.proxybypasslist.md | 2 +- ...eteer.browsercontextoptions.proxyserver.md | 2 +- docs/api/puppeteer.browseremittedevents.md | 2 +- .../puppeteer.browserfetcher._constructor_.md | 2 +- .../puppeteer.browserfetcher.candownload.md | 2 +- docs/api/puppeteer.browserfetcher.download.md | 2 +- docs/api/puppeteer.browserfetcher.host.md | 2 +- ...puppeteer.browserfetcher.localrevisions.md | 2 +- docs/api/puppeteer.browserfetcher.md | 2 +- docs/api/puppeteer.browserfetcher.platform.md | 2 +- docs/api/puppeteer.browserfetcher.product.md | 2 +- docs/api/puppeteer.browserfetcher.remove.md | 2 +- .../puppeteer.browserfetcher.revisioninfo.md | 2 +- .../puppeteer.browserfetcheroptions.host.md | 8 +- docs/api/puppeteer.browserfetcheroptions.md | 16 +- .../puppeteer.browserfetcheroptions.path.md | 2 +- ...uppeteer.browserfetcheroptions.platform.md | 6 +- ...puppeteer.browserfetcheroptions.product.md | 6 +- ...browserfetcheroptions.usemacosarmbinary.md | 2 +- ...owserfetcherrevisioninfo.executablepath.md | 2 +- ...r.browserfetcherrevisioninfo.folderpath.md | 2 +- ...peteer.browserfetcherrevisioninfo.local.md | 2 +- .../puppeteer.browserfetcherrevisioninfo.md | 18 +- ...teer.browserfetcherrevisioninfo.product.md | 2 +- ...eer.browserfetcherrevisioninfo.revision.md | 2 +- ...uppeteer.browserfetcherrevisioninfo.url.md | 2 +- ...eteer.browserlaunchargumentoptions.args.md | 2 +- ...wserlaunchargumentoptions.debuggingport.md | 2 +- ...r.browserlaunchargumentoptions.devtools.md | 6 +- ...r.browserlaunchargumentoptions.headless.md | 6 +- .../puppeteer.browserlaunchargumentoptions.md | 16 +- ...rowserlaunchargumentoptions.userdatadir.md | 2 +- docs/api/puppeteer.cdpsession.connection.md | 2 +- docs/api/puppeteer.cdpsession.detach.md | 2 +- docs/api/puppeteer.cdpsession.id.md | 2 +- docs/api/puppeteer.cdpsession.md | 2 +- docs/api/puppeteer.cdpsession.send.md | 2 +- ...ppeteer.cdpsessiononmessageobject.error.md | 2 +- .../puppeteer.cdpsessiononmessageobject.id.md | 2 +- .../puppeteer.cdpsessiononmessageobject.md | 16 +- ...peteer.cdpsessiononmessageobject.method.md | 2 +- ...peteer.cdpsessiononmessageobject.params.md | 2 +- ...peteer.cdpsessiononmessageobject.result.md | 2 +- docs/api/puppeteer.chromereleasechannel.md | 2 +- .../api/puppeteer.clearcustomqueryhandlers.md | 2 +- docs/api/puppeteer.clickoptions.button.md | 6 +- docs/api/puppeteer.clickoptions.clickcount.md | 6 +- docs/api/puppeteer.clickoptions.delay.md | 6 +- docs/api/puppeteer.clickoptions.md | 14 +- docs/api/puppeteer.clickoptions.offset.md | 2 +- ...uppeteer.commoneventemitter.addlistener.md | 2 +- docs/api/puppeteer.commoneventemitter.emit.md | 2 +- ...peteer.commoneventemitter.listenercount.md | 2 +- docs/api/puppeteer.commoneventemitter.md | 2 +- docs/api/puppeteer.commoneventemitter.off.md | 2 +- docs/api/puppeteer.commoneventemitter.on.md | 2 +- docs/api/puppeteer.commoneventemitter.once.md | 2 +- ...r.commoneventemitter.removealllisteners.md | 2 +- ...eteer.commoneventemitter.removelistener.md | 2 +- ...puppeteer.configuration.browserrevision.md | 12 +- .../puppeteer.configuration.cachedirectory.md | 10 +- .../puppeteer.configuration.defaultproduct.md | 10 +- .../puppeteer.configuration.downloadhost.md | 14 +- .../puppeteer.configuration.downloadpath.md | 10 +- .../puppeteer.configuration.executablepath.md | 10 +- .../puppeteer.configuration.experiments.md | 8 +- docs/api/puppeteer.configuration.loglevel.md | 10 +- docs/api/puppeteer.configuration.md | 30 +- .../puppeteer.configuration.skipdownload.md | 6 +- ...peteer.configuration.temporarydirectory.md | 10 +- docs/api/puppeteer.connect.md | 2 +- .../api/puppeteer.connection._constructor_.md | 2 +- .../api/puppeteer.connection.createsession.md | 2 +- docs/api/puppeteer.connection.dispose.md | 2 +- docs/api/puppeteer.connection.fromsession.md | 2 +- docs/api/puppeteer.connection.md | 2 +- docs/api/puppeteer.connection.send.md | 2 +- docs/api/puppeteer.connection.session.md | 2 +- docs/api/puppeteer.connection.url.md | 2 +- .../api/puppeteer.connectioncallback.error.md | 2 +- docs/api/puppeteer.connectioncallback.md | 10 +- .../puppeteer.connectioncallback.method.md | 2 +- .../puppeteer.connectioncallback.reject.md | 2 +- .../puppeteer.connectioncallback.resolve.md | 2 +- .../puppeteer.connectiontransport.close.md | 2 +- docs/api/puppeteer.connectiontransport.md | 10 +- .../puppeteer.connectiontransport.onclose.md | 2 +- ...puppeteer.connectiontransport.onmessage.md | 2 +- .../api/puppeteer.connectiontransport.send.md | 2 +- .../puppeteer.connectoptions.browserurl.md | 2 +- ...peteer.connectoptions.browserwsendpoint.md | 2 +- docs/api/puppeteer.connectoptions.md | 12 +- .../api/puppeteer.connectoptions.transport.md | 2 +- .../puppeteer.consolemessage._constructor_.md | 2 +- docs/api/puppeteer.consolemessage.args.md | 2 +- docs/api/puppeteer.consolemessage.location.md | 2 +- docs/api/puppeteer.consolemessage.md | 2 +- .../puppeteer.consolemessage.stacktrace.md | 2 +- docs/api/puppeteer.consolemessage.text.md | 2 +- docs/api/puppeteer.consolemessage.type.md | 2 +- ...eer.consolemessagelocation.columnnumber.md | 2 +- ...eteer.consolemessagelocation.linenumber.md | 2 +- docs/api/puppeteer.consolemessagelocation.md | 12 +- .../puppeteer.consolemessagelocation.url.md | 2 +- docs/api/puppeteer.consolemessagetype.md | 2 +- ...peteer.continuerequestoverrides.headers.md | 2 +- .../api/puppeteer.continuerequestoverrides.md | 14 +- ...ppeteer.continuerequestoverrides.method.md | 2 +- ...eteer.continuerequestoverrides.postdata.md | 2 +- .../puppeteer.continuerequestoverrides.url.md | 2 +- docs/api/puppeteer.coverage._constructor_.md | 2 +- docs/api/puppeteer.coverage.md | 2 +- .../puppeteer.coverage.startcsscoverage.md | 2 +- .../api/puppeteer.coverage.startjscoverage.md | 2 +- .../api/puppeteer.coverage.stopcsscoverage.md | 2 +- docs/api/puppeteer.coverage.stopjscoverage.md | 2 +- docs/api/puppeteer.coverageentry.md | 12 +- docs/api/puppeteer.coverageentry.ranges.md | 2 +- docs/api/puppeteer.coverageentry.text.md | 2 +- docs/api/puppeteer.coverageentry.url.md | 2 +- docs/api/puppeteer.createbrowserfetcher.md | 2 +- docs/api/puppeteer.credentials.md | 10 +- docs/api/puppeteer.credentials.password.md | 2 +- docs/api/puppeteer.credentials.username.md | 2 +- .../puppeteer.csscoverage._constructor_.md | 2 +- docs/api/puppeteer.csscoverage.md | 2 +- docs/api/puppeteer.csscoverage.start.md | 2 +- docs/api/puppeteer.csscoverage.stop.md | 2 +- docs/api/puppeteer.csscoverageoptions.md | 8 +- ...er.csscoverageoptions.resetonnavigation.md | 2 +- docs/api/puppeteer.customerror.md | 2 +- docs/api/puppeteer.customqueryhandler.md | 10 +- .../puppeteer.customqueryhandler.queryall.md | 2 +- .../puppeteer.customqueryhandler.queryone.md | 2 +- docs/api/puppeteer.customqueryhandlernames.md | 2 +- ...r.default_intercept_resolution_priority.md | 2 +- docs/api/puppeteer.defaultargs.md | 2 +- docs/api/puppeteer.device.md | 10 +- docs/api/puppeteer.device.useragent.md | 2 +- docs/api/puppeteer.device.viewport.md | 2 +- docs/api/puppeteer.devices.md | 2 +- docs/api/puppeteer.dialog.accept.md | 2 +- docs/api/puppeteer.dialog.defaultvalue.md | 2 +- docs/api/puppeteer.dialog.dismiss.md | 2 +- docs/api/puppeteer.dialog.md | 2 +- docs/api/puppeteer.dialog.message.md | 2 +- docs/api/puppeteer.dialog.type.md | 2 +- docs/api/puppeteer.elementhandle._.md | 2 +- docs/api/puppeteer.elementhandle.__.md | 2 +- docs/api/puppeteer.elementhandle.__eval.md | 2 +- docs/api/puppeteer.elementhandle._eval.md | 2 +- docs/api/puppeteer.elementhandle._x.md | 2 +- docs/api/puppeteer.elementhandle.aselement.md | 2 +- .../puppeteer.elementhandle.boundingbox.md | 2 +- docs/api/puppeteer.elementhandle.boxmodel.md | 2 +- docs/api/puppeteer.elementhandle.click.md | 2 +- .../puppeteer.elementhandle.clickablepoint.md | 2 +- .../puppeteer.elementhandle.contentframe.md | 2 +- docs/api/puppeteer.elementhandle.drag.md | 2 +- .../puppeteer.elementhandle.draganddrop.md | 2 +- docs/api/puppeteer.elementhandle.dragenter.md | 2 +- docs/api/puppeteer.elementhandle.dragover.md | 2 +- docs/api/puppeteer.elementhandle.drop.md | 2 +- docs/api/puppeteer.elementhandle.focus.md | 2 +- docs/api/puppeteer.elementhandle.frame.md | 2 +- docs/api/puppeteer.elementhandle.hover.md | 2 +- ...er.elementhandle.isintersectingviewport.md | 2 +- docs/api/puppeteer.elementhandle.md | 2 +- docs/api/puppeteer.elementhandle.press.md | 2 +- .../api/puppeteer.elementhandle.screenshot.md | 2 +- docs/api/puppeteer.elementhandle.select.md | 2 +- docs/api/puppeteer.elementhandle.tap.md | 2 +- docs/api/puppeteer.elementhandle.type.md | 2 +- .../api/puppeteer.elementhandle.uploadfile.md | 2 +- ...puppeteer.elementhandle.waitforselector.md | 2 +- .../puppeteer.elementhandle.waitforxpath.md | 2 +- docs/api/puppeteer.errorcode.md | 2 +- docs/api/puppeteer.errors.md | 2 +- docs/api/puppeteer.evaluatefunc.md | 2 +- docs/api/puppeteer.evaluation_script_url.md | 2 +- .../api/puppeteer.eventemitter.addlistener.md | 2 +- docs/api/puppeteer.eventemitter.emit.md | 2 +- .../puppeteer.eventemitter.listenercount.md | 2 +- docs/api/puppeteer.eventemitter.md | 2 +- docs/api/puppeteer.eventemitter.off.md | 2 +- docs/api/puppeteer.eventemitter.on.md | 2 +- docs/api/puppeteer.eventemitter.once.md | 2 +- ...ppeteer.eventemitter.removealllisteners.md | 2 +- .../puppeteer.eventemitter.removelistener.md | 2 +- docs/api/puppeteer.eventtype.md | 2 +- docs/api/puppeteer.executablepath.md | 2 +- ...entsconfiguration.macarmchromiumenabled.md | 23 + .../api/puppeteer.experimentsconfiguration.md | 21 + docs/api/puppeteer.filechooser.accept.md | 2 +- docs/api/puppeteer.filechooser.cancel.md | 2 +- docs/api/puppeteer.filechooser.ismultiple.md | 2 +- docs/api/puppeteer.filechooser.md | 2 +- docs/api/puppeteer.flattenhandle.md | 2 +- docs/api/puppeteer.frame._.md | 2 +- docs/api/puppeteer.frame.__.md | 2 +- docs/api/puppeteer.frame.__eval.md | 2 +- docs/api/puppeteer.frame._eval.md | 2 +- docs/api/puppeteer.frame._x.md | 2 +- docs/api/puppeteer.frame.addscripttag.md | 2 +- docs/api/puppeteer.frame.addstyletag.md | 2 +- docs/api/puppeteer.frame.addstyletag_1.md | 2 +- docs/api/puppeteer.frame.childframes.md | 2 +- docs/api/puppeteer.frame.click.md | 2 +- docs/api/puppeteer.frame.content.md | 2 +- docs/api/puppeteer.frame.evaluate.md | 2 +- docs/api/puppeteer.frame.evaluatehandle.md | 2 +- docs/api/puppeteer.frame.focus.md | 2 +- docs/api/puppeteer.frame.goto.md | 2 +- docs/api/puppeteer.frame.hover.md | 2 +- docs/api/puppeteer.frame.isdetached.md | 2 +- docs/api/puppeteer.frame.isoopframe.md | 2 +- docs/api/puppeteer.frame.md | 2 +- docs/api/puppeteer.frame.name.md | 2 +- docs/api/puppeteer.frame.page.md | 2 +- docs/api/puppeteer.frame.parentframe.md | 2 +- docs/api/puppeteer.frame.select.md | 2 +- docs/api/puppeteer.frame.setcontent.md | 2 +- docs/api/puppeteer.frame.tap.md | 2 +- docs/api/puppeteer.frame.title.md | 2 +- docs/api/puppeteer.frame.type.md | 2 +- docs/api/puppeteer.frame.url.md | 2 +- docs/api/puppeteer.frame.waitforfunction.md | 2 +- docs/api/puppeteer.frame.waitfornavigation.md | 2 +- docs/api/puppeteer.frame.waitforselector.md | 2 +- docs/api/puppeteer.frame.waitfortimeout.md | 2 +- docs/api/puppeteer.frame.waitforxpath.md | 2 +- ...peteer.frameaddscripttagoptions.content.md | 2 +- .../puppeteer.frameaddscripttagoptions.id.md | 2 +- .../api/puppeteer.frameaddscripttagoptions.md | 16 +- ...puppeteer.frameaddscripttagoptions.path.md | 2 +- ...puppeteer.frameaddscripttagoptions.type.md | 2 +- .../puppeteer.frameaddscripttagoptions.url.md | 2 +- ...ppeteer.frameaddstyletagoptions.content.md | 2 +- docs/api/puppeteer.frameaddstyletagoptions.md | 12 +- .../puppeteer.frameaddstyletagoptions.path.md | 2 +- .../puppeteer.frameaddstyletagoptions.url.md | 2 +- .../puppeteer.framewaitforfunctionoptions.md | 10 +- ...eer.framewaitforfunctionoptions.polling.md | 2 +- ...eer.framewaitforfunctionoptions.timeout.md | 2 +- .../puppeteer.geolocationoptions.accuracy.md | 2 +- .../puppeteer.geolocationoptions.latitude.md | 2 +- .../puppeteer.geolocationoptions.longitude.md | 2 +- docs/api/puppeteer.geolocationoptions.md | 12 +- docs/api/puppeteer.handlefor.md | 2 +- docs/api/puppeteer.handleor.md | 2 +- docs/api/puppeteer.handler.md | 2 +- docs/api/puppeteer.httprequest.abort.md | 2 +- .../puppeteer.httprequest.aborterrorreason.md | 2 +- docs/api/puppeteer.httprequest.client.md | 2 +- docs/api/puppeteer.httprequest.continue.md | 2 +- ...er.httprequest.continuerequestoverrides.md | 2 +- ...teer.httprequest.enqueueinterceptaction.md | 2 +- docs/api/puppeteer.httprequest.failure.md | 2 +- ...eteer.httprequest.finalizeinterceptions.md | 2 +- docs/api/puppeteer.httprequest.frame.md | 2 +- docs/api/puppeteer.httprequest.headers.md | 2 +- docs/api/puppeteer.httprequest.initiator.md | 2 +- ...er.httprequest.interceptresolutionstate.md | 2 +- ...ttprequest.isinterceptresolutionhandled.md | 2 +- ...ppeteer.httprequest.isnavigationrequest.md | 2 +- docs/api/puppeteer.httprequest.md | 2 +- docs/api/puppeteer.httprequest.method.md | 2 +- docs/api/puppeteer.httprequest.postdata.md | 2 +- .../puppeteer.httprequest.redirectchain.md | 2 +- .../api/puppeteer.httprequest.resourcetype.md | 2 +- docs/api/puppeteer.httprequest.respond.md | 2 +- docs/api/puppeteer.httprequest.response.md | 2 +- ...uppeteer.httprequest.responseforrequest.md | 2 +- docs/api/puppeteer.httprequest.url.md | 2 +- docs/api/puppeteer.httpresponse.buffer.md | 2 +- docs/api/puppeteer.httpresponse.frame.md | 2 +- docs/api/puppeteer.httpresponse.fromcache.md | 2 +- ...uppeteer.httpresponse.fromserviceworker.md | 2 +- docs/api/puppeteer.httpresponse.headers.md | 2 +- docs/api/puppeteer.httpresponse.json.md | 2 +- docs/api/puppeteer.httpresponse.md | 2 +- docs/api/puppeteer.httpresponse.ok.md | 2 +- .../puppeteer.httpresponse.remoteaddress.md | 2 +- docs/api/puppeteer.httpresponse.request.md | 2 +- .../puppeteer.httpresponse.securitydetails.md | 2 +- docs/api/puppeteer.httpresponse.status.md | 2 +- docs/api/puppeteer.httpresponse.statustext.md | 2 +- docs/api/puppeteer.httpresponse.text.md | 2 +- docs/api/puppeteer.httpresponse.timing.md | 2 +- docs/api/puppeteer.httpresponse.url.md | 2 +- docs/api/puppeteer.innerparams.md | 2 +- .../puppeteer.interceptresolutionaction.md | 2 +- ...ppeteer.interceptresolutionstate.action.md | 2 +- .../api/puppeteer.interceptresolutionstate.md | 10 +- ...eteer.interceptresolutionstate.priority.md | 2 +- .../puppeteer.interceptresolutionstrategy.md | 2 +- .../puppeteer.internalnetworkconditions.md | 8 +- ...eteer.internalnetworkconditions.offline.md | 2 +- .../api/puppeteer.jscoverage._constructor_.md | 2 +- docs/api/puppeteer.jscoverage.md | 2 +- docs/api/puppeteer.jscoverage.start.md | 2 +- docs/api/puppeteer.jscoverage.stop.md | 2 +- docs/api/puppeteer.jscoverageentry.md | 8 +- ...eteer.jscoverageentry.rawscriptcoverage.md | 2 +- ...overageoptions.includerawscriptcoverage.md | 2 +- docs/api/puppeteer.jscoverageoptions.md | 14 +- ...scoverageoptions.reportanonymousscripts.md | 2 +- ...eer.jscoverageoptions.resetonnavigation.md | 2 +- ...teer.jscoverageoptions.useblockcoverage.md | 2 +- .../puppeteer.jshandle.___jshandlesymbol_.md | 2 +- docs/api/puppeteer.jshandle.aselement.md | 2 +- docs/api/puppeteer.jshandle.dispose.md | 2 +- docs/api/puppeteer.jshandle.evaluate.md | 2 +- docs/api/puppeteer.jshandle.evaluatehandle.md | 2 +- docs/api/puppeteer.jshandle.getproperties.md | 2 +- docs/api/puppeteer.jshandle.getproperty.md | 2 +- docs/api/puppeteer.jshandle.getproperty_1.md | 2 +- docs/api/puppeteer.jshandle.jsonvalue.md | 2 +- docs/api/puppeteer.jshandle.md | 2 +- docs/api/puppeteer.jshandle.remoteobject.md | 2 +- docs/api/puppeteer.jshandle.tostring.md | 2 +- docs/api/puppeteer.keyboard.down.md | 2 +- docs/api/puppeteer.keyboard.md | 2 +- docs/api/puppeteer.keyboard.press.md | 2 +- docs/api/puppeteer.keyboard.sendcharacter.md | 2 +- docs/api/puppeteer.keyboard.type.md | 2 +- docs/api/puppeteer.keyboard.up.md | 2 +- docs/api/puppeteer.keyinput.md | 2 +- docs/api/puppeteer.knowndevices.md | 2 +- docs/api/puppeteer.launch.md | 2 +- docs/api/puppeteer.launchoptions.channel.md | 2 +- docs/api/puppeteer.launchoptions.dumpio.md | 6 +- docs/api/puppeteer.launchoptions.env.md | 6 +- .../puppeteer.launchoptions.executablepath.md | 2 +- ...ppeteer.launchoptions.extraprefsfirefox.md | 2 +- .../puppeteer.launchoptions.handlesighup.md | 6 +- .../puppeteer.launchoptions.handlesigint.md | 6 +- .../puppeteer.launchoptions.handlesigterm.md | 6 +- ...ppeteer.launchoptions.ignoredefaultargs.md | 6 +- docs/api/puppeteer.launchoptions.md | 32 +- docs/api/puppeteer.launchoptions.pipe.md | 6 +- docs/api/puppeteer.launchoptions.product.md | 6 +- docs/api/puppeteer.launchoptions.timeout.md | 6 +- ...peteer.launchoptions.waitforinitialpage.md | 6 +- docs/api/puppeteer.lowercasepaperformat.md | 2 +- docs/api/puppeteer.mediafeature.md | 10 +- docs/api/puppeteer.mediafeature.name.md | 2 +- docs/api/puppeteer.mediafeature.value.md | 2 +- docs/api/puppeteer.metrics.documents.md | 2 +- docs/api/puppeteer.metrics.frames.md | 2 +- .../api/puppeteer.metrics.jseventlisteners.md | 2 +- docs/api/puppeteer.metrics.jsheaptotalsize.md | 2 +- docs/api/puppeteer.metrics.jsheapusedsize.md | 2 +- docs/api/puppeteer.metrics.layoutcount.md | 2 +- docs/api/puppeteer.metrics.layoutduration.md | 2 +- docs/api/puppeteer.metrics.md | 32 +- docs/api/puppeteer.metrics.nodes.md | 2 +- .../api/puppeteer.metrics.recalcstylecount.md | 2 +- .../puppeteer.metrics.recalcstyleduration.md | 2 +- docs/api/puppeteer.metrics.scriptduration.md | 2 +- docs/api/puppeteer.metrics.taskduration.md | 2 +- docs/api/puppeteer.metrics.timestamp.md | 2 +- docs/api/puppeteer.mouse.click.md | 2 +- docs/api/puppeteer.mouse.down.md | 2 +- docs/api/puppeteer.mouse.drag.md | 2 +- docs/api/puppeteer.mouse.draganddrop.md | 2 +- docs/api/puppeteer.mouse.dragenter.md | 2 +- docs/api/puppeteer.mouse.dragover.md | 2 +- docs/api/puppeteer.mouse.drop.md | 2 +- docs/api/puppeteer.mouse.md | 2 +- docs/api/puppeteer.mouse.move.md | 2 +- docs/api/puppeteer.mouse.up.md | 2 +- docs/api/puppeteer.mouse.wheel.md | 2 +- docs/api/puppeteer.mousebutton.md | 2 +- docs/api/puppeteer.mouseoptions.button.md | 2 +- docs/api/puppeteer.mouseoptions.clickcount.md | 2 +- docs/api/puppeteer.mouseoptions.md | 10 +- .../api/puppeteer.mousewheeloptions.deltax.md | 2 +- .../api/puppeteer.mousewheeloptions.deltay.md | 2 +- docs/api/puppeteer.mousewheeloptions.md | 10 +- .../puppeteer.networkconditions.download.md | 2 +- .../puppeteer.networkconditions.latency.md | 2 +- docs/api/puppeteer.networkconditions.md | 2 +- .../api/puppeteer.networkconditions.upload.md | 2 +- docs/api/puppeteer.nodefor.md | 2 +- docs/api/puppeteer.offset.md | 10 +- docs/api/puppeteer.offset.x.md | 2 +- docs/api/puppeteer.offset.y.md | 2 +- docs/api/puppeteer.page._.md | 2 +- docs/api/puppeteer.page.__.md | 2 +- docs/api/puppeteer.page.__eval.md | 2 +- docs/api/puppeteer.page._eval.md | 2 +- docs/api/puppeteer.page._x.md | 2 +- docs/api/puppeteer.page.accessibility.md | 2 +- docs/api/puppeteer.page.addscripttag.md | 2 +- docs/api/puppeteer.page.addstyletag.md | 2 +- docs/api/puppeteer.page.addstyletag_1.md | 2 +- docs/api/puppeteer.page.addstyletag_2.md | 2 +- docs/api/puppeteer.page.authenticate.md | 2 +- docs/api/puppeteer.page.bringtofront.md | 2 +- docs/api/puppeteer.page.browser.md | 2 +- docs/api/puppeteer.page.browsercontext.md | 2 +- docs/api/puppeteer.page.click.md | 2 +- docs/api/puppeteer.page.close.md | 2 +- docs/api/puppeteer.page.content.md | 2 +- docs/api/puppeteer.page.cookies.md | 2 +- docs/api/puppeteer.page.coverage.md | 2 +- docs/api/puppeteer.page.createpdfstream.md | 2 +- docs/api/puppeteer.page.deletecookie.md | 2 +- docs/api/puppeteer.page.emulate.md | 2 +- .../puppeteer.page.emulatecputhrottling.md | 2 +- docs/api/puppeteer.page.emulateidlestate.md | 2 +- .../puppeteer.page.emulatemediafeatures.md | 2 +- docs/api/puppeteer.page.emulatemediatype.md | 2 +- ...puppeteer.page.emulatenetworkconditions.md | 2 +- docs/api/puppeteer.page.emulatetimezone.md | 2 +- .../puppeteer.page.emulatevisiondeficiency.md | 2 +- docs/api/puppeteer.page.evaluate.md | 2 +- docs/api/puppeteer.page.evaluatehandle.md | 2 +- .../puppeteer.page.evaluateonnewdocument.md | 2 +- docs/api/puppeteer.page.exposefunction.md | 2 +- docs/api/puppeteer.page.focus.md | 2 +- docs/api/puppeteer.page.frames.md | 2 +- docs/api/puppeteer.page.getdefaulttimeout.md | 2 +- docs/api/puppeteer.page.goback.md | 2 +- docs/api/puppeteer.page.goforward.md | 2 +- docs/api/puppeteer.page.goto.md | 2 +- docs/api/puppeteer.page.hover.md | 2 +- docs/api/puppeteer.page.isclosed.md | 2 +- ...uppeteer.page.isdraginterceptionenabled.md | 2 +- .../api/puppeteer.page.isjavascriptenabled.md | 2 +- docs/api/puppeteer.page.keyboard.md | 2 +- docs/api/puppeteer.page.mainframe.md | 2 +- docs/api/puppeteer.page.md | 2 +- docs/api/puppeteer.page.metrics.md | 2 +- docs/api/puppeteer.page.mouse.md | 2 +- docs/api/puppeteer.page.off.md | 2 +- docs/api/puppeteer.page.on.md | 2 +- docs/api/puppeteer.page.once.md | 2 +- docs/api/puppeteer.page.pdf.md | 2 +- docs/api/puppeteer.page.queryobjects.md | 2 +- docs/api/puppeteer.page.reload.md | 2 +- docs/api/puppeteer.page.screenshot.md | 2 +- docs/api/puppeteer.page.select.md | 2 +- docs/api/puppeteer.page.setbypasscsp.md | 2 +- docs/api/puppeteer.page.setcacheenabled.md | 6 +- docs/api/puppeteer.page.setcontent.md | 2 +- docs/api/puppeteer.page.setcookie.md | 2 +- ...peteer.page.setdefaultnavigationtimeout.md | 2 +- docs/api/puppeteer.page.setdefaulttimeout.md | 2 +- .../api/puppeteer.page.setdraginterception.md | 2 +- .../api/puppeteer.page.setextrahttpheaders.md | 2 +- docs/api/puppeteer.page.setgeolocation.md | 2 +- .../puppeteer.page.setjavascriptenabled.md | 2 +- docs/api/puppeteer.page.setofflinemode.md | 2 +- .../puppeteer.page.setrequestinterception.md | 2 +- docs/api/puppeteer.page.setuseragent.md | 2 +- docs/api/puppeteer.page.setviewport.md | 2 +- docs/api/puppeteer.page.tap.md | 2 +- docs/api/puppeteer.page.target.md | 2 +- docs/api/puppeteer.page.title.md | 2 +- docs/api/puppeteer.page.touchscreen.md | 2 +- docs/api/puppeteer.page.tracing.md | 2 +- docs/api/puppeteer.page.type.md | 2 +- docs/api/puppeteer.page.url.md | 2 +- docs/api/puppeteer.page.viewport.md | 2 +- docs/api/puppeteer.page.waitforfilechooser.md | 2 +- docs/api/puppeteer.page.waitforframe.md | 2 +- docs/api/puppeteer.page.waitforfunction.md | 2 +- docs/api/puppeteer.page.waitfornavigation.md | 2 +- docs/api/puppeteer.page.waitfornetworkidle.md | 2 +- docs/api/puppeteer.page.waitforrequest.md | 2 +- docs/api/puppeteer.page.waitforresponse.md | 2 +- docs/api/puppeteer.page.waitforselector.md | 2 +- docs/api/puppeteer.page.waitfortimeout.md | 2 +- docs/api/puppeteer.page.waitforxpath.md | 2 +- docs/api/puppeteer.page.workers.md | 2 +- docs/api/puppeteer.pageemittedevents.md | 2 +- docs/api/puppeteer.pageeventobject.close.md | 2 +- docs/api/puppeteer.pageeventobject.console.md | 2 +- docs/api/puppeteer.pageeventobject.dialog.md | 2 +- ...peteer.pageeventobject.domcontentloaded.md | 2 +- docs/api/puppeteer.pageeventobject.error.md | 2 +- ...puppeteer.pageeventobject.frameattached.md | 2 +- ...puppeteer.pageeventobject.framedetached.md | 2 +- ...uppeteer.pageeventobject.framenavigated.md | 2 +- docs/api/puppeteer.pageeventobject.load.md | 2 +- docs/api/puppeteer.pageeventobject.md | 44 +- docs/api/puppeteer.pageeventobject.metrics.md | 2 +- .../puppeteer.pageeventobject.pageerror.md | 2 +- docs/api/puppeteer.pageeventobject.popup.md | 2 +- docs/api/puppeteer.pageeventobject.request.md | 2 +- ...puppeteer.pageeventobject.requestfailed.md | 2 +- ...ppeteer.pageeventobject.requestfinished.md | 2 +- ....pageeventobject.requestservedfromcache.md | 2 +- .../api/puppeteer.pageeventobject.response.md | 2 +- ...puppeteer.pageeventobject.workercreated.md | 2 +- ...ppeteer.pageeventobject.workerdestroyed.md | 2 +- docs/api/puppeteer.paperformat.md | 2 +- docs/api/puppeteer.pdfmargin.bottom.md | 2 +- docs/api/puppeteer.pdfmargin.left.md | 2 +- docs/api/puppeteer.pdfmargin.md | 14 +- docs/api/puppeteer.pdfmargin.right.md | 2 +- docs/api/puppeteer.pdfmargin.top.md | 2 +- ...uppeteer.pdfoptions.displayheaderfooter.md | 6 +- .../puppeteer.pdfoptions.footertemplate.md | 2 +- docs/api/puppeteer.pdfoptions.format.md | 6 +- .../puppeteer.pdfoptions.headertemplate.md | 2 +- docs/api/puppeteer.pdfoptions.height.md | 2 +- docs/api/puppeteer.pdfoptions.landscape.md | 6 +- docs/api/puppeteer.pdfoptions.margin.md | 6 +- docs/api/puppeteer.pdfoptions.md | 36 +- .../puppeteer.pdfoptions.omitbackground.md | 6 +- docs/api/puppeteer.pdfoptions.pageranges.md | 6 +- docs/api/puppeteer.pdfoptions.path.md | 6 +- .../puppeteer.pdfoptions.prefercsspagesize.md | 6 +- .../puppeteer.pdfoptions.printbackground.md | 6 +- docs/api/puppeteer.pdfoptions.scale.md | 6 +- docs/api/puppeteer.pdfoptions.timeout.md | 6 +- docs/api/puppeteer.pdfoptions.width.md | 2 +- docs/api/puppeteer.permission.md | 2 +- docs/api/puppeteer.platform.md | 2 +- docs/api/puppeteer.point.md | 10 +- docs/api/puppeteer.point.x.md | 2 +- docs/api/puppeteer.point.y.md | 2 +- .../puppeteer.predefinednetworkconditions.md | 2 +- docs/api/puppeteer.pressoptions.delay.md | 2 +- docs/api/puppeteer.pressoptions.md | 10 +- docs/api/puppeteer.pressoptions.text.md | 2 +- docs/api/puppeteer.product.md | 2 +- .../puppeteer.productlauncher.defaultargs.md | 2 +- ...uppeteer.productlauncher.executablepath.md | 2 +- docs/api/puppeteer.productlauncher.launch.md | 2 +- docs/api/puppeteer.productlauncher.md | 2 +- docs/api/puppeteer.productlauncher.product.md | 2 +- docs/api/puppeteer.protocolerror.code.md | 2 +- docs/api/puppeteer.protocolerror.md | 2 +- ...puppeteer.protocolerror.originalmessage.md | 2 +- docs/api/puppeteer.protocollifecycleevent.md | 2 +- ...teer.puppeteer.clearcustomqueryhandlers.md | 2 +- docs/api/puppeteer.puppeteer.connect.md | 2 +- ...eteer.puppeteer.customqueryhandlernames.md | 2 +- docs/api/puppeteer.puppeteer.md | 2 +- ...er.puppeteer.registercustomqueryhandler.md | 2 +- ....puppeteer.unregistercustomqueryhandler.md | 2 +- docs/api/puppeteer.puppeteererrors.md | 10 +- ...puppeteer.puppeteererrors.protocolerror.md | 2 +- .../puppeteer.puppeteererrors.timeouterror.md | 2 +- ...uppeteerlaunchoptions.extraprefsfirefox.md | 2 +- docs/api/puppeteer.puppeteerlaunchoptions.md | 10 +- ...uppeteer.puppeteerlaunchoptions.product.md | 2 +- docs/api/puppeteer.puppeteerlifecycleevent.md | 2 +- docs/api/puppeteer.puppeteernode.connect.md | 2 +- ...teer.puppeteernode.createbrowserfetcher.md | 2 +- .../puppeteer.puppeteernode.defaultargs.md | 2 +- .../puppeteer.puppeteernode.defaultproduct.md | 2 +- .../puppeteer.puppeteernode.executablepath.md | 4 +- ...eteer.puppeteernode.lastlaunchedproduct.md | 2 +- docs/api/puppeteer.puppeteernode.launch.md | 8 +- docs/api/puppeteer.puppeteernode.md | 16 +- docs/api/puppeteer.puppeteernode.product.md | 4 +- .../puppeteer.puppeteernodelaunchoptions.md | 2 +- .../puppeteer.registercustomqueryhandler.md | 2 +- docs/api/puppeteer.remoteaddress.ip.md | 2 +- docs/api/puppeteer.remoteaddress.md | 10 +- docs/api/puppeteer.remoteaddress.port.md | 2 +- docs/api/puppeteer.resourcetype.md | 2 +- docs/api/puppeteer.responseforrequest.body.md | 2 +- ...uppeteer.responseforrequest.contenttype.md | 2 +- .../puppeteer.responseforrequest.headers.md | 2 +- docs/api/puppeteer.responseforrequest.md | 14 +- .../puppeteer.responseforrequest.status.md | 2 +- docs/api/puppeteer.screenshotclip.height.md | 2 +- docs/api/puppeteer.screenshotclip.md | 16 +- docs/api/puppeteer.screenshotclip.scale.md | 6 +- docs/api/puppeteer.screenshotclip.width.md | 2 +- docs/api/puppeteer.screenshotclip.x.md | 2 +- docs/api/puppeteer.screenshotclip.y.md | 2 +- ...screenshotoptions.capturebeyondviewport.md | 6 +- docs/api/puppeteer.screenshotoptions.clip.md | 2 +- .../puppeteer.screenshotoptions.encoding.md | 6 +- ...puppeteer.screenshotoptions.fromsurface.md | 6 +- .../puppeteer.screenshotoptions.fullpage.md | 6 +- docs/api/puppeteer.screenshotoptions.md | 24 +- ...peteer.screenshotoptions.omitbackground.md | 6 +- docs/api/puppeteer.screenshotoptions.path.md | 2 +- .../puppeteer.screenshotoptions.quality.md | 2 +- docs/api/puppeteer.screenshotoptions.type.md | 6 +- docs/api/puppeteer.securitydetails.issuer.md | 2 +- docs/api/puppeteer.securitydetails.md | 2 +- .../api/puppeteer.securitydetails.protocol.md | 2 +- ...securitydetails.subjectalternativenames.md | 2 +- .../puppeteer.securitydetails.subjectname.md | 2 +- .../puppeteer.securitydetails.validfrom.md | 2 +- docs/api/puppeteer.securitydetails.validto.md | 2 +- ...puppeteer.serializedaxnode.autocomplete.md | 2 +- .../api/puppeteer.serializedaxnode.checked.md | 2 +- .../puppeteer.serializedaxnode.children.md | 2 +- .../puppeteer.serializedaxnode.description.md | 2 +- .../puppeteer.serializedaxnode.disabled.md | 2 +- .../puppeteer.serializedaxnode.expanded.md | 2 +- .../api/puppeteer.serializedaxnode.focused.md | 2 +- .../puppeteer.serializedaxnode.haspopup.md | 2 +- .../api/puppeteer.serializedaxnode.invalid.md | 2 +- ...puppeteer.serializedaxnode.keyshortcuts.md | 2 +- docs/api/puppeteer.serializedaxnode.level.md | 2 +- docs/api/puppeteer.serializedaxnode.md | 58 +- docs/api/puppeteer.serializedaxnode.modal.md | 2 +- .../puppeteer.serializedaxnode.multiline.md | 2 +- ...peteer.serializedaxnode.multiselectable.md | 2 +- docs/api/puppeteer.serializedaxnode.name.md | 2 +- .../puppeteer.serializedaxnode.orientation.md | 2 +- .../api/puppeteer.serializedaxnode.pressed.md | 2 +- .../puppeteer.serializedaxnode.readonly.md | 2 +- .../puppeteer.serializedaxnode.required.md | 2 +- docs/api/puppeteer.serializedaxnode.role.md | 2 +- ...peteer.serializedaxnode.roledescription.md | 2 +- .../puppeteer.serializedaxnode.selected.md | 2 +- docs/api/puppeteer.serializedaxnode.value.md | 2 +- .../puppeteer.serializedaxnode.valuemax.md | 2 +- .../puppeteer.serializedaxnode.valuemin.md | 2 +- .../puppeteer.serializedaxnode.valuetext.md | 2 +- ...ppeteer.snapshotoptions.interestingonly.md | 6 +- docs/api/puppeteer.snapshotoptions.md | 10 +- docs/api/puppeteer.snapshotoptions.root.md | 6 +- docs/api/puppeteer.target.browser.md | 2 +- docs/api/puppeteer.target.browsercontext.md | 2 +- docs/api/puppeteer.target.createcdpsession.md | 2 +- docs/api/puppeteer.target.md | 2 +- docs/api/puppeteer.target.opener.md | 2 +- docs/api/puppeteer.target.page.md | 2 +- docs/api/puppeteer.target.type.md | 2 +- docs/api/puppeteer.target.url.md | 2 +- docs/api/puppeteer.target.worker.md | 2 +- docs/api/puppeteer.targetfiltercallback.md | 2 +- docs/api/puppeteer.timeouterror.md | 2 +- docs/api/puppeteer.touchscreen.md | 2 +- docs/api/puppeteer.touchscreen.tap.md | 2 +- docs/api/puppeteer.tracing.md | 2 +- docs/api/puppeteer.tracing.start.md | 2 +- docs/api/puppeteer.tracing.stop.md | 2 +- .../puppeteer.tracingoptions.categories.md | 2 +- docs/api/puppeteer.tracingoptions.md | 12 +- docs/api/puppeteer.tracingoptions.path.md | 2 +- .../puppeteer.tracingoptions.screenshots.md | 2 +- .../puppeteer.unregistercustomqueryhandler.md | 2 +- .../puppeteer.viewport.devicescalefactor.md | 6 +- docs/api/puppeteer.viewport.hastouch.md | 6 +- docs/api/puppeteer.viewport.height.md | 2 +- docs/api/puppeteer.viewport.islandscape.md | 6 +- docs/api/puppeteer.viewport.ismobile.md | 6 +- docs/api/puppeteer.viewport.md | 18 +- docs/api/puppeteer.viewport.width.md | 2 +- docs/api/puppeteer.waitforoptions.md | 10 +- docs/api/puppeteer.waitforoptions.timeout.md | 6 +- .../api/puppeteer.waitforoptions.waituntil.md | 2 +- ...puppeteer.waitforselectoroptions.hidden.md | 6 +- docs/api/puppeteer.waitforselectoroptions.md | 12 +- ...uppeteer.waitforselectoroptions.timeout.md | 6 +- ...uppeteer.waitforselectoroptions.visible.md | 6 +- docs/api/puppeteer.waitfortargetoptions.md | 8 +- .../puppeteer.waitfortargetoptions.timeout.md | 6 +- docs/api/puppeteer.waittimeoutoptions.md | 8 +- .../puppeteer.waittimeoutoptions.timeout.md | 6 +- docs/api/puppeteer.webworker.evaluate.md | 2 +- .../api/puppeteer.webworker.evaluatehandle.md | 2 +- docs/api/puppeteer.webworker.md | 2 +- docs/api/puppeteer.webworker.url.md | 2 +- docs/chromium-support.md | 2 +- docs/contributing.md | 2 +- docs/faq.md | 2 +- docs/guides/_category_.yml | 6 + docs/guides/configuring-puppeteer.mdx | 130 +++ docs/guides/request-interception.md | 2 +- docs/index.md | 95 +-- docs/troubleshooting.md | 20 +- .../src/common/Configuration.ts | 106 ++- .../puppeteer-core/src/node/PuppeteerNode.ts | 33 +- packages/puppeteer-core/src/puppeteer-core.ts | 2 + tools/generate_docs.ts | 5 +- tools/internal/custom_markdown_documenter.ts | 58 +- website/package-lock.json | 792 +++++++++--------- website/package.json | 8 +- 733 files changed, 2215 insertions(+), 1616 deletions(-) create mode 100644 docs/api/puppeteer.experimentsconfiguration.macarmchromiumenabled.md create mode 100644 docs/api/puppeteer.experimentsconfiguration.md create mode 100644 docs/guides/_category_.yml create mode 100644 docs/guides/configuring-puppeteer.mdx diff --git a/README.md b/README.md index f5aa1e6d47d5c..7b2f6aea8876c 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ -#### [API](https://pptr.dev/api) | [FAQ](https://pptr.dev/faq) | [Contributing](https://pptr.dev/contributing) | [Troubleshooting](https://pptr.dev/troubleshooting) +#### [Guides](https://pptr.dev/guides) | [API](https://pptr.dev/api) | [FAQ](https://pptr.dev/faq) | [Contributing](https://pptr.dev/contributing) | [Troubleshooting](https://pptr.dev/troubleshooting) > Puppeteer is a Node.js library which provides a high-level API to control > Chrome/Chromium over the @@ -49,51 +49,32 @@ Chromium (~170MB macOS, ~282MB Linux, ~280MB Windows) that is with Puppeteer. For a version of Puppeteer without installation, see [`puppeteer-core`](#puppeteer-core). -#### Environment Variables - -Puppeteer looks for certain -[environment variables](https://en.wikipedia.org/wiki/Environment_variable) for -customizing behavior. If Puppeteer doesn't find them in the environment during -the installation step, a lowercased variant of these variables will be used from -the [npm config](https://docs.npmjs.com/cli/config). - -- `HTTP_PROXY`, `HTTPS_PROXY`, `NO_PROXY` - defines HTTP proxy settings that are - used to download and run the browser. -- `PUPPETEER_CACHE_DIR` - defines the directory to be used by Puppeteer for - caching. Defaults to - [`os.homedir()/.cache/puppeteer`](https://nodejs.org/api/os.html#os_os_homedir). -- `PUPPETEER_SKIP_CHROMIUM_DOWNLOAD` - do not download bundled Chromium during - installation step. -- `PUPPETEER_TMP_DIR` - defines the directory to be used by Puppeteer for - creating temporary files. Defaults to - [`os.tmpdir()`](https://nodejs.org/api/os.html#os_os_tmpdir). -- `PUPPETEER_DOWNLOAD_HOST` - specifies the URL prefix that is used to download - Chromium. Note: this includes protocol and might even include path prefix. - Defaults to `https://storage.googleapis.com`. -- `PUPPETEER_DOWNLOAD_PATH` - specifies the path for the downloads folder. - Defaults to `/chromium`, where `` is Puppeteer's cache - directory. -- `PUPPETEER_BROWSER_REVISION` - specifies a certain version of the browser - you'd like Puppeteer to use. See - [`puppeteer.launch`](https://pptr.dev/api/puppeteer.puppeteernode.launch) on - how executable path is inferred. -- `PUPPETEER_EXECUTABLE_PATH` - specifies an executable path to be used in - [`puppeteer.launch`](https://pptr.dev/api/puppeteer.puppeteernode.launch). -- `PUPPETEER_PRODUCT` - specifies which browser you'd like Puppeteer to use. - Must be either `chrome` or `firefox`. This can also be used during - installation to fetch the recommended browser binary. Setting `product` - programmatically in - [`puppeteer.launch`](https://pptr.dev/api/puppeteer.puppeteernode.launch) - supersedes this environment variable. -- `PUPPETEER_EXPERIMENTAL_CHROMIUM_MAC_ARM` — specify Puppeteer download - Chromium for Apple M1. On Apple M1 devices Puppeteer by default downloads the - version for Intel's processor which runs via Rosetta. It works without any - problems, however, with this option, you should get more efficient resource - usage (CPU and RAM) that could lead to a faster execution time. - -Environment variables except for `PUPPETEER_CACHE_DIR` are not used for -[`puppeteer-core`](#puppeteer-core) since core does not automatically handle -browser downloading. +#### Configuring Puppeteer + +Puppeteer uses several defaults that can be customized through configuration +files. + +For example, to change the default cache directory Puppeteer uses to install +browsers, you can add a `.puppeteerrc.cjs` (or `puppeteer.config.cjs`) at the +root of your application with the contents + +```js +const {join} = require('path'); + +/** + * @type {import("puppeteer").Configuration} + */ +module.exports = { + // Changes the cache location for Puppeteer. + cacheDirectory: join(__dirname, '.cache', 'puppeteer'), +}; +``` + +After adding the configuration file, you will need to remove and reinstall +`puppeteer` for it to take effect. + +See [Configuring +Puppeteer](https://pptr.dev/guides/configuring-puppeteer) for more information. #### `puppeteer-core` @@ -104,21 +85,21 @@ Every release since v1.7.0 we publish two packages: `puppeteer` is a _product_ for browser automation. When installed, it downloads a version of Chromium, which it then drives using `puppeteer-core`. Being an -end-user product, `puppeteer` supports a bunch of convenient `PUPPETEER_*` env -variables to tweak its behavior. +end-user product, `puppeteer` automates several workflows using reasonable defaults [that can be customized](https://pptr.dev/guides/configuring-puppeteer). `puppeteer-core` is a _library_ to help drive anything that supports DevTools -protocol. `puppeteer-core` doesn't download Chromium when installed. Being a -library, `puppeteer-core` is fully driven through its programmatic interface. - -You should only use `puppeteer-core` if you are -[connecting to a remote browser](https://pptr.dev/api/puppeteer.puppeteer.connect) -or [managing browsers yourself](https://pptr.dev/api/puppeteer.browserfetcher). -If you are managing browsers yourself, you will need to call +protocol. Being a library, `puppeteer-core` is fully driven through its +programmatic interface implying no defaults are assumed and `puppeteer-core` +will not download Chromium when installed. + +You should use `puppeteer-core` if you are [connecting to a remote +browser](https://pptr.dev/api/puppeteer.puppeteer.connect) or [managing browsers +yourself](https://pptr.dev/api/puppeteer.browserfetcher). If you are managing +browsers yourself, you will need to call [`puppeteer.launch`](https://pptr.dev/api/puppeteer.puppeteernode.launch) with -an explicit +an an explicit [`executablePath`](https://pptr.dev/api/puppeteer.launchoptions.executablepath) -or [`channel`](https://pptr.dev/api/puppeteer.launchoptions.channel). +(or [`channel`](https://pptr.dev/api/puppeteer.launchoptions.channel) if it's installed in a standard location). When using `puppeteer-core`, remember to change the import: diff --git a/docs/api/index.md b/docs/api/index.md index 724f9ffc24783..4db66c576952e 100644 --- a/docs/api/index.md +++ b/docs/api/index.md @@ -73,7 +73,7 @@ sidebar_label: API | [CDPSessionOnMessageObject](./puppeteer.cdpsessiononmessageobject.md) | | | [ClickOptions](./puppeteer.clickoptions.md) | | | [CommonEventEmitter](./puppeteer.commoneventemitter.md) | | -| [Configuration](./puppeteer.configuration.md) | | +| [Configuration](./puppeteer.configuration.md) |

Defines options to configure Puppeteer's behavior during installation and runtime.

See individual properties for more information.

| | [ConnectionCallback](./puppeteer.connectioncallback.md) | | | [ConnectionTransport](./puppeteer.connectiontransport.md) | | | [ConnectOptions](./puppeteer.connectoptions.md) | | @@ -84,6 +84,7 @@ sidebar_label: API | [CSSCoverageOptions](./puppeteer.csscoverageoptions.md) | Set of configurable options for CSS coverage. | | [CustomQueryHandler](./puppeteer.customqueryhandler.md) | | | [Device](./puppeteer.device.md) | | +| [ExperimentsConfiguration](./puppeteer.experimentsconfiguration.md) |

Defines experiment options for Puppeteer.

See individual properties for more information.

| | [FrameAddScriptTagOptions](./puppeteer.frameaddscripttagoptions.md) | | | [FrameAddStyleTagOptions](./puppeteer.frameaddstyletagoptions.md) | | | [FrameWaitForFunctionOptions](./puppeteer.framewaitforfunctionoptions.md) | | diff --git a/docs/api/puppeteer.accessibility.md b/docs/api/puppeteer.accessibility.md index ae6178dc02881..f17d1433415f3 100644 --- a/docs/api/puppeteer.accessibility.md +++ b/docs/api/puppeteer.accessibility.md @@ -6,7 +6,7 @@ sidebar_label: Accessibility The Accessibility class provides methods for inspecting Chromium's accessibility tree. The accessibility tree is used by assistive technology such as [screen readers](https://en.wikipedia.org/wiki/Screen_reader) or [switches](https://en.wikipedia.org/wiki/Switch_access). -**Signature:** +#### Signature: ```typescript export declare class Accessibility diff --git a/docs/api/puppeteer.accessibility.snapshot.md b/docs/api/puppeteer.accessibility.snapshot.md index c8f7bf5bd32ca..81ff5f691b81a 100644 --- a/docs/api/puppeteer.accessibility.snapshot.md +++ b/docs/api/puppeteer.accessibility.snapshot.md @@ -6,7 +6,7 @@ sidebar_label: Accessibility.snapshot Captures the current state of the accessibility tree. The returned object represents the root accessible node of the page. -**Signature:** +#### Signature: ```typescript class Accessibility { diff --git a/docs/api/puppeteer.actionresult.md b/docs/api/puppeteer.actionresult.md index a5d3dd2c514b4..87abb66be89ae 100644 --- a/docs/api/puppeteer.actionresult.md +++ b/docs/api/puppeteer.actionresult.md @@ -4,7 +4,7 @@ sidebar_label: ActionResult # ActionResult type -**Signature:** +#### Signature: ```typescript export declare type ActionResult = 'continue' | 'abort' | 'respond'; diff --git a/docs/api/puppeteer.awaitable.md b/docs/api/puppeteer.awaitable.md index 9f9e3222701b6..a86ee6b8ed1db 100644 --- a/docs/api/puppeteer.awaitable.md +++ b/docs/api/puppeteer.awaitable.md @@ -4,7 +4,7 @@ sidebar_label: Awaitable # Awaitable type -**Signature:** +#### Signature: ```typescript export declare type Awaitable = T | PromiseLike; diff --git a/docs/api/puppeteer.boundingbox.height.md b/docs/api/puppeteer.boundingbox.height.md index 502342954389f..86ec3fef987ce 100644 --- a/docs/api/puppeteer.boundingbox.height.md +++ b/docs/api/puppeteer.boundingbox.height.md @@ -6,7 +6,7 @@ sidebar_label: BoundingBox.height the height of the element in pixels. -**Signature:** +#### Signature: ```typescript interface BoundingBox { diff --git a/docs/api/puppeteer.boundingbox.md b/docs/api/puppeteer.boundingbox.md index 0912f5c97e762..7a3b9268f280d 100644 --- a/docs/api/puppeteer.boundingbox.md +++ b/docs/api/puppeteer.boundingbox.md @@ -4,7 +4,7 @@ sidebar_label: BoundingBox # BoundingBox interface -**Signature:** +#### Signature: ```typescript export interface BoundingBox extends Point @@ -14,7 +14,7 @@ export interface BoundingBox extends Point ## Properties -| Property | Modifiers | Type | Description | -| ------------------------------------------- | --------- | ------ | ------------------------------------ | -| [height](./puppeteer.boundingbox.height.md) | | number | the height of the element in pixels. | -| [width](./puppeteer.boundingbox.width.md) | | number | the width of the element in pixels. | +| Property | Modifiers | Type | Description | Default | +| ------------------------------------------- | --------- | ------ | ------------------------------------ | ------- | +| [height](./puppeteer.boundingbox.height.md) | | number | the height of the element in pixels. | | +| [width](./puppeteer.boundingbox.width.md) | | number | the width of the element in pixels. | | diff --git a/docs/api/puppeteer.boundingbox.width.md b/docs/api/puppeteer.boundingbox.width.md index 61411f3c95e95..b85555098ee44 100644 --- a/docs/api/puppeteer.boundingbox.width.md +++ b/docs/api/puppeteer.boundingbox.width.md @@ -6,7 +6,7 @@ sidebar_label: BoundingBox.width the width of the element in pixels. -**Signature:** +#### Signature: ```typescript interface BoundingBox { diff --git a/docs/api/puppeteer.boxmodel.border.md b/docs/api/puppeteer.boxmodel.border.md index 91ba734262740..48a5f0251dfbb 100644 --- a/docs/api/puppeteer.boxmodel.border.md +++ b/docs/api/puppeteer.boxmodel.border.md @@ -4,7 +4,7 @@ sidebar_label: BoxModel.border # BoxModel.border property -**Signature:** +#### Signature: ```typescript interface BoxModel { diff --git a/docs/api/puppeteer.boxmodel.content.md b/docs/api/puppeteer.boxmodel.content.md index b723421016639..8f670e4b407e8 100644 --- a/docs/api/puppeteer.boxmodel.content.md +++ b/docs/api/puppeteer.boxmodel.content.md @@ -4,7 +4,7 @@ sidebar_label: BoxModel.content # BoxModel.content property -**Signature:** +#### Signature: ```typescript interface BoxModel { diff --git a/docs/api/puppeteer.boxmodel.height.md b/docs/api/puppeteer.boxmodel.height.md index 8f957033d3b7b..0c85e2e51e269 100644 --- a/docs/api/puppeteer.boxmodel.height.md +++ b/docs/api/puppeteer.boxmodel.height.md @@ -4,7 +4,7 @@ sidebar_label: BoxModel.height # BoxModel.height property -**Signature:** +#### Signature: ```typescript interface BoxModel { diff --git a/docs/api/puppeteer.boxmodel.margin.md b/docs/api/puppeteer.boxmodel.margin.md index 59d3ef9391661..172937f521d4a 100644 --- a/docs/api/puppeteer.boxmodel.margin.md +++ b/docs/api/puppeteer.boxmodel.margin.md @@ -4,7 +4,7 @@ sidebar_label: BoxModel.margin # BoxModel.margin property -**Signature:** +#### Signature: ```typescript interface BoxModel { diff --git a/docs/api/puppeteer.boxmodel.md b/docs/api/puppeteer.boxmodel.md index 00c083c4fe3a3..216c6648c794f 100644 --- a/docs/api/puppeteer.boxmodel.md +++ b/docs/api/puppeteer.boxmodel.md @@ -4,7 +4,7 @@ sidebar_label: BoxModel # BoxModel interface -**Signature:** +#### Signature: ```typescript export interface BoxModel @@ -12,11 +12,11 @@ export interface BoxModel ## Properties -| Property | Modifiers | Type | Description | -| ------------------------------------------ | --------- | --------------------------------- | ----------- | -| [border](./puppeteer.boxmodel.border.md) | | [Point](./puppeteer.point.md)\[\] | | -| [content](./puppeteer.boxmodel.content.md) | | [Point](./puppeteer.point.md)\[\] | | -| [height](./puppeteer.boxmodel.height.md) | | number | | -| [margin](./puppeteer.boxmodel.margin.md) | | [Point](./puppeteer.point.md)\[\] | | -| [padding](./puppeteer.boxmodel.padding.md) | | [Point](./puppeteer.point.md)\[\] | | -| [width](./puppeteer.boxmodel.width.md) | | number | | +| Property | Modifiers | Type | Description | Default | +| ------------------------------------------ | --------- | --------------------------------- | ----------- | ------- | +| [border](./puppeteer.boxmodel.border.md) | | [Point](./puppeteer.point.md)\[\] | | | +| [content](./puppeteer.boxmodel.content.md) | | [Point](./puppeteer.point.md)\[\] | | | +| [height](./puppeteer.boxmodel.height.md) | | number | | | +| [margin](./puppeteer.boxmodel.margin.md) | | [Point](./puppeteer.point.md)\[\] | | | +| [padding](./puppeteer.boxmodel.padding.md) | | [Point](./puppeteer.point.md)\[\] | | | +| [width](./puppeteer.boxmodel.width.md) | | number | | | diff --git a/docs/api/puppeteer.boxmodel.padding.md b/docs/api/puppeteer.boxmodel.padding.md index d0c8c4d4fead9..bdb8667a42dc9 100644 --- a/docs/api/puppeteer.boxmodel.padding.md +++ b/docs/api/puppeteer.boxmodel.padding.md @@ -4,7 +4,7 @@ sidebar_label: BoxModel.padding # BoxModel.padding property -**Signature:** +#### Signature: ```typescript interface BoxModel { diff --git a/docs/api/puppeteer.boxmodel.width.md b/docs/api/puppeteer.boxmodel.width.md index 518c9fd146dd2..3dc3671093ee8 100644 --- a/docs/api/puppeteer.boxmodel.width.md +++ b/docs/api/puppeteer.boxmodel.width.md @@ -4,7 +4,7 @@ sidebar_label: BoxModel.width # BoxModel.width property -**Signature:** +#### Signature: ```typescript interface BoxModel { diff --git a/docs/api/puppeteer.browser.browsercontexts.md b/docs/api/puppeteer.browser.browsercontexts.md index 65b916c99acf1..1e81e41eb0f89 100644 --- a/docs/api/puppeteer.browser.browsercontexts.md +++ b/docs/api/puppeteer.browser.browsercontexts.md @@ -6,7 +6,7 @@ sidebar_label: Browser.browserContexts Returns an array of all open browser contexts. In a newly created browser, this will return a single instance of [BrowserContext](./puppeteer.browsercontext.md). -**Signature:** +#### Signature: ```typescript class Browser { diff --git a/docs/api/puppeteer.browser.close.md b/docs/api/puppeteer.browser.close.md index 239a6bced11ab..a087539853d4a 100644 --- a/docs/api/puppeteer.browser.close.md +++ b/docs/api/puppeteer.browser.close.md @@ -6,7 +6,7 @@ sidebar_label: Browser.close Closes Chromium and all of its pages (if any were opened). The [Browser](./puppeteer.browser.md) object itself is considered to be disposed and cannot be used anymore. -**Signature:** +#### Signature: ```typescript class Browser { diff --git a/docs/api/puppeteer.browser.createincognitobrowsercontext.md b/docs/api/puppeteer.browser.createincognitobrowsercontext.md index 45c0ada29f588..09ad2bf2a2af6 100644 --- a/docs/api/puppeteer.browser.createincognitobrowsercontext.md +++ b/docs/api/puppeteer.browser.createincognitobrowsercontext.md @@ -6,7 +6,7 @@ sidebar_label: Browser.createIncognitoBrowserContext Creates a new incognito browser context. This won't share cookies/cache with other browser contexts. -**Signature:** +#### Signature: ```typescript class Browser { diff --git a/docs/api/puppeteer.browser.defaultbrowsercontext.md b/docs/api/puppeteer.browser.defaultbrowsercontext.md index 2b18461fc3d02..ce6262fb8f068 100644 --- a/docs/api/puppeteer.browser.defaultbrowsercontext.md +++ b/docs/api/puppeteer.browser.defaultbrowsercontext.md @@ -6,7 +6,7 @@ sidebar_label: Browser.defaultBrowserContext Returns the default browser context. The default browser context cannot be closed. -**Signature:** +#### Signature: ```typescript class Browser { diff --git a/docs/api/puppeteer.browser.disconnect.md b/docs/api/puppeteer.browser.disconnect.md index 7ee1ae568f21c..35f9a5779f1a8 100644 --- a/docs/api/puppeteer.browser.disconnect.md +++ b/docs/api/puppeteer.browser.disconnect.md @@ -6,7 +6,7 @@ sidebar_label: Browser.disconnect Disconnects Puppeteer from the browser, but leaves the Chromium process running. After calling `disconnect`, the [Browser](./puppeteer.browser.md) object is considered disposed and cannot be used anymore. -**Signature:** +#### Signature: ```typescript class Browser { diff --git a/docs/api/puppeteer.browser.isconnected.md b/docs/api/puppeteer.browser.isconnected.md index cbcdee360190b..190afde7aa784 100644 --- a/docs/api/puppeteer.browser.isconnected.md +++ b/docs/api/puppeteer.browser.isconnected.md @@ -6,7 +6,7 @@ sidebar_label: Browser.isConnected Indicates that the browser is connected. -**Signature:** +#### Signature: ```typescript class Browser { diff --git a/docs/api/puppeteer.browser.md b/docs/api/puppeteer.browser.md index f56e6bc11d5aa..49635992038e9 100644 --- a/docs/api/puppeteer.browser.md +++ b/docs/api/puppeteer.browser.md @@ -6,7 +6,7 @@ sidebar_label: Browser A Browser is created when Puppeteer connects to a Chromium instance, either through [PuppeteerNode.launch()](./puppeteer.puppeteernode.launch.md) or [Puppeteer.connect()](./puppeteer.puppeteer.connect.md). -**Signature:** +#### Signature: ```typescript export declare class Browser extends EventEmitter diff --git a/docs/api/puppeteer.browser.newpage.md b/docs/api/puppeteer.browser.newpage.md index 37841600a438e..4f659e3f85161 100644 --- a/docs/api/puppeteer.browser.newpage.md +++ b/docs/api/puppeteer.browser.newpage.md @@ -6,7 +6,7 @@ sidebar_label: Browser.newPage Promise which resolves to a new [Page](./puppeteer.page.md) object. The Page is created in a default browser context. -**Signature:** +#### Signature: ```typescript class Browser { diff --git a/docs/api/puppeteer.browser.pages.md b/docs/api/puppeteer.browser.pages.md index e6c531963ec9c..3b136c48955db 100644 --- a/docs/api/puppeteer.browser.pages.md +++ b/docs/api/puppeteer.browser.pages.md @@ -6,7 +6,7 @@ sidebar_label: Browser.pages An array of all open pages inside the Browser. -**Signature:** +#### Signature: ```typescript class Browser { diff --git a/docs/api/puppeteer.browser.process.md b/docs/api/puppeteer.browser.process.md index 3bd33c695514e..27c794c7b45c7 100644 --- a/docs/api/puppeteer.browser.process.md +++ b/docs/api/puppeteer.browser.process.md @@ -6,7 +6,7 @@ sidebar_label: Browser.process The spawned browser process. Returns `null` if the browser instance was created with [Puppeteer.connect()](./puppeteer.puppeteer.connect.md). -**Signature:** +#### Signature: ```typescript class Browser { diff --git a/docs/api/puppeteer.browser.target.md b/docs/api/puppeteer.browser.target.md index b4f9477bb8b47..63d29b520b583 100644 --- a/docs/api/puppeteer.browser.target.md +++ b/docs/api/puppeteer.browser.target.md @@ -6,7 +6,7 @@ sidebar_label: Browser.target The target associated with the browser. -**Signature:** +#### Signature: ```typescript class Browser { diff --git a/docs/api/puppeteer.browser.targets.md b/docs/api/puppeteer.browser.targets.md index 522860268b367..2af3229cd8677 100644 --- a/docs/api/puppeteer.browser.targets.md +++ b/docs/api/puppeteer.browser.targets.md @@ -6,7 +6,7 @@ sidebar_label: Browser.targets All active targets inside the Browser. In case of multiple browser contexts, returns an array with all the targets in all browser contexts. -**Signature:** +#### Signature: ```typescript class Browser { diff --git a/docs/api/puppeteer.browser.useragent.md b/docs/api/puppeteer.browser.useragent.md index 1497cf4849bff..d34f16d457fb3 100644 --- a/docs/api/puppeteer.browser.useragent.md +++ b/docs/api/puppeteer.browser.useragent.md @@ -6,7 +6,7 @@ sidebar_label: Browser.userAgent The browser's original user agent. Pages can override the browser user agent with [Page.setUserAgent()](./puppeteer.page.setuseragent.md). -**Signature:** +#### Signature: ```typescript class Browser { diff --git a/docs/api/puppeteer.browser.version.md b/docs/api/puppeteer.browser.version.md index dbd489c68dd83..205732a1bbe89 100644 --- a/docs/api/puppeteer.browser.version.md +++ b/docs/api/puppeteer.browser.version.md @@ -6,7 +6,7 @@ sidebar_label: Browser.version A string representing the browser name and version. -**Signature:** +#### Signature: ```typescript class Browser { diff --git a/docs/api/puppeteer.browser.waitfortarget.md b/docs/api/puppeteer.browser.waitfortarget.md index c8708d165609e..3ed026fc7edcc 100644 --- a/docs/api/puppeteer.browser.waitfortarget.md +++ b/docs/api/puppeteer.browser.waitfortarget.md @@ -6,7 +6,7 @@ sidebar_label: Browser.waitForTarget Searches for a target in all browser contexts. -**Signature:** +#### Signature: ```typescript class Browser { diff --git a/docs/api/puppeteer.browser.wsendpoint.md b/docs/api/puppeteer.browser.wsendpoint.md index af522a6f01434..4972912dbedc5 100644 --- a/docs/api/puppeteer.browser.wsendpoint.md +++ b/docs/api/puppeteer.browser.wsendpoint.md @@ -6,7 +6,7 @@ sidebar_label: Browser.wsEndpoint The browser websocket endpoint which can be used as an argument to [Puppeteer.connect()](./puppeteer.puppeteer.connect.md). -**Signature:** +#### Signature: ```typescript class Browser { diff --git a/docs/api/puppeteer.browserconnectoptions.defaultviewport.md b/docs/api/puppeteer.browserconnectoptions.defaultviewport.md index c3ead5be18dd5..7dc348e333407 100644 --- a/docs/api/puppeteer.browserconnectoptions.defaultviewport.md +++ b/docs/api/puppeteer.browserconnectoptions.defaultviewport.md @@ -6,7 +6,7 @@ sidebar_label: BrowserConnectOptions.defaultViewport Sets the viewport for each page. -**Signature:** +#### Signature: ```typescript interface BrowserConnectOptions { diff --git a/docs/api/puppeteer.browserconnectoptions.ignorehttpserrors.md b/docs/api/puppeteer.browserconnectoptions.ignorehttpserrors.md index 7253444644017..94a875f84652d 100644 --- a/docs/api/puppeteer.browserconnectoptions.ignorehttpserrors.md +++ b/docs/api/puppeteer.browserconnectoptions.ignorehttpserrors.md @@ -6,10 +6,14 @@ sidebar_label: BrowserConnectOptions.ignoreHTTPSErrors Whether to ignore HTTPS errors during navigation. -**Signature:** +#### Signature: ```typescript interface BrowserConnectOptions { ignoreHTTPSErrors?: boolean; } ``` + +#### Default value: + +false diff --git a/docs/api/puppeteer.browserconnectoptions.md b/docs/api/puppeteer.browserconnectoptions.md index bfcacef59cf4e..132fe32715d63 100644 --- a/docs/api/puppeteer.browserconnectoptions.md +++ b/docs/api/puppeteer.browserconnectoptions.md @@ -6,7 +6,7 @@ sidebar_label: BrowserConnectOptions Generic browser options that can be passed when launching any browser or when connecting to an existing browser instance. -**Signature:** +#### Signature: ```typescript export interface BrowserConnectOptions @@ -14,9 +14,9 @@ export interface BrowserConnectOptions ## Properties -| Property | Modifiers | Type | Description | -| ---------------------------------------------------------------------------- | --------- | ----------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| [defaultViewport?](./puppeteer.browserconnectoptions.defaultviewport.md) | | [Viewport](./puppeteer.viewport.md) \| null | (Optional) Sets the viewport for each page. | -| [ignoreHTTPSErrors?](./puppeteer.browserconnectoptions.ignorehttpserrors.md) | | boolean | (Optional) Whether to ignore HTTPS errors during navigation. | -| [slowMo?](./puppeteer.browserconnectoptions.slowmo.md) | | number | (Optional) Slows down Puppeteer operations by the specified amount of milliseconds to aid debugging. | -| [targetFilter?](./puppeteer.browserconnectoptions.targetfilter.md) | | [TargetFilterCallback](./puppeteer.targetfiltercallback.md) | (Optional) Callback to decide if Puppeteer should connect to a given target or not. | +| Property | Modifiers | Type | Description | Default | +| ---------------------------------------------------------------------------- | --------- | ----------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ------- | +| [defaultViewport?](./puppeteer.browserconnectoptions.defaultviewport.md) | | [Viewport](./puppeteer.viewport.md) \| null | (Optional) Sets the viewport for each page. | | +| [ignoreHTTPSErrors?](./puppeteer.browserconnectoptions.ignorehttpserrors.md) | | boolean | (Optional) Whether to ignore HTTPS errors during navigation. | false | +| [slowMo?](./puppeteer.browserconnectoptions.slowmo.md) | | number | (Optional) Slows down Puppeteer operations by the specified amount of milliseconds to aid debugging. | | +| [targetFilter?](./puppeteer.browserconnectoptions.targetfilter.md) | | [TargetFilterCallback](./puppeteer.targetfiltercallback.md) | (Optional) Callback to decide if Puppeteer should connect to a given target or not. | | diff --git a/docs/api/puppeteer.browserconnectoptions.slowmo.md b/docs/api/puppeteer.browserconnectoptions.slowmo.md index b89d37a824429..59940148868f5 100644 --- a/docs/api/puppeteer.browserconnectoptions.slowmo.md +++ b/docs/api/puppeteer.browserconnectoptions.slowmo.md @@ -6,7 +6,7 @@ sidebar_label: BrowserConnectOptions.slowMo Slows down Puppeteer operations by the specified amount of milliseconds to aid debugging. -**Signature:** +#### Signature: ```typescript interface BrowserConnectOptions { diff --git a/docs/api/puppeteer.browserconnectoptions.targetfilter.md b/docs/api/puppeteer.browserconnectoptions.targetfilter.md index b3b16e0b21dfe..14c4ea4e559c2 100644 --- a/docs/api/puppeteer.browserconnectoptions.targetfilter.md +++ b/docs/api/puppeteer.browserconnectoptions.targetfilter.md @@ -6,7 +6,7 @@ sidebar_label: BrowserConnectOptions.targetFilter Callback to decide if Puppeteer should connect to a given target or not. -**Signature:** +#### Signature: ```typescript interface BrowserConnectOptions { diff --git a/docs/api/puppeteer.browsercontext.browser.md b/docs/api/puppeteer.browsercontext.browser.md index 1a33d29accfdd..57d3f79516e7d 100644 --- a/docs/api/puppeteer.browsercontext.browser.md +++ b/docs/api/puppeteer.browsercontext.browser.md @@ -6,7 +6,7 @@ sidebar_label: BrowserContext.browser The browser this browser context belongs to. -**Signature:** +#### Signature: ```typescript class BrowserContext { diff --git a/docs/api/puppeteer.browsercontext.clearpermissionoverrides.md b/docs/api/puppeteer.browsercontext.clearpermissionoverrides.md index d1627f08010ff..9be59d2d1c3f0 100644 --- a/docs/api/puppeteer.browsercontext.clearpermissionoverrides.md +++ b/docs/api/puppeteer.browsercontext.clearpermissionoverrides.md @@ -6,7 +6,7 @@ sidebar_label: BrowserContext.clearPermissionOverrides Clears all permission overrides for the browser context. -**Signature:** +#### Signature: ```typescript class BrowserContext { diff --git a/docs/api/puppeteer.browsercontext.close.md b/docs/api/puppeteer.browsercontext.close.md index f6fc7ec9f62de..a96cc58792865 100644 --- a/docs/api/puppeteer.browsercontext.close.md +++ b/docs/api/puppeteer.browsercontext.close.md @@ -6,7 +6,7 @@ sidebar_label: BrowserContext.close Closes the browser context. All the targets that belong to the browser context will be closed. -**Signature:** +#### Signature: ```typescript class BrowserContext { diff --git a/docs/api/puppeteer.browsercontext.id.md b/docs/api/puppeteer.browsercontext.id.md index 852039c20426d..9c095cc05842d 100644 --- a/docs/api/puppeteer.browsercontext.id.md +++ b/docs/api/puppeteer.browsercontext.id.md @@ -4,7 +4,7 @@ sidebar_label: BrowserContext.id # BrowserContext.id property -**Signature:** +#### Signature: ```typescript class BrowserContext { diff --git a/docs/api/puppeteer.browsercontext.isincognito.md b/docs/api/puppeteer.browsercontext.isincognito.md index 259925f01a7f8..38b7f39dd9eb0 100644 --- a/docs/api/puppeteer.browsercontext.isincognito.md +++ b/docs/api/puppeteer.browsercontext.isincognito.md @@ -6,7 +6,7 @@ sidebar_label: BrowserContext.isIncognito Returns whether BrowserContext is incognito. The default browser context is the only non-incognito browser context. -**Signature:** +#### Signature: ```typescript class BrowserContext { diff --git a/docs/api/puppeteer.browsercontext.md b/docs/api/puppeteer.browsercontext.md index 995948371cd91..51d3d60049b02 100644 --- a/docs/api/puppeteer.browsercontext.md +++ b/docs/api/puppeteer.browsercontext.md @@ -6,7 +6,7 @@ sidebar_label: BrowserContext BrowserContexts provide a way to operate multiple independent browser sessions. When a browser is launched, it has a single BrowserContext used by default. The method [Browser.newPage](./puppeteer.browser.newpage.md) creates a page in the default browser context. -**Signature:** +#### Signature: ```typescript export declare class BrowserContext extends EventEmitter diff --git a/docs/api/puppeteer.browsercontext.newpage.md b/docs/api/puppeteer.browsercontext.newpage.md index a32b8f3baa811..83c1da98fbd65 100644 --- a/docs/api/puppeteer.browsercontext.newpage.md +++ b/docs/api/puppeteer.browsercontext.newpage.md @@ -6,7 +6,7 @@ sidebar_label: BrowserContext.newPage Creates a new page in the browser context. -**Signature:** +#### Signature: ```typescript class BrowserContext { diff --git a/docs/api/puppeteer.browsercontext.overridepermissions.md b/docs/api/puppeteer.browsercontext.overridepermissions.md index 3baa631e83a3c..caf2a47b66067 100644 --- a/docs/api/puppeteer.browsercontext.overridepermissions.md +++ b/docs/api/puppeteer.browsercontext.overridepermissions.md @@ -4,7 +4,7 @@ sidebar_label: BrowserContext.overridePermissions # BrowserContext.overridePermissions() method -**Signature:** +#### Signature: ```typescript class BrowserContext { diff --git a/docs/api/puppeteer.browsercontext.pages.md b/docs/api/puppeteer.browsercontext.pages.md index 02b0b3f530d64..604050d72c7b9 100644 --- a/docs/api/puppeteer.browsercontext.pages.md +++ b/docs/api/puppeteer.browsercontext.pages.md @@ -6,7 +6,7 @@ sidebar_label: BrowserContext.pages An array of all pages inside the browser context. -**Signature:** +#### Signature: ```typescript class BrowserContext { diff --git a/docs/api/puppeteer.browsercontext.targets.md b/docs/api/puppeteer.browsercontext.targets.md index 563b28b44150e..0c3182eb29311 100644 --- a/docs/api/puppeteer.browsercontext.targets.md +++ b/docs/api/puppeteer.browsercontext.targets.md @@ -6,7 +6,7 @@ sidebar_label: BrowserContext.targets An array of all active targets inside the browser context. -**Signature:** +#### Signature: ```typescript class BrowserContext { diff --git a/docs/api/puppeteer.browsercontext.waitfortarget.md b/docs/api/puppeteer.browsercontext.waitfortarget.md index 0f07854c385b4..4ef830f63bd75 100644 --- a/docs/api/puppeteer.browsercontext.waitfortarget.md +++ b/docs/api/puppeteer.browsercontext.waitfortarget.md @@ -6,7 +6,7 @@ sidebar_label: BrowserContext.waitForTarget This searches for a target in this specific browser context. -**Signature:** +#### Signature: ```typescript class BrowserContext { diff --git a/docs/api/puppeteer.browsercontextemittedevents.md b/docs/api/puppeteer.browsercontextemittedevents.md index 045f69b8474e4..c395fd3f84ead 100644 --- a/docs/api/puppeteer.browsercontextemittedevents.md +++ b/docs/api/puppeteer.browsercontextemittedevents.md @@ -4,7 +4,7 @@ sidebar_label: BrowserContextEmittedEvents # BrowserContextEmittedEvents enum -**Signature:** +#### Signature: ```typescript export declare const enum BrowserContextEmittedEvents diff --git a/docs/api/puppeteer.browsercontextoptions.md b/docs/api/puppeteer.browsercontextoptions.md index 0dce2f259d593..777d571442456 100644 --- a/docs/api/puppeteer.browsercontextoptions.md +++ b/docs/api/puppeteer.browsercontextoptions.md @@ -6,7 +6,7 @@ sidebar_label: BrowserContextOptions BrowserContext options. -**Signature:** +#### Signature: ```typescript export interface BrowserContextOptions @@ -14,7 +14,7 @@ export interface BrowserContextOptions ## Properties -| Property | Modifiers | Type | Description | -| ------------------------------------------------------------------------ | --------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | -| [proxyBypassList?](./puppeteer.browsercontextoptions.proxybypasslist.md) | | string\[\] | (Optional) Bypass the proxy for the given list of hosts. | -| [proxyServer?](./puppeteer.browsercontextoptions.proxyserver.md) | | string | (Optional) Proxy server with optional port to use for all requests. Username and password can be set in Page.authenticate. | +| Property | Modifiers | Type | Description | Default | +| ------------------------------------------------------------------------ | --------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ------- | +| [proxyBypassList?](./puppeteer.browsercontextoptions.proxybypasslist.md) | | string\[\] | (Optional) Bypass the proxy for the given list of hosts. | | +| [proxyServer?](./puppeteer.browsercontextoptions.proxyserver.md) | | string | (Optional) Proxy server with optional port to use for all requests. Username and password can be set in Page.authenticate. | | diff --git a/docs/api/puppeteer.browsercontextoptions.proxybypasslist.md b/docs/api/puppeteer.browsercontextoptions.proxybypasslist.md index 46262d0c9dd9c..54ec8d2a62232 100644 --- a/docs/api/puppeteer.browsercontextoptions.proxybypasslist.md +++ b/docs/api/puppeteer.browsercontextoptions.proxybypasslist.md @@ -6,7 +6,7 @@ sidebar_label: BrowserContextOptions.proxyBypassList Bypass the proxy for the given list of hosts. -**Signature:** +#### Signature: ```typescript interface BrowserContextOptions { diff --git a/docs/api/puppeteer.browsercontextoptions.proxyserver.md b/docs/api/puppeteer.browsercontextoptions.proxyserver.md index 4ae31585a4981..5c90d0059c196 100644 --- a/docs/api/puppeteer.browsercontextoptions.proxyserver.md +++ b/docs/api/puppeteer.browsercontextoptions.proxyserver.md @@ -6,7 +6,7 @@ sidebar_label: BrowserContextOptions.proxyServer Proxy server with optional port to use for all requests. Username and password can be set in `Page.authenticate`. -**Signature:** +#### Signature: ```typescript interface BrowserContextOptions { diff --git a/docs/api/puppeteer.browseremittedevents.md b/docs/api/puppeteer.browseremittedevents.md index 255ecc9967f93..8d567a6f68634 100644 --- a/docs/api/puppeteer.browseremittedevents.md +++ b/docs/api/puppeteer.browseremittedevents.md @@ -6,7 +6,7 @@ sidebar_label: BrowserEmittedEvents All the events a [browser instance](./puppeteer.browser.md) may emit. -**Signature:** +#### Signature: ```typescript export declare const enum BrowserEmittedEvents diff --git a/docs/api/puppeteer.browserfetcher._constructor_.md b/docs/api/puppeteer.browserfetcher._constructor_.md index 833a365a490e1..600a5831e7e05 100644 --- a/docs/api/puppeteer.browserfetcher._constructor_.md +++ b/docs/api/puppeteer.browserfetcher._constructor_.md @@ -6,7 +6,7 @@ sidebar_label: BrowserFetcher.(constructor) Constructs a browser fetcher for the given options. -**Signature:** +#### Signature: ```typescript class BrowserFetcher { diff --git a/docs/api/puppeteer.browserfetcher.candownload.md b/docs/api/puppeteer.browserfetcher.candownload.md index 172092d66292b..33422c7dadda5 100644 --- a/docs/api/puppeteer.browserfetcher.candownload.md +++ b/docs/api/puppeteer.browserfetcher.candownload.md @@ -6,7 +6,7 @@ sidebar_label: BrowserFetcher.canDownload Initiates a HEAD request to check if the revision is available. -**Signature:** +#### Signature: ```typescript class BrowserFetcher { diff --git a/docs/api/puppeteer.browserfetcher.download.md b/docs/api/puppeteer.browserfetcher.download.md index 950f10f3ce1ae..c792c10bb96a2 100644 --- a/docs/api/puppeteer.browserfetcher.download.md +++ b/docs/api/puppeteer.browserfetcher.download.md @@ -6,7 +6,7 @@ sidebar_label: BrowserFetcher.download Initiates a GET request to download the revision from the host. -**Signature:** +#### Signature: ```typescript class BrowserFetcher { diff --git a/docs/api/puppeteer.browserfetcher.host.md b/docs/api/puppeteer.browserfetcher.host.md index c866ea62abe28..0ecfeaf7c18eb 100644 --- a/docs/api/puppeteer.browserfetcher.host.md +++ b/docs/api/puppeteer.browserfetcher.host.md @@ -4,7 +4,7 @@ sidebar_label: BrowserFetcher.host # BrowserFetcher.host() method -**Signature:** +#### Signature: ```typescript class BrowserFetcher { diff --git a/docs/api/puppeteer.browserfetcher.localrevisions.md b/docs/api/puppeteer.browserfetcher.localrevisions.md index f8ddd72f39ac0..a2a3908726501 100644 --- a/docs/api/puppeteer.browserfetcher.localrevisions.md +++ b/docs/api/puppeteer.browserfetcher.localrevisions.md @@ -4,7 +4,7 @@ sidebar_label: BrowserFetcher.localRevisions # BrowserFetcher.localRevisions() method -**Signature:** +#### Signature: ```typescript class BrowserFetcher { diff --git a/docs/api/puppeteer.browserfetcher.md b/docs/api/puppeteer.browserfetcher.md index 685637ee7ff30..41441849784fc 100644 --- a/docs/api/puppeteer.browserfetcher.md +++ b/docs/api/puppeteer.browserfetcher.md @@ -6,7 +6,7 @@ sidebar_label: BrowserFetcher BrowserFetcher can download and manage different versions of Chromium and Firefox. -**Signature:** +#### Signature: ```typescript export declare class BrowserFetcher diff --git a/docs/api/puppeteer.browserfetcher.platform.md b/docs/api/puppeteer.browserfetcher.platform.md index f4db9721b73f7..9f3d8f74724fa 100644 --- a/docs/api/puppeteer.browserfetcher.platform.md +++ b/docs/api/puppeteer.browserfetcher.platform.md @@ -4,7 +4,7 @@ sidebar_label: BrowserFetcher.platform # BrowserFetcher.platform() method -**Signature:** +#### Signature: ```typescript class BrowserFetcher { diff --git a/docs/api/puppeteer.browserfetcher.product.md b/docs/api/puppeteer.browserfetcher.product.md index 1219cd0e5b9b5..512f603461b2a 100644 --- a/docs/api/puppeteer.browserfetcher.product.md +++ b/docs/api/puppeteer.browserfetcher.product.md @@ -4,7 +4,7 @@ sidebar_label: BrowserFetcher.product # BrowserFetcher.product() method -**Signature:** +#### Signature: ```typescript class BrowserFetcher { diff --git a/docs/api/puppeteer.browserfetcher.remove.md b/docs/api/puppeteer.browserfetcher.remove.md index 6cb2b3bf3bd92..72a6b86e77885 100644 --- a/docs/api/puppeteer.browserfetcher.remove.md +++ b/docs/api/puppeteer.browserfetcher.remove.md @@ -4,7 +4,7 @@ sidebar_label: BrowserFetcher.remove # BrowserFetcher.remove() method -**Signature:** +#### Signature: ```typescript class BrowserFetcher { diff --git a/docs/api/puppeteer.browserfetcher.revisioninfo.md b/docs/api/puppeteer.browserfetcher.revisioninfo.md index ea18abd4a43c4..0e3ef69869373 100644 --- a/docs/api/puppeteer.browserfetcher.revisioninfo.md +++ b/docs/api/puppeteer.browserfetcher.revisioninfo.md @@ -4,7 +4,7 @@ sidebar_label: BrowserFetcher.revisionInfo # BrowserFetcher.revisionInfo() method -**Signature:** +#### Signature: ```typescript class BrowserFetcher { diff --git a/docs/api/puppeteer.browserfetcheroptions.host.md b/docs/api/puppeteer.browserfetcheroptions.host.md index fee99ed34a7bd..df491b7caddeb 100644 --- a/docs/api/puppeteer.browserfetcheroptions.host.md +++ b/docs/api/puppeteer.browserfetcheroptions.host.md @@ -6,10 +6,16 @@ sidebar_label: BrowserFetcherOptions.host Determines the host that will be used for downloading. -**Signature:** +#### Signature: ```typescript interface BrowserFetcherOptions { host?: string; } ``` + +#### Default value: + +Either + +- https://storage.googleapis.com or - https://archive.mozilla.org/pub/firefox/nightly/latest-mozilla-central diff --git a/docs/api/puppeteer.browserfetcheroptions.md b/docs/api/puppeteer.browserfetcheroptions.md index aac9f900cda8a..e7a6ace11b137 100644 --- a/docs/api/puppeteer.browserfetcheroptions.md +++ b/docs/api/puppeteer.browserfetcheroptions.md @@ -4,7 +4,7 @@ sidebar_label: BrowserFetcherOptions # BrowserFetcherOptions interface -**Signature:** +#### Signature: ```typescript export interface BrowserFetcherOptions @@ -12,10 +12,10 @@ export interface BrowserFetcherOptions ## Properties -| Property | Modifiers | Type | Description | -| ---------------------------------------------------------------------------- | --------- | ----------------------------------- | ------------------------------------------------------------------------------------------------------ | -| [host?](./puppeteer.browserfetcheroptions.host.md) | | string | (Optional) Determines the host that will be used for downloading. | -| [path](./puppeteer.browserfetcheroptions.path.md) | | string | Determines the path to download browsers to. | -| [platform?](./puppeteer.browserfetcheroptions.platform.md) | | [Platform](./puppeteer.platform.md) | (Optional) Determines which platform the browser will be suited for. | -| [product?](./puppeteer.browserfetcheroptions.product.md) | | 'chrome' \| 'firefox' | (Optional) Determines which product the [BrowserFetcher](./puppeteer.browserfetcher.md) is for. | -| [useMacOSARMBinary?](./puppeteer.browserfetcheroptions.usemacosarmbinary.md) | | boolean | (Optional) Enables the use of the Chromium binary for macOS ARM. | +| Property | Modifiers | Type | Description | Default | +| ---------------------------------------------------------------------------- | --------- | ----------------------------------- | ------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------- | +| [host?](./puppeteer.browserfetcheroptions.host.md) | | string | (Optional) Determines the host that will be used for downloading. |

Either

- https://storage.googleapis.com or - https://archive.mozilla.org/pub/firefox/nightly/latest-mozilla-central

| +| [path](./puppeteer.browserfetcheroptions.path.md) | | string | Determines the path to download browsers to. | | +| [platform?](./puppeteer.browserfetcheroptions.platform.md) | | [Platform](./puppeteer.platform.md) | (Optional) Determines which platform the browser will be suited for. | Auto-detected. | +| [product?](./puppeteer.browserfetcheroptions.product.md) | | 'chrome' \| 'firefox' | (Optional) Determines which product the [BrowserFetcher](./puppeteer.browserfetcher.md) is for. | "chrome". | +| [useMacOSARMBinary?](./puppeteer.browserfetcheroptions.usemacosarmbinary.md) | | boolean | (Optional) Enables the use of the Chromium binary for macOS ARM. | | diff --git a/docs/api/puppeteer.browserfetcheroptions.path.md b/docs/api/puppeteer.browserfetcheroptions.path.md index e67cd6aceda10..80f0297a4da39 100644 --- a/docs/api/puppeteer.browserfetcheroptions.path.md +++ b/docs/api/puppeteer.browserfetcheroptions.path.md @@ -6,7 +6,7 @@ sidebar_label: BrowserFetcherOptions.path Determines the path to download browsers to. -**Signature:** +#### Signature: ```typescript interface BrowserFetcherOptions { diff --git a/docs/api/puppeteer.browserfetcheroptions.platform.md b/docs/api/puppeteer.browserfetcheroptions.platform.md index 5a130ecd3e240..118785d3cc26c 100644 --- a/docs/api/puppeteer.browserfetcheroptions.platform.md +++ b/docs/api/puppeteer.browserfetcheroptions.platform.md @@ -6,10 +6,14 @@ sidebar_label: BrowserFetcherOptions.platform Determines which platform the browser will be suited for. -**Signature:** +#### Signature: ```typescript interface BrowserFetcherOptions { platform?: Platform; } ``` + +#### Default value: + +Auto-detected. diff --git a/docs/api/puppeteer.browserfetcheroptions.product.md b/docs/api/puppeteer.browserfetcheroptions.product.md index 10d0601200be0..c2920ab2422e3 100644 --- a/docs/api/puppeteer.browserfetcheroptions.product.md +++ b/docs/api/puppeteer.browserfetcheroptions.product.md @@ -6,10 +6,14 @@ sidebar_label: BrowserFetcherOptions.product Determines which product the [BrowserFetcher](./puppeteer.browserfetcher.md) is for. -**Signature:** +#### Signature: ```typescript interface BrowserFetcherOptions { product?: 'chrome' | 'firefox'; } ``` + +#### Default value: + +`"chrome"`. diff --git a/docs/api/puppeteer.browserfetcheroptions.usemacosarmbinary.md b/docs/api/puppeteer.browserfetcheroptions.usemacosarmbinary.md index 87ae5ef11a3e0..9bd7e34f1fcf2 100644 --- a/docs/api/puppeteer.browserfetcheroptions.usemacosarmbinary.md +++ b/docs/api/puppeteer.browserfetcheroptions.usemacosarmbinary.md @@ -6,7 +6,7 @@ sidebar_label: BrowserFetcherOptions.useMacOSARMBinary Enables the use of the Chromium binary for macOS ARM. -**Signature:** +#### Signature: ```typescript interface BrowserFetcherOptions { diff --git a/docs/api/puppeteer.browserfetcherrevisioninfo.executablepath.md b/docs/api/puppeteer.browserfetcherrevisioninfo.executablepath.md index 2dd3218e71816..51975869acea1 100644 --- a/docs/api/puppeteer.browserfetcherrevisioninfo.executablepath.md +++ b/docs/api/puppeteer.browserfetcherrevisioninfo.executablepath.md @@ -4,7 +4,7 @@ sidebar_label: BrowserFetcherRevisionInfo.executablePath # BrowserFetcherRevisionInfo.executablePath property -**Signature:** +#### Signature: ```typescript interface BrowserFetcherRevisionInfo { diff --git a/docs/api/puppeteer.browserfetcherrevisioninfo.folderpath.md b/docs/api/puppeteer.browserfetcherrevisioninfo.folderpath.md index afaa567cc444f..7bf3266b57641 100644 --- a/docs/api/puppeteer.browserfetcherrevisioninfo.folderpath.md +++ b/docs/api/puppeteer.browserfetcherrevisioninfo.folderpath.md @@ -4,7 +4,7 @@ sidebar_label: BrowserFetcherRevisionInfo.folderPath # BrowserFetcherRevisionInfo.folderPath property -**Signature:** +#### Signature: ```typescript interface BrowserFetcherRevisionInfo { diff --git a/docs/api/puppeteer.browserfetcherrevisioninfo.local.md b/docs/api/puppeteer.browserfetcherrevisioninfo.local.md index 78aebaefb2138..b62b4f5107321 100644 --- a/docs/api/puppeteer.browserfetcherrevisioninfo.local.md +++ b/docs/api/puppeteer.browserfetcherrevisioninfo.local.md @@ -4,7 +4,7 @@ sidebar_label: BrowserFetcherRevisionInfo.local # BrowserFetcherRevisionInfo.local property -**Signature:** +#### Signature: ```typescript interface BrowserFetcherRevisionInfo { diff --git a/docs/api/puppeteer.browserfetcherrevisioninfo.md b/docs/api/puppeteer.browserfetcherrevisioninfo.md index feb82cc965fa4..1eb8d4ea71125 100644 --- a/docs/api/puppeteer.browserfetcherrevisioninfo.md +++ b/docs/api/puppeteer.browserfetcherrevisioninfo.md @@ -4,7 +4,7 @@ sidebar_label: BrowserFetcherRevisionInfo # BrowserFetcherRevisionInfo interface -**Signature:** +#### Signature: ```typescript export interface BrowserFetcherRevisionInfo @@ -12,11 +12,11 @@ export interface BrowserFetcherRevisionInfo ## Properties -| Property | Modifiers | Type | Description | -| -------------------------------------------------------------------------- | --------- | ------- | ----------- | -| [executablePath](./puppeteer.browserfetcherrevisioninfo.executablepath.md) | | string | | -| [folderPath](./puppeteer.browserfetcherrevisioninfo.folderpath.md) | | string | | -| [local](./puppeteer.browserfetcherrevisioninfo.local.md) | | boolean | | -| [product](./puppeteer.browserfetcherrevisioninfo.product.md) | | string | | -| [revision](./puppeteer.browserfetcherrevisioninfo.revision.md) | | string | | -| [url](./puppeteer.browserfetcherrevisioninfo.url.md) | | string | | +| Property | Modifiers | Type | Description | Default | +| -------------------------------------------------------------------------- | --------- | ------- | ----------- | ------- | +| [executablePath](./puppeteer.browserfetcherrevisioninfo.executablepath.md) | | string | | | +| [folderPath](./puppeteer.browserfetcherrevisioninfo.folderpath.md) | | string | | | +| [local](./puppeteer.browserfetcherrevisioninfo.local.md) | | boolean | | | +| [product](./puppeteer.browserfetcherrevisioninfo.product.md) | | string | | | +| [revision](./puppeteer.browserfetcherrevisioninfo.revision.md) | | string | | | +| [url](./puppeteer.browserfetcherrevisioninfo.url.md) | | string | | | diff --git a/docs/api/puppeteer.browserfetcherrevisioninfo.product.md b/docs/api/puppeteer.browserfetcherrevisioninfo.product.md index d7a0952c1bd7b..62f778cbaa776 100644 --- a/docs/api/puppeteer.browserfetcherrevisioninfo.product.md +++ b/docs/api/puppeteer.browserfetcherrevisioninfo.product.md @@ -4,7 +4,7 @@ sidebar_label: BrowserFetcherRevisionInfo.product # BrowserFetcherRevisionInfo.product property -**Signature:** +#### Signature: ```typescript interface BrowserFetcherRevisionInfo { diff --git a/docs/api/puppeteer.browserfetcherrevisioninfo.revision.md b/docs/api/puppeteer.browserfetcherrevisioninfo.revision.md index c9a6239011eee..1577c8cd8c959 100644 --- a/docs/api/puppeteer.browserfetcherrevisioninfo.revision.md +++ b/docs/api/puppeteer.browserfetcherrevisioninfo.revision.md @@ -4,7 +4,7 @@ sidebar_label: BrowserFetcherRevisionInfo.revision # BrowserFetcherRevisionInfo.revision property -**Signature:** +#### Signature: ```typescript interface BrowserFetcherRevisionInfo { diff --git a/docs/api/puppeteer.browserfetcherrevisioninfo.url.md b/docs/api/puppeteer.browserfetcherrevisioninfo.url.md index 308523614be33..4d221cbc89c2e 100644 --- a/docs/api/puppeteer.browserfetcherrevisioninfo.url.md +++ b/docs/api/puppeteer.browserfetcherrevisioninfo.url.md @@ -4,7 +4,7 @@ sidebar_label: BrowserFetcherRevisionInfo.url # BrowserFetcherRevisionInfo.url property -**Signature:** +#### Signature: ```typescript interface BrowserFetcherRevisionInfo { diff --git a/docs/api/puppeteer.browserlaunchargumentoptions.args.md b/docs/api/puppeteer.browserlaunchargumentoptions.args.md index a5ab226a0784d..7fded28430b30 100644 --- a/docs/api/puppeteer.browserlaunchargumentoptions.args.md +++ b/docs/api/puppeteer.browserlaunchargumentoptions.args.md @@ -6,7 +6,7 @@ sidebar_label: BrowserLaunchArgumentOptions.args Additional command line arguments to pass to the browser instance. -**Signature:** +#### Signature: ```typescript interface BrowserLaunchArgumentOptions { diff --git a/docs/api/puppeteer.browserlaunchargumentoptions.debuggingport.md b/docs/api/puppeteer.browserlaunchargumentoptions.debuggingport.md index 8cae9b31cf720..5b9affa82da66 100644 --- a/docs/api/puppeteer.browserlaunchargumentoptions.debuggingport.md +++ b/docs/api/puppeteer.browserlaunchargumentoptions.debuggingport.md @@ -4,7 +4,7 @@ sidebar_label: BrowserLaunchArgumentOptions.debuggingPort # BrowserLaunchArgumentOptions.debuggingPort property -**Signature:** +#### Signature: ```typescript interface BrowserLaunchArgumentOptions { diff --git a/docs/api/puppeteer.browserlaunchargumentoptions.devtools.md b/docs/api/puppeteer.browserlaunchargumentoptions.devtools.md index 4459ff0d65f26..eb8731c50e836 100644 --- a/docs/api/puppeteer.browserlaunchargumentoptions.devtools.md +++ b/docs/api/puppeteer.browserlaunchargumentoptions.devtools.md @@ -6,10 +6,14 @@ sidebar_label: BrowserLaunchArgumentOptions.devtools Whether to auto-open a DevTools panel for each tab. If this is set to `true`, then `headless` will be forced to `false`. -**Signature:** +#### Signature: ```typescript interface BrowserLaunchArgumentOptions { devtools?: boolean; } ``` + +#### Default value: + +`false` diff --git a/docs/api/puppeteer.browserlaunchargumentoptions.headless.md b/docs/api/puppeteer.browserlaunchargumentoptions.headless.md index 2a090d09f3b69..aebb39fd693b6 100644 --- a/docs/api/puppeteer.browserlaunchargumentoptions.headless.md +++ b/docs/api/puppeteer.browserlaunchargumentoptions.headless.md @@ -6,10 +6,14 @@ sidebar_label: BrowserLaunchArgumentOptions.headless Whether to run the browser in headless mode. -**Signature:** +#### Signature: ```typescript interface BrowserLaunchArgumentOptions { headless?: boolean | 'chrome'; } ``` + +#### Default value: + +true diff --git a/docs/api/puppeteer.browserlaunchargumentoptions.md b/docs/api/puppeteer.browserlaunchargumentoptions.md index ee56708fd58c6..38351864eab3c 100644 --- a/docs/api/puppeteer.browserlaunchargumentoptions.md +++ b/docs/api/puppeteer.browserlaunchargumentoptions.md @@ -6,7 +6,7 @@ sidebar_label: BrowserLaunchArgumentOptions Launcher options that only apply to Chrome. -**Signature:** +#### Signature: ```typescript export interface BrowserLaunchArgumentOptions @@ -14,10 +14,10 @@ export interface BrowserLaunchArgumentOptions ## Properties -| Property | Modifiers | Type | Description | -| --------------------------------------------------------------------------- | --------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [args?](./puppeteer.browserlaunchargumentoptions.args.md) | | string\[\] | (Optional) Additional command line arguments to pass to the browser instance. | -| [debuggingPort?](./puppeteer.browserlaunchargumentoptions.debuggingport.md) | | number | (Optional) | -| [devtools?](./puppeteer.browserlaunchargumentoptions.devtools.md) | | boolean | (Optional) Whether to auto-open a DevTools panel for each tab. If this is set to true, then headless will be forced to false. | -| [headless?](./puppeteer.browserlaunchargumentoptions.headless.md) | | boolean \| 'chrome' | (Optional) Whether to run the browser in headless mode. | -| [userDataDir?](./puppeteer.browserlaunchargumentoptions.userdatadir.md) | | string | (Optional) Path to a user data directory. [see the Chromium docs](https://chromium.googlesource.com/chromium/src/+/refs/heads/main/docs/user_data_dir.md) for more info. | +| Property | Modifiers | Type | Description | Default | +| --------------------------------------------------------------------------- | --------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | +| [args?](./puppeteer.browserlaunchargumentoptions.args.md) | | string\[\] | (Optional) Additional command line arguments to pass to the browser instance. | | +| [debuggingPort?](./puppeteer.browserlaunchargumentoptions.debuggingport.md) | | number | (Optional) | | +| [devtools?](./puppeteer.browserlaunchargumentoptions.devtools.md) | | boolean | (Optional) Whether to auto-open a DevTools panel for each tab. If this is set to true, then headless will be forced to false. | false | +| [headless?](./puppeteer.browserlaunchargumentoptions.headless.md) | | boolean \| 'chrome' | (Optional) Whether to run the browser in headless mode. | true | +| [userDataDir?](./puppeteer.browserlaunchargumentoptions.userdatadir.md) | | string | (Optional) Path to a user data directory. [see the Chromium docs](https://chromium.googlesource.com/chromium/src/+/refs/heads/main/docs/user_data_dir.md) for more info. | | diff --git a/docs/api/puppeteer.browserlaunchargumentoptions.userdatadir.md b/docs/api/puppeteer.browserlaunchargumentoptions.userdatadir.md index ca03991467735..a4051751cfffd 100644 --- a/docs/api/puppeteer.browserlaunchargumentoptions.userdatadir.md +++ b/docs/api/puppeteer.browserlaunchargumentoptions.userdatadir.md @@ -6,7 +6,7 @@ sidebar_label: BrowserLaunchArgumentOptions.userDataDir Path to a user data directory. [see the Chromium docs](https://chromium.googlesource.com/chromium/src/+/refs/heads/main/docs/user_data_dir.md) for more info. -**Signature:** +#### Signature: ```typescript interface BrowserLaunchArgumentOptions { diff --git a/docs/api/puppeteer.cdpsession.connection.md b/docs/api/puppeteer.cdpsession.connection.md index e05b5f6d9f972..1ad264793516d 100644 --- a/docs/api/puppeteer.cdpsession.connection.md +++ b/docs/api/puppeteer.cdpsession.connection.md @@ -4,7 +4,7 @@ sidebar_label: CDPSession.connection # CDPSession.connection() method -**Signature:** +#### Signature: ```typescript class CDPSession { diff --git a/docs/api/puppeteer.cdpsession.detach.md b/docs/api/puppeteer.cdpsession.detach.md index e153ba2e7a5b1..932410cce7f87 100644 --- a/docs/api/puppeteer.cdpsession.detach.md +++ b/docs/api/puppeteer.cdpsession.detach.md @@ -6,7 +6,7 @@ sidebar_label: CDPSession.detach Detaches the cdpSession from the target. Once detached, the cdpSession object won't emit any events and can't be used to send messages. -**Signature:** +#### Signature: ```typescript class CDPSession { diff --git a/docs/api/puppeteer.cdpsession.id.md b/docs/api/puppeteer.cdpsession.id.md index 6b28e780647bd..5268803fdd7a0 100644 --- a/docs/api/puppeteer.cdpsession.id.md +++ b/docs/api/puppeteer.cdpsession.id.md @@ -6,7 +6,7 @@ sidebar_label: CDPSession.id Returns the session's id. -**Signature:** +#### Signature: ```typescript class CDPSession { diff --git a/docs/api/puppeteer.cdpsession.md b/docs/api/puppeteer.cdpsession.md index 28e37731b0693..66d086451bb8e 100644 --- a/docs/api/puppeteer.cdpsession.md +++ b/docs/api/puppeteer.cdpsession.md @@ -6,7 +6,7 @@ sidebar_label: CDPSession The `CDPSession` instances are used to talk raw Chrome Devtools Protocol. -**Signature:** +#### Signature: ```typescript export declare class CDPSession extends EventEmitter diff --git a/docs/api/puppeteer.cdpsession.send.md b/docs/api/puppeteer.cdpsession.send.md index 5fbe00c6bf3fb..61eade7115222 100644 --- a/docs/api/puppeteer.cdpsession.send.md +++ b/docs/api/puppeteer.cdpsession.send.md @@ -4,7 +4,7 @@ sidebar_label: CDPSession.send # CDPSession.send() method -**Signature:** +#### Signature: ```typescript class CDPSession { diff --git a/docs/api/puppeteer.cdpsessiononmessageobject.error.md b/docs/api/puppeteer.cdpsessiononmessageobject.error.md index 72697d96b0535..61fbebe71529a 100644 --- a/docs/api/puppeteer.cdpsessiononmessageobject.error.md +++ b/docs/api/puppeteer.cdpsessiononmessageobject.error.md @@ -4,7 +4,7 @@ sidebar_label: CDPSessionOnMessageObject.error # CDPSessionOnMessageObject.error property -**Signature:** +#### Signature: ```typescript interface CDPSessionOnMessageObject { diff --git a/docs/api/puppeteer.cdpsessiononmessageobject.id.md b/docs/api/puppeteer.cdpsessiononmessageobject.id.md index 6b2b14aab4926..1316773713104 100644 --- a/docs/api/puppeteer.cdpsessiononmessageobject.id.md +++ b/docs/api/puppeteer.cdpsessiononmessageobject.id.md @@ -4,7 +4,7 @@ sidebar_label: CDPSessionOnMessageObject.id # CDPSessionOnMessageObject.id property -**Signature:** +#### Signature: ```typescript interface CDPSessionOnMessageObject { diff --git a/docs/api/puppeteer.cdpsessiononmessageobject.md b/docs/api/puppeteer.cdpsessiononmessageobject.md index f3ec87b03735d..be78ad89eafd7 100644 --- a/docs/api/puppeteer.cdpsessiononmessageobject.md +++ b/docs/api/puppeteer.cdpsessiononmessageobject.md @@ -4,7 +4,7 @@ sidebar_label: CDPSessionOnMessageObject # CDPSessionOnMessageObject interface -**Signature:** +#### Signature: ```typescript export interface CDPSessionOnMessageObject @@ -12,10 +12,10 @@ export interface CDPSessionOnMessageObject ## Properties -| Property | Modifiers | Type | Description | -| ---------------------------------------------------------- | --------- | --------------------------------------------- | ----------------- | -| [error](./puppeteer.cdpsessiononmessageobject.error.md) | | { message: string; data: any; code: number; } | | -| [id?](./puppeteer.cdpsessiononmessageobject.id.md) | | number | (Optional) | -| [method](./puppeteer.cdpsessiononmessageobject.method.md) | | string | | -| [params](./puppeteer.cdpsessiononmessageobject.params.md) | | Record<string, unknown> | | -| [result?](./puppeteer.cdpsessiononmessageobject.result.md) | | any | (Optional) | +| Property | Modifiers | Type | Description | Default | +| ---------------------------------------------------------- | --------- | --------------------------------------------- | ----------------- | ------- | +| [error](./puppeteer.cdpsessiononmessageobject.error.md) | | { message: string; data: any; code: number; } | | | +| [id?](./puppeteer.cdpsessiononmessageobject.id.md) | | number | (Optional) | | +| [method](./puppeteer.cdpsessiononmessageobject.method.md) | | string | | | +| [params](./puppeteer.cdpsessiononmessageobject.params.md) | | Record<string, unknown> | | | +| [result?](./puppeteer.cdpsessiononmessageobject.result.md) | | any | (Optional) | | diff --git a/docs/api/puppeteer.cdpsessiononmessageobject.method.md b/docs/api/puppeteer.cdpsessiononmessageobject.method.md index 04d9e897b7e41..f1d56bf5fc56c 100644 --- a/docs/api/puppeteer.cdpsessiononmessageobject.method.md +++ b/docs/api/puppeteer.cdpsessiononmessageobject.method.md @@ -4,7 +4,7 @@ sidebar_label: CDPSessionOnMessageObject.method # CDPSessionOnMessageObject.method property -**Signature:** +#### Signature: ```typescript interface CDPSessionOnMessageObject { diff --git a/docs/api/puppeteer.cdpsessiononmessageobject.params.md b/docs/api/puppeteer.cdpsessiononmessageobject.params.md index ab7f84bba89a2..bef12d9f19b2b 100644 --- a/docs/api/puppeteer.cdpsessiononmessageobject.params.md +++ b/docs/api/puppeteer.cdpsessiononmessageobject.params.md @@ -4,7 +4,7 @@ sidebar_label: CDPSessionOnMessageObject.params # CDPSessionOnMessageObject.params property -**Signature:** +#### Signature: ```typescript interface CDPSessionOnMessageObject { diff --git a/docs/api/puppeteer.cdpsessiononmessageobject.result.md b/docs/api/puppeteer.cdpsessiononmessageobject.result.md index 7097bdff4f201..788d726a3bb88 100644 --- a/docs/api/puppeteer.cdpsessiononmessageobject.result.md +++ b/docs/api/puppeteer.cdpsessiononmessageobject.result.md @@ -4,7 +4,7 @@ sidebar_label: CDPSessionOnMessageObject.result # CDPSessionOnMessageObject.result property -**Signature:** +#### Signature: ```typescript interface CDPSessionOnMessageObject { diff --git a/docs/api/puppeteer.chromereleasechannel.md b/docs/api/puppeteer.chromereleasechannel.md index 3021c39d49e32..e44859840f909 100644 --- a/docs/api/puppeteer.chromereleasechannel.md +++ b/docs/api/puppeteer.chromereleasechannel.md @@ -4,7 +4,7 @@ sidebar_label: ChromeReleaseChannel # ChromeReleaseChannel type -**Signature:** +#### Signature: ```typescript export declare type ChromeReleaseChannel = diff --git a/docs/api/puppeteer.clearcustomqueryhandlers.md b/docs/api/puppeteer.clearcustomqueryhandlers.md index 9c4d6c9cfb455..2d50f94d377fd 100644 --- a/docs/api/puppeteer.clearcustomqueryhandlers.md +++ b/docs/api/puppeteer.clearcustomqueryhandlers.md @@ -8,7 +8,7 @@ sidebar_label: clearCustomQueryHandlers > > Import [Puppeteer](./puppeteer.puppeteer.md) and use the static method [Puppeteer.clearCustomQueryHandlers()](./puppeteer.puppeteer.clearcustomqueryhandlers.md) -**Signature:** +#### Signature: ```typescript export declare function clearCustomQueryHandlers(): void; diff --git a/docs/api/puppeteer.clickoptions.button.md b/docs/api/puppeteer.clickoptions.button.md index 38f90a938b7a7..a68cd2af720d4 100644 --- a/docs/api/puppeteer.clickoptions.button.md +++ b/docs/api/puppeteer.clickoptions.button.md @@ -4,10 +4,14 @@ sidebar_label: ClickOptions.button # ClickOptions.button property -**Signature:** +#### Signature: ```typescript interface ClickOptions { button?: MouseButton; } ``` + +#### Default value: + +'left' diff --git a/docs/api/puppeteer.clickoptions.clickcount.md b/docs/api/puppeteer.clickoptions.clickcount.md index fd60641930b01..bb45f6b239627 100644 --- a/docs/api/puppeteer.clickoptions.clickcount.md +++ b/docs/api/puppeteer.clickoptions.clickcount.md @@ -4,10 +4,14 @@ sidebar_label: ClickOptions.clickCount # ClickOptions.clickCount property -**Signature:** +#### Signature: ```typescript interface ClickOptions { clickCount?: number; } ``` + +#### Default value: + +1 diff --git a/docs/api/puppeteer.clickoptions.delay.md b/docs/api/puppeteer.clickoptions.delay.md index cac255d8af5af..bdf371b667261 100644 --- a/docs/api/puppeteer.clickoptions.delay.md +++ b/docs/api/puppeteer.clickoptions.delay.md @@ -6,10 +6,14 @@ sidebar_label: ClickOptions.delay Time to wait between `mousedown` and `mouseup` in milliseconds. -**Signature:** +#### Signature: ```typescript interface ClickOptions { delay?: number; } ``` + +#### Default value: + +0 diff --git a/docs/api/puppeteer.clickoptions.md b/docs/api/puppeteer.clickoptions.md index 141e177adb531..3173964903663 100644 --- a/docs/api/puppeteer.clickoptions.md +++ b/docs/api/puppeteer.clickoptions.md @@ -4,7 +4,7 @@ sidebar_label: ClickOptions # ClickOptions interface -**Signature:** +#### Signature: ```typescript export interface ClickOptions @@ -12,9 +12,9 @@ export interface ClickOptions ## Properties -| Property | Modifiers | Type | Description | -| ----------------------------------------------------- | --------- | ----------------------------------------- | ------------------------------------------------------------------------------------------------------- | -| [button?](./puppeteer.clickoptions.button.md) | | [MouseButton](./puppeteer.mousebutton.md) | (Optional) | -| [clickCount?](./puppeteer.clickoptions.clickcount.md) | | number | (Optional) | -| [delay?](./puppeteer.clickoptions.delay.md) | | number | (Optional) Time to wait between mousedown and mouseup in milliseconds. | -| [offset?](./puppeteer.clickoptions.offset.md) | | [Offset](./puppeteer.offset.md) | (Optional) Offset for the clickable point relative to the top-left corner of the border box. | +| Property | Modifiers | Type | Description | Default | +| ----------------------------------------------------- | --------- | ----------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------- | +| [button?](./puppeteer.clickoptions.button.md) | | [MouseButton](./puppeteer.mousebutton.md) | (Optional) | 'left' | +| [clickCount?](./puppeteer.clickoptions.clickcount.md) | | number | (Optional) | 1 | +| [delay?](./puppeteer.clickoptions.delay.md) | | number | (Optional) Time to wait between mousedown and mouseup in milliseconds. | 0 | +| [offset?](./puppeteer.clickoptions.offset.md) | | [Offset](./puppeteer.offset.md) | (Optional) Offset for the clickable point relative to the top-left corner of the border box. | | diff --git a/docs/api/puppeteer.clickoptions.offset.md b/docs/api/puppeteer.clickoptions.offset.md index a5cddb71a8c84..8d4d36c144a1f 100644 --- a/docs/api/puppeteer.clickoptions.offset.md +++ b/docs/api/puppeteer.clickoptions.offset.md @@ -6,7 +6,7 @@ sidebar_label: ClickOptions.offset Offset for the clickable point relative to the top-left corner of the border box. -**Signature:** +#### Signature: ```typescript interface ClickOptions { diff --git a/docs/api/puppeteer.commoneventemitter.addlistener.md b/docs/api/puppeteer.commoneventemitter.addlistener.md index 021b4bf8fdcc4..e8282a856bd7d 100644 --- a/docs/api/puppeteer.commoneventemitter.addlistener.md +++ b/docs/api/puppeteer.commoneventemitter.addlistener.md @@ -4,7 +4,7 @@ sidebar_label: CommonEventEmitter.addListener # CommonEventEmitter.addListener() method -**Signature:** +#### Signature: ```typescript interface CommonEventEmitter { diff --git a/docs/api/puppeteer.commoneventemitter.emit.md b/docs/api/puppeteer.commoneventemitter.emit.md index 631d6f7fb38e2..106790a9ccf6a 100644 --- a/docs/api/puppeteer.commoneventemitter.emit.md +++ b/docs/api/puppeteer.commoneventemitter.emit.md @@ -4,7 +4,7 @@ sidebar_label: CommonEventEmitter.emit # CommonEventEmitter.emit() method -**Signature:** +#### Signature: ```typescript interface CommonEventEmitter { diff --git a/docs/api/puppeteer.commoneventemitter.listenercount.md b/docs/api/puppeteer.commoneventemitter.listenercount.md index fe4fdfccc618b..bed608482132b 100644 --- a/docs/api/puppeteer.commoneventemitter.listenercount.md +++ b/docs/api/puppeteer.commoneventemitter.listenercount.md @@ -4,7 +4,7 @@ sidebar_label: CommonEventEmitter.listenerCount # CommonEventEmitter.listenerCount() method -**Signature:** +#### Signature: ```typescript interface CommonEventEmitter { diff --git a/docs/api/puppeteer.commoneventemitter.md b/docs/api/puppeteer.commoneventemitter.md index c3b8072996bc4..1dca761438b66 100644 --- a/docs/api/puppeteer.commoneventemitter.md +++ b/docs/api/puppeteer.commoneventemitter.md @@ -4,7 +4,7 @@ sidebar_label: CommonEventEmitter # CommonEventEmitter interface -**Signature:** +#### Signature: ```typescript export interface CommonEventEmitter diff --git a/docs/api/puppeteer.commoneventemitter.off.md b/docs/api/puppeteer.commoneventemitter.off.md index f9f361563fd3a..06c667d67c926 100644 --- a/docs/api/puppeteer.commoneventemitter.off.md +++ b/docs/api/puppeteer.commoneventemitter.off.md @@ -4,7 +4,7 @@ sidebar_label: CommonEventEmitter.off # CommonEventEmitter.off() method -**Signature:** +#### Signature: ```typescript interface CommonEventEmitter { diff --git a/docs/api/puppeteer.commoneventemitter.on.md b/docs/api/puppeteer.commoneventemitter.on.md index bd2c4dff685b1..0d4609e246a64 100644 --- a/docs/api/puppeteer.commoneventemitter.on.md +++ b/docs/api/puppeteer.commoneventemitter.on.md @@ -4,7 +4,7 @@ sidebar_label: CommonEventEmitter.on # CommonEventEmitter.on() method -**Signature:** +#### Signature: ```typescript interface CommonEventEmitter { diff --git a/docs/api/puppeteer.commoneventemitter.once.md b/docs/api/puppeteer.commoneventemitter.once.md index ec8ce3bdf7f40..d159579306479 100644 --- a/docs/api/puppeteer.commoneventemitter.once.md +++ b/docs/api/puppeteer.commoneventemitter.once.md @@ -4,7 +4,7 @@ sidebar_label: CommonEventEmitter.once # CommonEventEmitter.once() method -**Signature:** +#### Signature: ```typescript interface CommonEventEmitter { diff --git a/docs/api/puppeteer.commoneventemitter.removealllisteners.md b/docs/api/puppeteer.commoneventemitter.removealllisteners.md index ae57713078cd1..4893e59fcb103 100644 --- a/docs/api/puppeteer.commoneventemitter.removealllisteners.md +++ b/docs/api/puppeteer.commoneventemitter.removealllisteners.md @@ -4,7 +4,7 @@ sidebar_label: CommonEventEmitter.removeAllListeners # CommonEventEmitter.removeAllListeners() method -**Signature:** +#### Signature: ```typescript interface CommonEventEmitter { diff --git a/docs/api/puppeteer.commoneventemitter.removelistener.md b/docs/api/puppeteer.commoneventemitter.removelistener.md index fab78044224b5..379c3ab234f84 100644 --- a/docs/api/puppeteer.commoneventemitter.removelistener.md +++ b/docs/api/puppeteer.commoneventemitter.removelistener.md @@ -4,7 +4,7 @@ sidebar_label: CommonEventEmitter.removeListener # CommonEventEmitter.removeListener() method -**Signature:** +#### Signature: ```typescript interface CommonEventEmitter { diff --git a/docs/api/puppeteer.configuration.browserrevision.md b/docs/api/puppeteer.configuration.browserrevision.md index 49b6c20c0e50c..f5aae38f12550 100644 --- a/docs/api/puppeteer.configuration.browserrevision.md +++ b/docs/api/puppeteer.configuration.browserrevision.md @@ -4,10 +4,20 @@ sidebar_label: Configuration.browserRevision # Configuration.browserRevision property -**Signature:** +Specifies a certain version of the browser you'd like Puppeteer to use. + +Can be overridden by `PUPPETEER_BROWSER_REVISION`. + +See [puppeteer.launch](./puppeteer.puppeteernode.launch.md) on how executable path is inferred. + +#### Signature: ```typescript interface Configuration { browserRevision?: string; } ``` + +#### Default value: + +A compatible-revision of the browser. diff --git a/docs/api/puppeteer.configuration.cachedirectory.md b/docs/api/puppeteer.configuration.cachedirectory.md index c7443b423653f..0d2f24614003b 100644 --- a/docs/api/puppeteer.configuration.cachedirectory.md +++ b/docs/api/puppeteer.configuration.cachedirectory.md @@ -4,10 +4,18 @@ sidebar_label: Configuration.cacheDirectory # Configuration.cacheDirectory property -**Signature:** +Defines the directory to be used by Puppeteer for caching. + +Can be overridden by `PUPPETEER_CACHE_DIR`. + +#### Signature: ```typescript interface Configuration { cacheDirectory?: string; } ``` + +#### Default value: + +`path.join(os.homedir(), '.cache', 'puppeteer')` diff --git a/docs/api/puppeteer.configuration.defaultproduct.md b/docs/api/puppeteer.configuration.defaultproduct.md index 36ffb3530238d..e4bf2c2274904 100644 --- a/docs/api/puppeteer.configuration.defaultproduct.md +++ b/docs/api/puppeteer.configuration.defaultproduct.md @@ -4,10 +4,18 @@ sidebar_label: Configuration.defaultProduct # Configuration.defaultProduct property -**Signature:** +Specifies which browser you'd like Puppeteer to use. + +Can be overridden by `PUPPETEER_PRODUCT`. + +#### Signature: ```typescript interface Configuration { defaultProduct?: Product; } ``` + +#### Default value: + +`'chrome'` diff --git a/docs/api/puppeteer.configuration.downloadhost.md b/docs/api/puppeteer.configuration.downloadhost.md index 9b8ef482d2923..9d58c5b6e0894 100644 --- a/docs/api/puppeteer.configuration.downloadhost.md +++ b/docs/api/puppeteer.configuration.downloadhost.md @@ -4,10 +4,22 @@ sidebar_label: Configuration.downloadHost # Configuration.downloadHost property -**Signature:** +Specifies the URL prefix that is used to download Chromium. + +Can be overridden by `PUPPETEER_DOWNLOAD_HOST`. + +#### Signature: ```typescript interface Configuration { downloadHost?: string; } ``` + +#### Default value: + +Either https://storage.googleapis.com or https://archive.mozilla.org/pub/firefox/nightly/latest-mozilla-central, depending on the product. + +## Remarks + +This must include the protocol and may even need a path prefix. diff --git a/docs/api/puppeteer.configuration.downloadpath.md b/docs/api/puppeteer.configuration.downloadpath.md index befa69132a531..56a69c17c9594 100644 --- a/docs/api/puppeteer.configuration.downloadpath.md +++ b/docs/api/puppeteer.configuration.downloadpath.md @@ -4,10 +4,18 @@ sidebar_label: Configuration.downloadPath # Configuration.downloadPath property -**Signature:** +Specifies the path for the downloads folder. + +Can be overridden by `PUPPETEER_DOWNLOAD_PATH`. + +#### Signature: ```typescript interface Configuration { downloadPath?: string; } ``` + +#### Default value: + +`/` where `` is Puppeteer's cache directory and `` is the name of the browser. diff --git a/docs/api/puppeteer.configuration.executablepath.md b/docs/api/puppeteer.configuration.executablepath.md index 8c7fe082d285e..63fcb00116079 100644 --- a/docs/api/puppeteer.configuration.executablepath.md +++ b/docs/api/puppeteer.configuration.executablepath.md @@ -4,10 +4,18 @@ sidebar_label: Configuration.executablePath # Configuration.executablePath property -**Signature:** +Specifies an executable path to be used in [puppeteer.launch](./puppeteer.puppeteernode.launch.md). + +Can be overridden by `PUPPETEER_EXECUTABLE_PATH`. + +#### Signature: ```typescript interface Configuration { executablePath?: string; } ``` + +#### Default value: + +Auto-computed. diff --git a/docs/api/puppeteer.configuration.experiments.md b/docs/api/puppeteer.configuration.experiments.md index 9f4ea2348f84e..1c0ffe8d9f52b 100644 --- a/docs/api/puppeteer.configuration.experiments.md +++ b/docs/api/puppeteer.configuration.experiments.md @@ -4,12 +4,12 @@ sidebar_label: Configuration.experiments # Configuration.experiments property -**Signature:** +Defines experimental options for Puppeteer. + +#### Signature: ```typescript interface Configuration { - experiments?: { - macArmChromiumEnabled?: boolean; - }; + experiments?: ExperimentsConfiguration; } ``` diff --git a/docs/api/puppeteer.configuration.loglevel.md b/docs/api/puppeteer.configuration.loglevel.md index c66570dadfb63..8d79bc5647aa5 100644 --- a/docs/api/puppeteer.configuration.loglevel.md +++ b/docs/api/puppeteer.configuration.loglevel.md @@ -4,10 +4,18 @@ sidebar_label: Configuration.logLevel # Configuration.logLevel property -**Signature:** +Tells Puppeteer to log at the given level. + +At the moment, any option silences logging. + +#### Signature: ```typescript interface Configuration { logLevel?: 'silent' | 'error' | 'warn'; } ``` + +#### Default value: + +`undefined` diff --git a/docs/api/puppeteer.configuration.md b/docs/api/puppeteer.configuration.md index 632baa79a8c80..45252badc06f5 100644 --- a/docs/api/puppeteer.configuration.md +++ b/docs/api/puppeteer.configuration.md @@ -4,7 +4,11 @@ sidebar_label: Configuration # Configuration interface -**Signature:** +Defines options to configure Puppeteer's behavior during installation and runtime. + +See individual properties for more information. + +#### Signature: ```typescript export interface Configuration @@ -12,15 +16,15 @@ export interface Configuration ## Properties -| Property | Modifiers | Type | Description | -| ---------------------------------------------------------------------- | --------- | ------------------------------------ | ----------------- | -| [browserRevision?](./puppeteer.configuration.browserrevision.md) | | string | (Optional) | -| [cacheDirectory?](./puppeteer.configuration.cachedirectory.md) | | string | (Optional) | -| [defaultProduct?](./puppeteer.configuration.defaultproduct.md) | | [Product](./puppeteer.product.md) | (Optional) | -| [downloadHost?](./puppeteer.configuration.downloadhost.md) | | string | (Optional) | -| [downloadPath?](./puppeteer.configuration.downloadpath.md) | | string | (Optional) | -| [executablePath?](./puppeteer.configuration.executablepath.md) | | string | (Optional) | -| [experiments?](./puppeteer.configuration.experiments.md) | | { macArmChromiumEnabled?: boolean; } | (Optional) | -| [logLevel?](./puppeteer.configuration.loglevel.md) | | 'silent' \| 'error' \| 'warn' | (Optional) | -| [skipDownload?](./puppeteer.configuration.skipdownload.md) | | boolean | (Optional) | -| [temporaryDirectory?](./puppeteer.configuration.temporarydirectory.md) | | string | (Optional) | +| Property | Modifiers | Type | Description | Default | +| ---------------------------------------------------------------------- | --------- | ------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [browserRevision?](./puppeteer.configuration.browserrevision.md) | | string |

(Optional) Specifies a certain version of the browser you'd like Puppeteer to use.

Can be overridden by PUPPETEER_BROWSER_REVISION.

See [puppeteer.launch](./puppeteer.puppeteernode.launch.md) on how executable path is inferred.

| A compatible-revision of the browser. | +| [cacheDirectory?](./puppeteer.configuration.cachedirectory.md) | | string |

(Optional) Defines the directory to be used by Puppeteer for caching.

Can be overridden by PUPPETEER_CACHE_DIR.

| path.join(os.homedir(), '.cache', 'puppeteer') | +| [defaultProduct?](./puppeteer.configuration.defaultproduct.md) | | [Product](./puppeteer.product.md) |

(Optional) Specifies which browser you'd like Puppeteer to use.

Can be overridden by PUPPETEER_PRODUCT.

| 'chrome' | +| [downloadHost?](./puppeteer.configuration.downloadhost.md) | | string |

(Optional) Specifies the URL prefix that is used to download Chromium.

Can be overridden by PUPPETEER_DOWNLOAD_HOST.

| Either https://storage.googleapis.com or https://archive.mozilla.org/pub/firefox/nightly/latest-mozilla-central, depending on the product. | +| [downloadPath?](./puppeteer.configuration.downloadpath.md) | | string |

(Optional) Specifies the path for the downloads folder.

Can be overridden by PUPPETEER_DOWNLOAD_PATH.

| <cache>/<product> where <cache> is Puppeteer's cache directory and <product> is the name of the browser. | +| [executablePath?](./puppeteer.configuration.executablepath.md) | | string |

(Optional) Specifies an executable path to be used in [puppeteer.launch](./puppeteer.puppeteernode.launch.md).

Can be overridden by PUPPETEER_EXECUTABLE_PATH.

| Auto-computed. | +| [experiments?](./puppeteer.configuration.experiments.md) | | [ExperimentsConfiguration](./puppeteer.experimentsconfiguration.md) | (Optional) Defines experimental options for Puppeteer. | | +| [logLevel?](./puppeteer.configuration.loglevel.md) | | 'silent' \| 'error' \| 'warn' |

(Optional) Tells Puppeteer to log at the given level.

At the moment, any option silences logging.

| undefined | +| [skipDownload?](./puppeteer.configuration.skipdownload.md) | | boolean |

(Optional) Tells Puppeteer to not download during installation.

Can be overridden by PUPPETEER_SKIP_DOWNLOAD.

| | +| [temporaryDirectory?](./puppeteer.configuration.temporarydirectory.md) | | string |

(Optional) Defines the directory to be used by Puppeteer for creating temporary files.

Can be overridden by PUPPETEER_TMP_DIR.

| os.tmpdir() | diff --git a/docs/api/puppeteer.configuration.skipdownload.md b/docs/api/puppeteer.configuration.skipdownload.md index d3ef56cdcfbdc..d9c4c09418b89 100644 --- a/docs/api/puppeteer.configuration.skipdownload.md +++ b/docs/api/puppeteer.configuration.skipdownload.md @@ -4,7 +4,11 @@ sidebar_label: Configuration.skipDownload # Configuration.skipDownload property -**Signature:** +Tells Puppeteer to not download during installation. + +Can be overridden by `PUPPETEER_SKIP_DOWNLOAD`. + +#### Signature: ```typescript interface Configuration { diff --git a/docs/api/puppeteer.configuration.temporarydirectory.md b/docs/api/puppeteer.configuration.temporarydirectory.md index 27c298aad9f2e..b1b130c14e6fc 100644 --- a/docs/api/puppeteer.configuration.temporarydirectory.md +++ b/docs/api/puppeteer.configuration.temporarydirectory.md @@ -4,10 +4,18 @@ sidebar_label: Configuration.temporaryDirectory # Configuration.temporaryDirectory property -**Signature:** +Defines the directory to be used by Puppeteer for creating temporary files. + +Can be overridden by `PUPPETEER_TMP_DIR`. + +#### Signature: ```typescript interface Configuration { temporaryDirectory?: string; } ``` + +#### Default value: + +`os.tmpdir()` diff --git a/docs/api/puppeteer.connect.md b/docs/api/puppeteer.connect.md index a2dad8d61cc4f..e9528d8db949b 100644 --- a/docs/api/puppeteer.connect.md +++ b/docs/api/puppeteer.connect.md @@ -4,7 +4,7 @@ sidebar_label: connect # connect variable -**Signature:** +#### Signature: ```typescript connect: ( diff --git a/docs/api/puppeteer.connection._constructor_.md b/docs/api/puppeteer.connection._constructor_.md index c2d54bf4a78ba..3994cb81f4c7a 100644 --- a/docs/api/puppeteer.connection._constructor_.md +++ b/docs/api/puppeteer.connection._constructor_.md @@ -6,7 +6,7 @@ sidebar_label: Connection.(constructor) Constructs a new instance of the `Connection` class -**Signature:** +#### Signature: ```typescript class Connection { diff --git a/docs/api/puppeteer.connection.createsession.md b/docs/api/puppeteer.connection.createsession.md index f59974a1a9162..4b54b6043de65 100644 --- a/docs/api/puppeteer.connection.createsession.md +++ b/docs/api/puppeteer.connection.createsession.md @@ -4,7 +4,7 @@ sidebar_label: Connection.createSession # Connection.createSession() method -**Signature:** +#### Signature: ```typescript class Connection { diff --git a/docs/api/puppeteer.connection.dispose.md b/docs/api/puppeteer.connection.dispose.md index 9e8759482b111..5314f7e4e94a1 100644 --- a/docs/api/puppeteer.connection.dispose.md +++ b/docs/api/puppeteer.connection.dispose.md @@ -4,7 +4,7 @@ sidebar_label: Connection.dispose # Connection.dispose() method -**Signature:** +#### Signature: ```typescript class Connection { diff --git a/docs/api/puppeteer.connection.fromsession.md b/docs/api/puppeteer.connection.fromsession.md index c69aad31d02b9..c1cb501006a2d 100644 --- a/docs/api/puppeteer.connection.fromsession.md +++ b/docs/api/puppeteer.connection.fromsession.md @@ -4,7 +4,7 @@ sidebar_label: Connection.fromSession # Connection.fromSession() method -**Signature:** +#### Signature: ```typescript class Connection { diff --git a/docs/api/puppeteer.connection.md b/docs/api/puppeteer.connection.md index 4e64fb7ad19a1..81ccbb479521c 100644 --- a/docs/api/puppeteer.connection.md +++ b/docs/api/puppeteer.connection.md @@ -4,7 +4,7 @@ sidebar_label: Connection # Connection class -**Signature:** +#### Signature: ```typescript export declare class Connection extends EventEmitter diff --git a/docs/api/puppeteer.connection.send.md b/docs/api/puppeteer.connection.send.md index 6bbfae9455a2c..a34deaf438781 100644 --- a/docs/api/puppeteer.connection.send.md +++ b/docs/api/puppeteer.connection.send.md @@ -4,7 +4,7 @@ sidebar_label: Connection.send # Connection.send() method -**Signature:** +#### Signature: ```typescript class Connection { diff --git a/docs/api/puppeteer.connection.session.md b/docs/api/puppeteer.connection.session.md index f047ca981b684..222f2b8ac81f5 100644 --- a/docs/api/puppeteer.connection.session.md +++ b/docs/api/puppeteer.connection.session.md @@ -4,7 +4,7 @@ sidebar_label: Connection.session # Connection.session() method -**Signature:** +#### Signature: ```typescript class Connection { diff --git a/docs/api/puppeteer.connection.url.md b/docs/api/puppeteer.connection.url.md index 34798c2c4448b..881215902cf37 100644 --- a/docs/api/puppeteer.connection.url.md +++ b/docs/api/puppeteer.connection.url.md @@ -4,7 +4,7 @@ sidebar_label: Connection.url # Connection.url() method -**Signature:** +#### Signature: ```typescript class Connection { diff --git a/docs/api/puppeteer.connectioncallback.error.md b/docs/api/puppeteer.connectioncallback.error.md index 584c0ca9eadf7..b14ea2cd23803 100644 --- a/docs/api/puppeteer.connectioncallback.error.md +++ b/docs/api/puppeteer.connectioncallback.error.md @@ -4,7 +4,7 @@ sidebar_label: ConnectionCallback.error # ConnectionCallback.error property -**Signature:** +#### Signature: ```typescript interface ConnectionCallback { diff --git a/docs/api/puppeteer.connectioncallback.md b/docs/api/puppeteer.connectioncallback.md index fc82eff2d744c..54d8d842cd0e5 100644 --- a/docs/api/puppeteer.connectioncallback.md +++ b/docs/api/puppeteer.connectioncallback.md @@ -4,7 +4,7 @@ sidebar_label: ConnectionCallback # ConnectionCallback interface -**Signature:** +#### Signature: ```typescript export interface ConnectionCallback @@ -12,10 +12,10 @@ export interface ConnectionCallback ## Properties -| Property | Modifiers | Type | Description | -| -------------------------------------------------- | --------- | --------------------------------------------- | ----------- | -| [error](./puppeteer.connectioncallback.error.md) | | [ProtocolError](./puppeteer.protocolerror.md) | | -| [method](./puppeteer.connectioncallback.method.md) | | string | | +| Property | Modifiers | Type | Description | Default | +| -------------------------------------------------- | --------- | --------------------------------------------- | ----------- | ------- | +| [error](./puppeteer.connectioncallback.error.md) | | [ProtocolError](./puppeteer.protocolerror.md) | | | +| [method](./puppeteer.connectioncallback.method.md) | | string | | | ## Methods diff --git a/docs/api/puppeteer.connectioncallback.method.md b/docs/api/puppeteer.connectioncallback.method.md index f30bb6095d01b..b2d3b7d80728b 100644 --- a/docs/api/puppeteer.connectioncallback.method.md +++ b/docs/api/puppeteer.connectioncallback.method.md @@ -4,7 +4,7 @@ sidebar_label: ConnectionCallback.method # ConnectionCallback.method property -**Signature:** +#### Signature: ```typescript interface ConnectionCallback { diff --git a/docs/api/puppeteer.connectioncallback.reject.md b/docs/api/puppeteer.connectioncallback.reject.md index 47a44bf4dab15..17c45c5e55909 100644 --- a/docs/api/puppeteer.connectioncallback.reject.md +++ b/docs/api/puppeteer.connectioncallback.reject.md @@ -4,7 +4,7 @@ sidebar_label: ConnectionCallback.reject # ConnectionCallback.reject() method -**Signature:** +#### Signature: ```typescript interface ConnectionCallback { diff --git a/docs/api/puppeteer.connectioncallback.resolve.md b/docs/api/puppeteer.connectioncallback.resolve.md index 07e1aee38ced8..09aa208f4b30d 100644 --- a/docs/api/puppeteer.connectioncallback.resolve.md +++ b/docs/api/puppeteer.connectioncallback.resolve.md @@ -4,7 +4,7 @@ sidebar_label: ConnectionCallback.resolve # ConnectionCallback.resolve() method -**Signature:** +#### Signature: ```typescript interface ConnectionCallback { diff --git a/docs/api/puppeteer.connectiontransport.close.md b/docs/api/puppeteer.connectiontransport.close.md index 964ee5997c519..5c25278c79179 100644 --- a/docs/api/puppeteer.connectiontransport.close.md +++ b/docs/api/puppeteer.connectiontransport.close.md @@ -4,7 +4,7 @@ sidebar_label: ConnectionTransport.close # ConnectionTransport.close() method -**Signature:** +#### Signature: ```typescript interface ConnectionTransport { diff --git a/docs/api/puppeteer.connectiontransport.md b/docs/api/puppeteer.connectiontransport.md index 761a15fbc11d9..16943b8fffe4f 100644 --- a/docs/api/puppeteer.connectiontransport.md +++ b/docs/api/puppeteer.connectiontransport.md @@ -4,7 +4,7 @@ sidebar_label: ConnectionTransport # ConnectionTransport interface -**Signature:** +#### Signature: ```typescript export interface ConnectionTransport @@ -12,10 +12,10 @@ export interface ConnectionTransport ## Properties -| Property | Modifiers | Type | Description | -| ---------------------------------------------------------- | --------- | ---------------------------- | ----------------- | -| [onclose?](./puppeteer.connectiontransport.onclose.md) | | () => void | (Optional) | -| [onmessage?](./puppeteer.connectiontransport.onmessage.md) | | (message: string) => void | (Optional) | +| Property | Modifiers | Type | Description | Default | +| ---------------------------------------------------------- | --------- | ---------------------------- | ----------------- | ------- | +| [onclose?](./puppeteer.connectiontransport.onclose.md) | | () => void | (Optional) | | +| [onmessage?](./puppeteer.connectiontransport.onmessage.md) | | (message: string) => void | (Optional) | | ## Methods diff --git a/docs/api/puppeteer.connectiontransport.onclose.md b/docs/api/puppeteer.connectiontransport.onclose.md index 1bda6671530b1..983a0efd791e1 100644 --- a/docs/api/puppeteer.connectiontransport.onclose.md +++ b/docs/api/puppeteer.connectiontransport.onclose.md @@ -4,7 +4,7 @@ sidebar_label: ConnectionTransport.onclose # ConnectionTransport.onclose property -**Signature:** +#### Signature: ```typescript interface ConnectionTransport { diff --git a/docs/api/puppeteer.connectiontransport.onmessage.md b/docs/api/puppeteer.connectiontransport.onmessage.md index c85de25d7b087..f1e075f975f41 100644 --- a/docs/api/puppeteer.connectiontransport.onmessage.md +++ b/docs/api/puppeteer.connectiontransport.onmessage.md @@ -4,7 +4,7 @@ sidebar_label: ConnectionTransport.onmessage # ConnectionTransport.onmessage property -**Signature:** +#### Signature: ```typescript interface ConnectionTransport { diff --git a/docs/api/puppeteer.connectiontransport.send.md b/docs/api/puppeteer.connectiontransport.send.md index 60ddf8fb72e6d..33e4407badec9 100644 --- a/docs/api/puppeteer.connectiontransport.send.md +++ b/docs/api/puppeteer.connectiontransport.send.md @@ -4,7 +4,7 @@ sidebar_label: ConnectionTransport.send # ConnectionTransport.send() method -**Signature:** +#### Signature: ```typescript interface ConnectionTransport { diff --git a/docs/api/puppeteer.connectoptions.browserurl.md b/docs/api/puppeteer.connectoptions.browserurl.md index 0c16cc5c67730..a5c798b205b61 100644 --- a/docs/api/puppeteer.connectoptions.browserurl.md +++ b/docs/api/puppeteer.connectoptions.browserurl.md @@ -4,7 +4,7 @@ sidebar_label: ConnectOptions.browserURL # ConnectOptions.browserURL property -**Signature:** +#### Signature: ```typescript interface ConnectOptions { diff --git a/docs/api/puppeteer.connectoptions.browserwsendpoint.md b/docs/api/puppeteer.connectoptions.browserwsendpoint.md index 80374e2f257e7..fe62e7cf85bbc 100644 --- a/docs/api/puppeteer.connectoptions.browserwsendpoint.md +++ b/docs/api/puppeteer.connectoptions.browserwsendpoint.md @@ -4,7 +4,7 @@ sidebar_label: ConnectOptions.browserWSEndpoint # ConnectOptions.browserWSEndpoint property -**Signature:** +#### Signature: ```typescript interface ConnectOptions { diff --git a/docs/api/puppeteer.connectoptions.md b/docs/api/puppeteer.connectoptions.md index fa3b691afc73f..84e5a50ec9b7d 100644 --- a/docs/api/puppeteer.connectoptions.md +++ b/docs/api/puppeteer.connectoptions.md @@ -4,7 +4,7 @@ sidebar_label: ConnectOptions # ConnectOptions interface -**Signature:** +#### Signature: ```typescript export interface ConnectOptions extends BrowserConnectOptions @@ -14,8 +14,8 @@ export interface ConnectOptions extends BrowserConnectOptions ## Properties -| Property | Modifiers | Type | Description | -| --------------------------------------------------------------------- | --------- | --------------------------------------------------------- | ----------------- | -| [browserURL?](./puppeteer.connectoptions.browserurl.md) | | string | (Optional) | -| [browserWSEndpoint?](./puppeteer.connectoptions.browserwsendpoint.md) | | string | (Optional) | -| [transport?](./puppeteer.connectoptions.transport.md) | | [ConnectionTransport](./puppeteer.connectiontransport.md) | (Optional) | +| Property | Modifiers | Type | Description | Default | +| --------------------------------------------------------------------- | --------- | --------------------------------------------------------- | ----------------- | ------- | +| [browserURL?](./puppeteer.connectoptions.browserurl.md) | | string | (Optional) | | +| [browserWSEndpoint?](./puppeteer.connectoptions.browserwsendpoint.md) | | string | (Optional) | | +| [transport?](./puppeteer.connectoptions.transport.md) | | [ConnectionTransport](./puppeteer.connectiontransport.md) | (Optional) | | diff --git a/docs/api/puppeteer.connectoptions.transport.md b/docs/api/puppeteer.connectoptions.transport.md index d3faf62883dff..d251fb8cb9500 100644 --- a/docs/api/puppeteer.connectoptions.transport.md +++ b/docs/api/puppeteer.connectoptions.transport.md @@ -4,7 +4,7 @@ sidebar_label: ConnectOptions.transport # ConnectOptions.transport property -**Signature:** +#### Signature: ```typescript interface ConnectOptions { diff --git a/docs/api/puppeteer.consolemessage._constructor_.md b/docs/api/puppeteer.consolemessage._constructor_.md index 4614d2bed50a1..6e45d0788e434 100644 --- a/docs/api/puppeteer.consolemessage._constructor_.md +++ b/docs/api/puppeteer.consolemessage._constructor_.md @@ -6,7 +6,7 @@ sidebar_label: ConsoleMessage.(constructor) Constructs a new instance of the `ConsoleMessage` class -**Signature:** +#### Signature: ```typescript class ConsoleMessage { diff --git a/docs/api/puppeteer.consolemessage.args.md b/docs/api/puppeteer.consolemessage.args.md index 20400631772c6..565fd6bc53723 100644 --- a/docs/api/puppeteer.consolemessage.args.md +++ b/docs/api/puppeteer.consolemessage.args.md @@ -4,7 +4,7 @@ sidebar_label: ConsoleMessage.args # ConsoleMessage.args() method -**Signature:** +#### Signature: ```typescript class ConsoleMessage { diff --git a/docs/api/puppeteer.consolemessage.location.md b/docs/api/puppeteer.consolemessage.location.md index 009e12bb58a55..d26c80b5e0008 100644 --- a/docs/api/puppeteer.consolemessage.location.md +++ b/docs/api/puppeteer.consolemessage.location.md @@ -4,7 +4,7 @@ sidebar_label: ConsoleMessage.location # ConsoleMessage.location() method -**Signature:** +#### Signature: ```typescript class ConsoleMessage { diff --git a/docs/api/puppeteer.consolemessage.md b/docs/api/puppeteer.consolemessage.md index b5b0818ddebcc..86ed1c0efe109 100644 --- a/docs/api/puppeteer.consolemessage.md +++ b/docs/api/puppeteer.consolemessage.md @@ -6,7 +6,7 @@ sidebar_label: ConsoleMessage ConsoleMessage objects are dispatched by page via the 'console' event. -**Signature:** +#### Signature: ```typescript export declare class ConsoleMessage diff --git a/docs/api/puppeteer.consolemessage.stacktrace.md b/docs/api/puppeteer.consolemessage.stacktrace.md index 0dbd6997130e0..f589b9aed3a9d 100644 --- a/docs/api/puppeteer.consolemessage.stacktrace.md +++ b/docs/api/puppeteer.consolemessage.stacktrace.md @@ -4,7 +4,7 @@ sidebar_label: ConsoleMessage.stackTrace # ConsoleMessage.stackTrace() method -**Signature:** +#### Signature: ```typescript class ConsoleMessage { diff --git a/docs/api/puppeteer.consolemessage.text.md b/docs/api/puppeteer.consolemessage.text.md index b757bee5e7923..4e86e4651b40d 100644 --- a/docs/api/puppeteer.consolemessage.text.md +++ b/docs/api/puppeteer.consolemessage.text.md @@ -4,7 +4,7 @@ sidebar_label: ConsoleMessage.text # ConsoleMessage.text() method -**Signature:** +#### Signature: ```typescript class ConsoleMessage { diff --git a/docs/api/puppeteer.consolemessage.type.md b/docs/api/puppeteer.consolemessage.type.md index 4e473ce7c8d57..9f0224a248b67 100644 --- a/docs/api/puppeteer.consolemessage.type.md +++ b/docs/api/puppeteer.consolemessage.type.md @@ -4,7 +4,7 @@ sidebar_label: ConsoleMessage.type # ConsoleMessage.type() method -**Signature:** +#### Signature: ```typescript class ConsoleMessage { diff --git a/docs/api/puppeteer.consolemessagelocation.columnnumber.md b/docs/api/puppeteer.consolemessagelocation.columnnumber.md index 147b26db5eed3..ebc06e2e7bf07 100644 --- a/docs/api/puppeteer.consolemessagelocation.columnnumber.md +++ b/docs/api/puppeteer.consolemessagelocation.columnnumber.md @@ -6,7 +6,7 @@ sidebar_label: ConsoleMessageLocation.columnNumber 0-based column number in the resource if known or `undefined` otherwise. -**Signature:** +#### Signature: ```typescript interface ConsoleMessageLocation { diff --git a/docs/api/puppeteer.consolemessagelocation.linenumber.md b/docs/api/puppeteer.consolemessagelocation.linenumber.md index a1a1a3d41be61..75e34b99f1bfd 100644 --- a/docs/api/puppeteer.consolemessagelocation.linenumber.md +++ b/docs/api/puppeteer.consolemessagelocation.linenumber.md @@ -6,7 +6,7 @@ sidebar_label: ConsoleMessageLocation.lineNumber 0-based line number in the resource if known or `undefined` otherwise. -**Signature:** +#### Signature: ```typescript interface ConsoleMessageLocation { diff --git a/docs/api/puppeteer.consolemessagelocation.md b/docs/api/puppeteer.consolemessagelocation.md index 15aa75d8b51c2..8ea60b8b53601 100644 --- a/docs/api/puppeteer.consolemessagelocation.md +++ b/docs/api/puppeteer.consolemessagelocation.md @@ -4,7 +4,7 @@ sidebar_label: ConsoleMessageLocation # ConsoleMessageLocation interface -**Signature:** +#### Signature: ```typescript export interface ConsoleMessageLocation @@ -12,8 +12,8 @@ export interface ConsoleMessageLocation ## Properties -| Property | Modifiers | Type | Description | -| ------------------------------------------------------------------- | --------- | ------ | ----------------------------------------------------------------------------------------------------- | -| [columnNumber?](./puppeteer.consolemessagelocation.columnnumber.md) | | number | (Optional) 0-based column number in the resource if known or undefined otherwise. | -| [lineNumber?](./puppeteer.consolemessagelocation.linenumber.md) | | number | (Optional) 0-based line number in the resource if known or undefined otherwise. | -| [url?](./puppeteer.consolemessagelocation.url.md) | | string | (Optional) URL of the resource if known or undefined otherwise. | +| Property | Modifiers | Type | Description | Default | +| ------------------------------------------------------------------- | --------- | ------ | ----------------------------------------------------------------------------------------------------- | ------- | +| [columnNumber?](./puppeteer.consolemessagelocation.columnnumber.md) | | number | (Optional) 0-based column number in the resource if known or undefined otherwise. | | +| [lineNumber?](./puppeteer.consolemessagelocation.linenumber.md) | | number | (Optional) 0-based line number in the resource if known or undefined otherwise. | | +| [url?](./puppeteer.consolemessagelocation.url.md) | | string | (Optional) URL of the resource if known or undefined otherwise. | | diff --git a/docs/api/puppeteer.consolemessagelocation.url.md b/docs/api/puppeteer.consolemessagelocation.url.md index 0e460007864b3..11cbded0f9fec 100644 --- a/docs/api/puppeteer.consolemessagelocation.url.md +++ b/docs/api/puppeteer.consolemessagelocation.url.md @@ -6,7 +6,7 @@ sidebar_label: ConsoleMessageLocation.url URL of the resource if known or `undefined` otherwise. -**Signature:** +#### Signature: ```typescript interface ConsoleMessageLocation { diff --git a/docs/api/puppeteer.consolemessagetype.md b/docs/api/puppeteer.consolemessagetype.md index 295ea8fd4748a..de67abc48f27f 100644 --- a/docs/api/puppeteer.consolemessagetype.md +++ b/docs/api/puppeteer.consolemessagetype.md @@ -6,7 +6,7 @@ sidebar_label: ConsoleMessageType The supported types for console messages. -**Signature:** +#### Signature: ```typescript export declare type ConsoleMessageType = diff --git a/docs/api/puppeteer.continuerequestoverrides.headers.md b/docs/api/puppeteer.continuerequestoverrides.headers.md index fd0816cd8c734..22b68e5e9c611 100644 --- a/docs/api/puppeteer.continuerequestoverrides.headers.md +++ b/docs/api/puppeteer.continuerequestoverrides.headers.md @@ -4,7 +4,7 @@ sidebar_label: ContinueRequestOverrides.headers # ContinueRequestOverrides.headers property -**Signature:** +#### Signature: ```typescript interface ContinueRequestOverrides { diff --git a/docs/api/puppeteer.continuerequestoverrides.md b/docs/api/puppeteer.continuerequestoverrides.md index ce2ed1b01702b..427170ee938fe 100644 --- a/docs/api/puppeteer.continuerequestoverrides.md +++ b/docs/api/puppeteer.continuerequestoverrides.md @@ -4,7 +4,7 @@ sidebar_label: ContinueRequestOverrides # ContinueRequestOverrides interface -**Signature:** +#### Signature: ```typescript export interface ContinueRequestOverrides @@ -12,9 +12,9 @@ export interface ContinueRequestOverrides ## Properties -| Property | Modifiers | Type | Description | -| ------------------------------------------------------------- | --------- | ---------------------------- | ------------------------------------------------------------------------------ | -| [headers?](./puppeteer.continuerequestoverrides.headers.md) | | Record<string, string> | (Optional) | -| [method?](./puppeteer.continuerequestoverrides.method.md) | | string | (Optional) | -| [postData?](./puppeteer.continuerequestoverrides.postdata.md) | | string | (Optional) | -| [url?](./puppeteer.continuerequestoverrides.url.md) | | string | (Optional) If set, the request URL will change. This is not a redirect. | +| Property | Modifiers | Type | Description | Default | +| ------------------------------------------------------------- | --------- | ---------------------------- | ------------------------------------------------------------------------------ | ------- | +| [headers?](./puppeteer.continuerequestoverrides.headers.md) | | Record<string, string> | (Optional) | | +| [method?](./puppeteer.continuerequestoverrides.method.md) | | string | (Optional) | | +| [postData?](./puppeteer.continuerequestoverrides.postdata.md) | | string | (Optional) | | +| [url?](./puppeteer.continuerequestoverrides.url.md) | | string | (Optional) If set, the request URL will change. This is not a redirect. | | diff --git a/docs/api/puppeteer.continuerequestoverrides.method.md b/docs/api/puppeteer.continuerequestoverrides.method.md index 10b6fa430851b..5bd9e4587f867 100644 --- a/docs/api/puppeteer.continuerequestoverrides.method.md +++ b/docs/api/puppeteer.continuerequestoverrides.method.md @@ -4,7 +4,7 @@ sidebar_label: ContinueRequestOverrides.method # ContinueRequestOverrides.method property -**Signature:** +#### Signature: ```typescript interface ContinueRequestOverrides { diff --git a/docs/api/puppeteer.continuerequestoverrides.postdata.md b/docs/api/puppeteer.continuerequestoverrides.postdata.md index bb27166a2a3cc..e4ba78338ef30 100644 --- a/docs/api/puppeteer.continuerequestoverrides.postdata.md +++ b/docs/api/puppeteer.continuerequestoverrides.postdata.md @@ -4,7 +4,7 @@ sidebar_label: ContinueRequestOverrides.postData # ContinueRequestOverrides.postData property -**Signature:** +#### Signature: ```typescript interface ContinueRequestOverrides { diff --git a/docs/api/puppeteer.continuerequestoverrides.url.md b/docs/api/puppeteer.continuerequestoverrides.url.md index b5d92a3da340f..bed6789600c8f 100644 --- a/docs/api/puppeteer.continuerequestoverrides.url.md +++ b/docs/api/puppeteer.continuerequestoverrides.url.md @@ -6,7 +6,7 @@ sidebar_label: ContinueRequestOverrides.url If set, the request URL will change. This is not a redirect. -**Signature:** +#### Signature: ```typescript interface ContinueRequestOverrides { diff --git a/docs/api/puppeteer.coverage._constructor_.md b/docs/api/puppeteer.coverage._constructor_.md index bd805209530c9..61d0a0f582807 100644 --- a/docs/api/puppeteer.coverage._constructor_.md +++ b/docs/api/puppeteer.coverage._constructor_.md @@ -6,7 +6,7 @@ sidebar_label: Coverage.(constructor) Constructs a new instance of the `Coverage` class -**Signature:** +#### Signature: ```typescript class Coverage { diff --git a/docs/api/puppeteer.coverage.md b/docs/api/puppeteer.coverage.md index 433355abca588..f0ac68faa1396 100644 --- a/docs/api/puppeteer.coverage.md +++ b/docs/api/puppeteer.coverage.md @@ -6,7 +6,7 @@ sidebar_label: Coverage The Coverage class provides methods to gathers information about parts of JavaScript and CSS that were used by the page. -**Signature:** +#### Signature: ```typescript export declare class Coverage diff --git a/docs/api/puppeteer.coverage.startcsscoverage.md b/docs/api/puppeteer.coverage.startcsscoverage.md index 5959782907424..33da927ba6ce9 100644 --- a/docs/api/puppeteer.coverage.startcsscoverage.md +++ b/docs/api/puppeteer.coverage.startcsscoverage.md @@ -4,7 +4,7 @@ sidebar_label: Coverage.startCSSCoverage # Coverage.startCSSCoverage() method -**Signature:** +#### Signature: ```typescript class Coverage { diff --git a/docs/api/puppeteer.coverage.startjscoverage.md b/docs/api/puppeteer.coverage.startjscoverage.md index b6ceb758ed46a..1a27c8e88b3f7 100644 --- a/docs/api/puppeteer.coverage.startjscoverage.md +++ b/docs/api/puppeteer.coverage.startjscoverage.md @@ -4,7 +4,7 @@ sidebar_label: Coverage.startJSCoverage # Coverage.startJSCoverage() method -**Signature:** +#### Signature: ```typescript class Coverage { diff --git a/docs/api/puppeteer.coverage.stopcsscoverage.md b/docs/api/puppeteer.coverage.stopcsscoverage.md index 51b1bdc4a2b2b..db43fab553b09 100644 --- a/docs/api/puppeteer.coverage.stopcsscoverage.md +++ b/docs/api/puppeteer.coverage.stopcsscoverage.md @@ -4,7 +4,7 @@ sidebar_label: Coverage.stopCSSCoverage # Coverage.stopCSSCoverage() method -**Signature:** +#### Signature: ```typescript class Coverage { diff --git a/docs/api/puppeteer.coverage.stopjscoverage.md b/docs/api/puppeteer.coverage.stopjscoverage.md index 2ceeb5e112deb..996db5c5bb7fc 100644 --- a/docs/api/puppeteer.coverage.stopjscoverage.md +++ b/docs/api/puppeteer.coverage.stopjscoverage.md @@ -4,7 +4,7 @@ sidebar_label: Coverage.stopJSCoverage # Coverage.stopJSCoverage() method -**Signature:** +#### Signature: ```typescript class Coverage { diff --git a/docs/api/puppeteer.coverageentry.md b/docs/api/puppeteer.coverageentry.md index 1833f9320d2f0..72e450362cf5d 100644 --- a/docs/api/puppeteer.coverageentry.md +++ b/docs/api/puppeteer.coverageentry.md @@ -6,7 +6,7 @@ sidebar_label: CoverageEntry The CoverageEntry class represents one entry of the coverage report. -**Signature:** +#### Signature: ```typescript export interface CoverageEntry @@ -14,8 +14,8 @@ export interface CoverageEntry ## Properties -| Property | Modifiers | Type | Description | -| --------------------------------------------- | --------- | -------------------------------------------- | --------------------------------------------- | -| [ranges](./puppeteer.coverageentry.ranges.md) | | Array<{ start: number; end: number; }> | The covered range as start and end positions. | -| [text](./puppeteer.coverageentry.text.md) | | string | The content of the style sheet or script. | -| [url](./puppeteer.coverageentry.url.md) | | string | The URL of the style sheet or script. | +| Property | Modifiers | Type | Description | Default | +| --------------------------------------------- | --------- | -------------------------------------------- | --------------------------------------------- | ------- | +| [ranges](./puppeteer.coverageentry.ranges.md) | | Array<{ start: number; end: number; }> | The covered range as start and end positions. | | +| [text](./puppeteer.coverageentry.text.md) | | string | The content of the style sheet or script. | | +| [url](./puppeteer.coverageentry.url.md) | | string | The URL of the style sheet or script. | | diff --git a/docs/api/puppeteer.coverageentry.ranges.md b/docs/api/puppeteer.coverageentry.ranges.md index 18dbd743d24c0..4420c1a7349da 100644 --- a/docs/api/puppeteer.coverageentry.ranges.md +++ b/docs/api/puppeteer.coverageentry.ranges.md @@ -6,7 +6,7 @@ sidebar_label: CoverageEntry.ranges The covered range as start and end positions. -**Signature:** +#### Signature: ```typescript interface CoverageEntry { diff --git a/docs/api/puppeteer.coverageentry.text.md b/docs/api/puppeteer.coverageentry.text.md index 0fde8e6544d2f..e679e0e1daec7 100644 --- a/docs/api/puppeteer.coverageentry.text.md +++ b/docs/api/puppeteer.coverageentry.text.md @@ -6,7 +6,7 @@ sidebar_label: CoverageEntry.text The content of the style sheet or script. -**Signature:** +#### Signature: ```typescript interface CoverageEntry { diff --git a/docs/api/puppeteer.coverageentry.url.md b/docs/api/puppeteer.coverageentry.url.md index 4a2d4ed209e62..b83a21cdc89d8 100644 --- a/docs/api/puppeteer.coverageentry.url.md +++ b/docs/api/puppeteer.coverageentry.url.md @@ -6,7 +6,7 @@ sidebar_label: CoverageEntry.url The URL of the style sheet or script. -**Signature:** +#### Signature: ```typescript interface CoverageEntry { diff --git a/docs/api/puppeteer.createbrowserfetcher.md b/docs/api/puppeteer.createbrowserfetcher.md index 62b786c57d0fd..79de34721cef4 100644 --- a/docs/api/puppeteer.createbrowserfetcher.md +++ b/docs/api/puppeteer.createbrowserfetcher.md @@ -4,7 +4,7 @@ sidebar_label: createBrowserFetcher # createBrowserFetcher variable -**Signature:** +#### Signature: ```typescript createBrowserFetcher: ( diff --git a/docs/api/puppeteer.credentials.md b/docs/api/puppeteer.credentials.md index 6c579e44e75e5..d9a6e66489bbf 100644 --- a/docs/api/puppeteer.credentials.md +++ b/docs/api/puppeteer.credentials.md @@ -4,7 +4,7 @@ sidebar_label: Credentials # Credentials interface -**Signature:** +#### Signature: ```typescript export interface Credentials @@ -12,7 +12,7 @@ export interface Credentials ## Properties -| Property | Modifiers | Type | Description | -| ----------------------------------------------- | --------- | ------ | ----------- | -| [password](./puppeteer.credentials.password.md) | | string | | -| [username](./puppeteer.credentials.username.md) | | string | | +| Property | Modifiers | Type | Description | Default | +| ----------------------------------------------- | --------- | ------ | ----------- | ------- | +| [password](./puppeteer.credentials.password.md) | | string | | | +| [username](./puppeteer.credentials.username.md) | | string | | | diff --git a/docs/api/puppeteer.credentials.password.md b/docs/api/puppeteer.credentials.password.md index 6407abd94b5fd..7251de0c9714d 100644 --- a/docs/api/puppeteer.credentials.password.md +++ b/docs/api/puppeteer.credentials.password.md @@ -4,7 +4,7 @@ sidebar_label: Credentials.password # Credentials.password property -**Signature:** +#### Signature: ```typescript interface Credentials { diff --git a/docs/api/puppeteer.credentials.username.md b/docs/api/puppeteer.credentials.username.md index bbe2fa694d0b2..90b70ae130dc6 100644 --- a/docs/api/puppeteer.credentials.username.md +++ b/docs/api/puppeteer.credentials.username.md @@ -4,7 +4,7 @@ sidebar_label: Credentials.username # Credentials.username property -**Signature:** +#### Signature: ```typescript interface Credentials { diff --git a/docs/api/puppeteer.csscoverage._constructor_.md b/docs/api/puppeteer.csscoverage._constructor_.md index ef61f54ba2d97..a3f72b8b8d48c 100644 --- a/docs/api/puppeteer.csscoverage._constructor_.md +++ b/docs/api/puppeteer.csscoverage._constructor_.md @@ -6,7 +6,7 @@ sidebar_label: CSSCoverage.(constructor) Constructs a new instance of the `CSSCoverage` class -**Signature:** +#### Signature: ```typescript class CSSCoverage { diff --git a/docs/api/puppeteer.csscoverage.md b/docs/api/puppeteer.csscoverage.md index e9c632dba4fba..a75a886a9756d 100644 --- a/docs/api/puppeteer.csscoverage.md +++ b/docs/api/puppeteer.csscoverage.md @@ -4,7 +4,7 @@ sidebar_label: CSSCoverage # CSSCoverage class -**Signature:** +#### Signature: ```typescript export declare class CSSCoverage diff --git a/docs/api/puppeteer.csscoverage.start.md b/docs/api/puppeteer.csscoverage.start.md index 2bd4dfd8e96f3..659122360839f 100644 --- a/docs/api/puppeteer.csscoverage.start.md +++ b/docs/api/puppeteer.csscoverage.start.md @@ -4,7 +4,7 @@ sidebar_label: CSSCoverage.start # CSSCoverage.start() method -**Signature:** +#### Signature: ```typescript class CSSCoverage { diff --git a/docs/api/puppeteer.csscoverage.stop.md b/docs/api/puppeteer.csscoverage.stop.md index 5f9261d97642a..ec0d12bd34bbf 100644 --- a/docs/api/puppeteer.csscoverage.stop.md +++ b/docs/api/puppeteer.csscoverage.stop.md @@ -4,7 +4,7 @@ sidebar_label: CSSCoverage.stop # CSSCoverage.stop() method -**Signature:** +#### Signature: ```typescript class CSSCoverage { diff --git a/docs/api/puppeteer.csscoverageoptions.md b/docs/api/puppeteer.csscoverageoptions.md index 64f7b66066938..301d560c5a2a8 100644 --- a/docs/api/puppeteer.csscoverageoptions.md +++ b/docs/api/puppeteer.csscoverageoptions.md @@ -6,7 +6,7 @@ sidebar_label: CSSCoverageOptions Set of configurable options for CSS coverage. -**Signature:** +#### Signature: ```typescript export interface CSSCoverageOptions @@ -14,6 +14,6 @@ export interface CSSCoverageOptions ## Properties -| Property | Modifiers | Type | Description | -| ------------------------------------------------------------------------- | --------- | ------- | ---------------------------------------------------------------- | -| [resetOnNavigation?](./puppeteer.csscoverageoptions.resetonnavigation.md) | | boolean | (Optional) Whether to reset coverage on every navigation. | +| Property | Modifiers | Type | Description | Default | +| ------------------------------------------------------------------------- | --------- | ------- | ---------------------------------------------------------------- | ------- | +| [resetOnNavigation?](./puppeteer.csscoverageoptions.resetonnavigation.md) | | boolean | (Optional) Whether to reset coverage on every navigation. | | diff --git a/docs/api/puppeteer.csscoverageoptions.resetonnavigation.md b/docs/api/puppeteer.csscoverageoptions.resetonnavigation.md index a559bde676707..5fd1da4195c47 100644 --- a/docs/api/puppeteer.csscoverageoptions.resetonnavigation.md +++ b/docs/api/puppeteer.csscoverageoptions.resetonnavigation.md @@ -6,7 +6,7 @@ sidebar_label: CSSCoverageOptions.resetOnNavigation Whether to reset coverage on every navigation. -**Signature:** +#### Signature: ```typescript interface CSSCoverageOptions { diff --git a/docs/api/puppeteer.customerror.md b/docs/api/puppeteer.customerror.md index 0fc5796e80451..e63e243516e89 100644 --- a/docs/api/puppeteer.customerror.md +++ b/docs/api/puppeteer.customerror.md @@ -8,7 +8,7 @@ sidebar_label: CustomError > > Do not use. -**Signature:** +#### Signature: ```typescript export declare class CustomError extends Error diff --git a/docs/api/puppeteer.customqueryhandler.md b/docs/api/puppeteer.customqueryhandler.md index 67e1123a24acd..a18849dc6b03a 100644 --- a/docs/api/puppeteer.customqueryhandler.md +++ b/docs/api/puppeteer.customqueryhandler.md @@ -4,7 +4,7 @@ sidebar_label: CustomQueryHandler # CustomQueryHandler interface -**Signature:** +#### Signature: ```typescript export interface CustomQueryHandler @@ -12,7 +12,7 @@ export interface CustomQueryHandler ## Properties -| Property | Modifiers | Type | Description | -| ------------------------------------------------------- | --------- | ------------------------------------------------- | ----------------- | -| [queryAll?](./puppeteer.customqueryhandler.queryall.md) | | (node: Node, selector: string) => Node\[\] | (Optional) | -| [queryOne?](./puppeteer.customqueryhandler.queryone.md) | | (node: Node, selector: string) => Node \| null | (Optional) | +| Property | Modifiers | Type | Description | Default | +| ------------------------------------------------------- | --------- | ------------------------------------------------- | ----------------- | ------- | +| [queryAll?](./puppeteer.customqueryhandler.queryall.md) | | (node: Node, selector: string) => Node\[\] | (Optional) | | +| [queryOne?](./puppeteer.customqueryhandler.queryone.md) | | (node: Node, selector: string) => Node \| null | (Optional) | | diff --git a/docs/api/puppeteer.customqueryhandler.queryall.md b/docs/api/puppeteer.customqueryhandler.queryall.md index d366bb7f62664..167a38606adb7 100644 --- a/docs/api/puppeteer.customqueryhandler.queryall.md +++ b/docs/api/puppeteer.customqueryhandler.queryall.md @@ -4,7 +4,7 @@ sidebar_label: CustomQueryHandler.queryAll # CustomQueryHandler.queryAll property -**Signature:** +#### Signature: ```typescript interface CustomQueryHandler { diff --git a/docs/api/puppeteer.customqueryhandler.queryone.md b/docs/api/puppeteer.customqueryhandler.queryone.md index bccfb2f5b3953..bbd241c85b953 100644 --- a/docs/api/puppeteer.customqueryhandler.queryone.md +++ b/docs/api/puppeteer.customqueryhandler.queryone.md @@ -4,7 +4,7 @@ sidebar_label: CustomQueryHandler.queryOne # CustomQueryHandler.queryOne property -**Signature:** +#### Signature: ```typescript interface CustomQueryHandler { diff --git a/docs/api/puppeteer.customqueryhandlernames.md b/docs/api/puppeteer.customqueryhandlernames.md index bdf4bf26eaa36..c68f393920ced 100644 --- a/docs/api/puppeteer.customqueryhandlernames.md +++ b/docs/api/puppeteer.customqueryhandlernames.md @@ -8,7 +8,7 @@ sidebar_label: customQueryHandlerNames > > Import [Puppeteer](./puppeteer.puppeteer.md) and use the static method [Puppeteer.customQueryHandlerNames()](./puppeteer.puppeteer.customqueryhandlernames.md) -**Signature:** +#### Signature: ```typescript export declare function customQueryHandlerNames(): string[]; diff --git a/docs/api/puppeteer.default_intercept_resolution_priority.md b/docs/api/puppeteer.default_intercept_resolution_priority.md index e183caa36db49..1302de1ee60f6 100644 --- a/docs/api/puppeteer.default_intercept_resolution_priority.md +++ b/docs/api/puppeteer.default_intercept_resolution_priority.md @@ -6,7 +6,7 @@ sidebar_label: DEFAULT_INTERCEPT_RESOLUTION_PRIORITY The default cooperative request interception resolution priority -**Signature:** +#### Signature: ```typescript DEFAULT_INTERCEPT_RESOLUTION_PRIORITY = 0; diff --git a/docs/api/puppeteer.defaultargs.md b/docs/api/puppeteer.defaultargs.md index b5ab12682d676..e8ede108c6710 100644 --- a/docs/api/puppeteer.defaultargs.md +++ b/docs/api/puppeteer.defaultargs.md @@ -4,7 +4,7 @@ sidebar_label: defaultArgs # defaultArgs variable -**Signature:** +#### Signature: ```typescript defaultArgs: (options?: import("puppeteer-core/internal/node/LaunchOptions.js").BrowserLaunchArgumentOptions | undefined) => string[] diff --git a/docs/api/puppeteer.device.md b/docs/api/puppeteer.device.md index d2ccae149d2b7..b690704f545c5 100644 --- a/docs/api/puppeteer.device.md +++ b/docs/api/puppeteer.device.md @@ -4,7 +4,7 @@ sidebar_label: Device # Device interface -**Signature:** +#### Signature: ```typescript export interface Device @@ -12,7 +12,7 @@ export interface Device ## Properties -| Property | Modifiers | Type | Description | -| -------------------------------------------- | --------- | ----------------------------------- | ----------- | -| [userAgent](./puppeteer.device.useragent.md) | | string | | -| [viewport](./puppeteer.device.viewport.md) | | [Viewport](./puppeteer.viewport.md) | | +| Property | Modifiers | Type | Description | Default | +| -------------------------------------------- | --------- | ----------------------------------- | ----------- | ------- | +| [userAgent](./puppeteer.device.useragent.md) | | string | | | +| [viewport](./puppeteer.device.viewport.md) | | [Viewport](./puppeteer.viewport.md) | | | diff --git a/docs/api/puppeteer.device.useragent.md b/docs/api/puppeteer.device.useragent.md index b65382ca2aee1..04c46d988479e 100644 --- a/docs/api/puppeteer.device.useragent.md +++ b/docs/api/puppeteer.device.useragent.md @@ -4,7 +4,7 @@ sidebar_label: Device.userAgent # Device.userAgent property -**Signature:** +#### Signature: ```typescript interface Device { diff --git a/docs/api/puppeteer.device.viewport.md b/docs/api/puppeteer.device.viewport.md index ba1048132ca14..f1f8c403b1703 100644 --- a/docs/api/puppeteer.device.viewport.md +++ b/docs/api/puppeteer.device.viewport.md @@ -4,7 +4,7 @@ sidebar_label: Device.viewport # Device.viewport property -**Signature:** +#### Signature: ```typescript interface Device { diff --git a/docs/api/puppeteer.devices.md b/docs/api/puppeteer.devices.md index 72cc7667e1b89..1a5deb8243784 100644 --- a/docs/api/puppeteer.devices.md +++ b/docs/api/puppeteer.devices.md @@ -8,7 +8,7 @@ sidebar_label: devices > > Import [KnownDevices](./puppeteer.knowndevices.md) -**Signature:** +#### Signature: ```typescript devices: Readonly< diff --git a/docs/api/puppeteer.dialog.accept.md b/docs/api/puppeteer.dialog.accept.md index 39d84e504e45f..06099eb4edea0 100644 --- a/docs/api/puppeteer.dialog.accept.md +++ b/docs/api/puppeteer.dialog.accept.md @@ -4,7 +4,7 @@ sidebar_label: Dialog.accept # Dialog.accept() method -**Signature:** +#### Signature: ```typescript class Dialog { diff --git a/docs/api/puppeteer.dialog.defaultvalue.md b/docs/api/puppeteer.dialog.defaultvalue.md index 4880551dbc368..75c236182766e 100644 --- a/docs/api/puppeteer.dialog.defaultvalue.md +++ b/docs/api/puppeteer.dialog.defaultvalue.md @@ -4,7 +4,7 @@ sidebar_label: Dialog.defaultValue # Dialog.defaultValue() method -**Signature:** +#### Signature: ```typescript class Dialog { diff --git a/docs/api/puppeteer.dialog.dismiss.md b/docs/api/puppeteer.dialog.dismiss.md index 097fda7ed2ae0..c76ff4e33b8eb 100644 --- a/docs/api/puppeteer.dialog.dismiss.md +++ b/docs/api/puppeteer.dialog.dismiss.md @@ -4,7 +4,7 @@ sidebar_label: Dialog.dismiss # Dialog.dismiss() method -**Signature:** +#### Signature: ```typescript class Dialog { diff --git a/docs/api/puppeteer.dialog.md b/docs/api/puppeteer.dialog.md index 14a34f578633e..5e502b741c5c0 100644 --- a/docs/api/puppeteer.dialog.md +++ b/docs/api/puppeteer.dialog.md @@ -6,7 +6,7 @@ sidebar_label: Dialog Dialog instances are dispatched by the [Page](./puppeteer.page.md) via the `dialog` event. -**Signature:** +#### Signature: ```typescript export declare class Dialog diff --git a/docs/api/puppeteer.dialog.message.md b/docs/api/puppeteer.dialog.message.md index 5e3b60a617b32..e837d1dec0241 100644 --- a/docs/api/puppeteer.dialog.message.md +++ b/docs/api/puppeteer.dialog.message.md @@ -4,7 +4,7 @@ sidebar_label: Dialog.message # Dialog.message() method -**Signature:** +#### Signature: ```typescript class Dialog { diff --git a/docs/api/puppeteer.dialog.type.md b/docs/api/puppeteer.dialog.type.md index dabdb19a006e6..948b751523aa2 100644 --- a/docs/api/puppeteer.dialog.type.md +++ b/docs/api/puppeteer.dialog.type.md @@ -4,7 +4,7 @@ sidebar_label: Dialog.type # Dialog.type() method -**Signature:** +#### Signature: ```typescript class Dialog { diff --git a/docs/api/puppeteer.elementhandle._.md b/docs/api/puppeteer.elementhandle._.md index c3984a957ed59..9d276752487e1 100644 --- a/docs/api/puppeteer.elementhandle._.md +++ b/docs/api/puppeteer.elementhandle._.md @@ -6,7 +6,7 @@ sidebar_label: ElementHandle.$ Queries the current element for an element matching the given selector. -**Signature:** +#### Signature: ```typescript class ElementHandle { diff --git a/docs/api/puppeteer.elementhandle.__.md b/docs/api/puppeteer.elementhandle.__.md index 18ff948924556..8c10c19270c08 100644 --- a/docs/api/puppeteer.elementhandle.__.md +++ b/docs/api/puppeteer.elementhandle.__.md @@ -6,7 +6,7 @@ sidebar_label: ElementHandle.$$ Queries the current element for all elements matching the given selector. -**Signature:** +#### Signature: ```typescript class ElementHandle { diff --git a/docs/api/puppeteer.elementhandle.__eval.md b/docs/api/puppeteer.elementhandle.__eval.md index d34a417599691..6726c9d8c8961 100644 --- a/docs/api/puppeteer.elementhandle.__eval.md +++ b/docs/api/puppeteer.elementhandle.__eval.md @@ -8,7 +8,7 @@ Runs the given function on an array of elements matching the given selector in t If the given function returns a promise, then this method will wait till the promise resolves. -**Signature:** +#### Signature: ```typescript class ElementHandle { diff --git a/docs/api/puppeteer.elementhandle._eval.md b/docs/api/puppeteer.elementhandle._eval.md index 11cb427b77ae8..405dd7d130537 100644 --- a/docs/api/puppeteer.elementhandle._eval.md +++ b/docs/api/puppeteer.elementhandle._eval.md @@ -8,7 +8,7 @@ Runs the given function on the first element matching the given selector in the If the given function returns a promise, then this method will wait till the promise resolves. -**Signature:** +#### Signature: ```typescript class ElementHandle { diff --git a/docs/api/puppeteer.elementhandle._x.md b/docs/api/puppeteer.elementhandle._x.md index 4b4e1e4a73017..1aa5a7f01f152 100644 --- a/docs/api/puppeteer.elementhandle._x.md +++ b/docs/api/puppeteer.elementhandle._x.md @@ -14,7 +14,7 @@ sidebar_label: ElementHandle.$x > > If there are no such elements, the method will resolve to an empty array. -**Signature:** +#### Signature: ```typescript class ElementHandle { diff --git a/docs/api/puppeteer.elementhandle.aselement.md b/docs/api/puppeteer.elementhandle.aselement.md index 8c55d209c36f2..1d3845215c28f 100644 --- a/docs/api/puppeteer.elementhandle.aselement.md +++ b/docs/api/puppeteer.elementhandle.aselement.md @@ -4,7 +4,7 @@ sidebar_label: ElementHandle.asElement # ElementHandle.asElement() method -**Signature:** +#### Signature: ```typescript class ElementHandle { diff --git a/docs/api/puppeteer.elementhandle.boundingbox.md b/docs/api/puppeteer.elementhandle.boundingbox.md index 529d103f2524f..e47a0e1a25031 100644 --- a/docs/api/puppeteer.elementhandle.boundingbox.md +++ b/docs/api/puppeteer.elementhandle.boundingbox.md @@ -6,7 +6,7 @@ sidebar_label: ElementHandle.boundingBox This method returns the bounding box of the element (relative to the main frame), or `null` if the element is not visible. -**Signature:** +#### Signature: ```typescript class ElementHandle { diff --git a/docs/api/puppeteer.elementhandle.boxmodel.md b/docs/api/puppeteer.elementhandle.boxmodel.md index bcb74f711f0a7..9adf38d4b0b0e 100644 --- a/docs/api/puppeteer.elementhandle.boxmodel.md +++ b/docs/api/puppeteer.elementhandle.boxmodel.md @@ -6,7 +6,7 @@ sidebar_label: ElementHandle.boxModel This method returns boxes of the element, or `null` if the element is not visible. -**Signature:** +#### Signature: ```typescript class ElementHandle { diff --git a/docs/api/puppeteer.elementhandle.click.md b/docs/api/puppeteer.elementhandle.click.md index 820e44285befb..884ee038bec11 100644 --- a/docs/api/puppeteer.elementhandle.click.md +++ b/docs/api/puppeteer.elementhandle.click.md @@ -6,7 +6,7 @@ sidebar_label: ElementHandle.click This method scrolls element into view if needed, and then uses [Page.mouse](./puppeteer.page.mouse.md) to click in the center of the element. If the element is detached from DOM, the method throws an error. -**Signature:** +#### Signature: ```typescript class ElementHandle { diff --git a/docs/api/puppeteer.elementhandle.clickablepoint.md b/docs/api/puppeteer.elementhandle.clickablepoint.md index a1371f0fc7c57..664c15b663994 100644 --- a/docs/api/puppeteer.elementhandle.clickablepoint.md +++ b/docs/api/puppeteer.elementhandle.clickablepoint.md @@ -6,7 +6,7 @@ sidebar_label: ElementHandle.clickablePoint Returns the middle point within an element unless a specific offset is provided. -**Signature:** +#### Signature: ```typescript class ElementHandle { diff --git a/docs/api/puppeteer.elementhandle.contentframe.md b/docs/api/puppeteer.elementhandle.contentframe.md index 6ce9e88a20b51..928b29c8e9b1f 100644 --- a/docs/api/puppeteer.elementhandle.contentframe.md +++ b/docs/api/puppeteer.elementhandle.contentframe.md @@ -6,7 +6,7 @@ sidebar_label: ElementHandle.contentFrame Resolves to the content frame for element handles referencing iframe nodes, or null otherwise -**Signature:** +#### Signature: ```typescript class ElementHandle { diff --git a/docs/api/puppeteer.elementhandle.drag.md b/docs/api/puppeteer.elementhandle.drag.md index b0ddb62cd4114..8ae241c97b183 100644 --- a/docs/api/puppeteer.elementhandle.drag.md +++ b/docs/api/puppeteer.elementhandle.drag.md @@ -6,7 +6,7 @@ sidebar_label: ElementHandle.drag This method creates and captures a dragevent from the element. -**Signature:** +#### Signature: ```typescript class ElementHandle { diff --git a/docs/api/puppeteer.elementhandle.draganddrop.md b/docs/api/puppeteer.elementhandle.draganddrop.md index efec7602aed3f..fdfb82d76e827 100644 --- a/docs/api/puppeteer.elementhandle.draganddrop.md +++ b/docs/api/puppeteer.elementhandle.draganddrop.md @@ -6,7 +6,7 @@ sidebar_label: ElementHandle.dragAndDrop This method triggers a dragenter, dragover, and drop on the element. -**Signature:** +#### Signature: ```typescript class ElementHandle { diff --git a/docs/api/puppeteer.elementhandle.dragenter.md b/docs/api/puppeteer.elementhandle.dragenter.md index 2f8f3b82f7ecd..b9cb2c386f620 100644 --- a/docs/api/puppeteer.elementhandle.dragenter.md +++ b/docs/api/puppeteer.elementhandle.dragenter.md @@ -6,7 +6,7 @@ sidebar_label: ElementHandle.dragEnter This method creates a `dragenter` event on the element. -**Signature:** +#### Signature: ```typescript class ElementHandle { diff --git a/docs/api/puppeteer.elementhandle.dragover.md b/docs/api/puppeteer.elementhandle.dragover.md index 90db5c5cd5056..430a46ec9b408 100644 --- a/docs/api/puppeteer.elementhandle.dragover.md +++ b/docs/api/puppeteer.elementhandle.dragover.md @@ -6,7 +6,7 @@ sidebar_label: ElementHandle.dragOver This method creates a `dragover` event on the element. -**Signature:** +#### Signature: ```typescript class ElementHandle { diff --git a/docs/api/puppeteer.elementhandle.drop.md b/docs/api/puppeteer.elementhandle.drop.md index 47d3af82cb1c4..2d9d0cdf212c2 100644 --- a/docs/api/puppeteer.elementhandle.drop.md +++ b/docs/api/puppeteer.elementhandle.drop.md @@ -6,7 +6,7 @@ sidebar_label: ElementHandle.drop This method triggers a drop on the element. -**Signature:** +#### Signature: ```typescript class ElementHandle { diff --git a/docs/api/puppeteer.elementhandle.focus.md b/docs/api/puppeteer.elementhandle.focus.md index 6681a295c5bfe..9efc51d662b4b 100644 --- a/docs/api/puppeteer.elementhandle.focus.md +++ b/docs/api/puppeteer.elementhandle.focus.md @@ -6,7 +6,7 @@ sidebar_label: ElementHandle.focus Calls [focus](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus) on the element. -**Signature:** +#### Signature: ```typescript class ElementHandle { diff --git a/docs/api/puppeteer.elementhandle.frame.md b/docs/api/puppeteer.elementhandle.frame.md index 7ed68d2ba2850..fd6d2529d821d 100644 --- a/docs/api/puppeteer.elementhandle.frame.md +++ b/docs/api/puppeteer.elementhandle.frame.md @@ -4,7 +4,7 @@ sidebar_label: ElementHandle.frame # ElementHandle.frame property -**Signature:** +#### Signature: ```typescript class ElementHandle { diff --git a/docs/api/puppeteer.elementhandle.hover.md b/docs/api/puppeteer.elementhandle.hover.md index 874ed7a7c4920..e6f9c55c3ff84 100644 --- a/docs/api/puppeteer.elementhandle.hover.md +++ b/docs/api/puppeteer.elementhandle.hover.md @@ -6,7 +6,7 @@ sidebar_label: ElementHandle.hover This method scrolls element into view if needed, and then uses [Page.mouse](./puppeteer.page.mouse.md) to hover over the center of the element. If the element is detached from DOM, the method throws an error. -**Signature:** +#### Signature: ```typescript class ElementHandle { diff --git a/docs/api/puppeteer.elementhandle.isintersectingviewport.md b/docs/api/puppeteer.elementhandle.isintersectingviewport.md index 4eaafc38fc0bd..26ef4722c4877 100644 --- a/docs/api/puppeteer.elementhandle.isintersectingviewport.md +++ b/docs/api/puppeteer.elementhandle.isintersectingviewport.md @@ -6,7 +6,7 @@ sidebar_label: ElementHandle.isIntersectingViewport Resolves to true if the element is visible in the current viewport. -**Signature:** +#### Signature: ```typescript class ElementHandle { diff --git a/docs/api/puppeteer.elementhandle.md b/docs/api/puppeteer.elementhandle.md index 5df3ec39491d1..da21732546a61 100644 --- a/docs/api/puppeteer.elementhandle.md +++ b/docs/api/puppeteer.elementhandle.md @@ -6,7 +6,7 @@ sidebar_label: ElementHandle ElementHandle represents an in-page DOM element. -**Signature:** +#### Signature: ```typescript export declare class ElementHandle extends JSHandle diff --git a/docs/api/puppeteer.elementhandle.press.md b/docs/api/puppeteer.elementhandle.press.md index 5b2b1e6321eae..0a008151266a9 100644 --- a/docs/api/puppeteer.elementhandle.press.md +++ b/docs/api/puppeteer.elementhandle.press.md @@ -6,7 +6,7 @@ sidebar_label: ElementHandle.press Focuses the element, and then uses [Keyboard.down()](./puppeteer.keyboard.down.md) and [Keyboard.up()](./puppeteer.keyboard.up.md). -**Signature:** +#### Signature: ```typescript class ElementHandle { diff --git a/docs/api/puppeteer.elementhandle.screenshot.md b/docs/api/puppeteer.elementhandle.screenshot.md index 02559169edde3..b0be948f5cc00 100644 --- a/docs/api/puppeteer.elementhandle.screenshot.md +++ b/docs/api/puppeteer.elementhandle.screenshot.md @@ -6,7 +6,7 @@ sidebar_label: ElementHandle.screenshot This method scrolls element into view if needed, and then uses [Page.screenshot()](./puppeteer.page.screenshot.md) to take a screenshot of the element. If the element is detached from DOM, the method throws an error. -**Signature:** +#### Signature: ```typescript class ElementHandle { diff --git a/docs/api/puppeteer.elementhandle.select.md b/docs/api/puppeteer.elementhandle.select.md index 10d3abc658599..c6c1133790611 100644 --- a/docs/api/puppeteer.elementhandle.select.md +++ b/docs/api/puppeteer.elementhandle.select.md @@ -6,7 +6,7 @@ sidebar_label: ElementHandle.select Triggers a `change` and `input` event once all the provided options have been selected. If there's no `