mirror of
https://github.com/puppeteer/puppeteer
synced 2024-06-14 14:02:48 +00:00
5270 lines
235 KiB
Markdown
5270 lines
235 KiB
Markdown
# Puppeteer API <!-- GEN:version -->Tip-Of-Tree<!-- GEN:stop-->
|
||
|
||
<!-- GEN:empty-if-release --><!-- GEN:stop -->
|
||
|
||
- Interactive Documentation: https://pptr.dev
|
||
- API Translations: [中文|Chinese](https://zhaoqize.github.io/puppeteer-api-zh_CN/#/)
|
||
- Troubleshooting: [troubleshooting.md](https://github.com/puppeteer/puppeteer/blob/main/docs/troubleshooting.md)
|
||
|
||
<!-- prettier-ignore-start -->
|
||
|
||
<!-- GEN:versions-per-release -->
|
||
- Releases per Chromium version:
|
||
* Chromium 93.0.4577.0 - [Puppeteer v10.2.0](https://github.com/puppeteer/puppeteer/blob/v10.2.0/docs/api.md)
|
||
* Chromium 92.0.4512.0 - [Puppeteer v10.0.0](https://github.com/puppeteer/puppeteer/blob/v10.0.0/docs/api.md)
|
||
* Chromium 91.0.4469.0 - [Puppeteer v9.0.0](https://github.com/puppeteer/puppeteer/blob/v9.0.0/docs/api.md)
|
||
* Chromium 90.0.4427.0 - [Puppeteer v8.0.0](https://github.com/puppeteer/puppeteer/blob/v8.0.0/docs/api.md)
|
||
* Chromium 90.0.4403.0 - [Puppeteer v7.0.0](https://github.com/puppeteer/puppeteer/blob/v7.0.0/docs/api.md)
|
||
* Chromium 89.0.4389.0 - [Puppeteer v6.0.0](https://github.com/puppeteer/puppeteer/blob/v6.0.0/docs/api.md)
|
||
* Chromium 88.0.4298.0 - [Puppeteer v5.5.0](https://github.com/puppeteer/puppeteer/blob/v5.5.0/docs/api.md)
|
||
* Chromium 87.0.4272.0 - [Puppeteer v5.4.0](https://github.com/puppeteer/puppeteer/blob/v5.4.0/docs/api.md)
|
||
* Chromium 86.0.4240.0 - [Puppeteer v5.3.0](https://github.com/puppeteer/puppeteer/blob/v5.3.0/docs/api.md)
|
||
* Chromium 85.0.4182.0 - [Puppeteer v5.2.1](https://github.com/puppeteer/puppeteer/blob/v5.2.1/docs/api.md)
|
||
* Chromium 84.0.4147.0 - [Puppeteer v5.1.0](https://github.com/puppeteer/puppeteer/blob/v5.1.0/docs/api.md)
|
||
* Chromium 83.0.4103.0 - [Puppeteer v3.1.0](https://github.com/puppeteer/puppeteer/blob/v3.1.0/docs/api.md)
|
||
* Chromium 81.0.4044.0 - [Puppeteer v3.0.0](https://github.com/puppeteer/puppeteer/blob/v3.0.0/docs/api.md)
|
||
* Chromium 80.0.3987.0 - [Puppeteer v2.1.0](https://github.com/puppeteer/puppeteer/blob/v2.1.0/docs/api.md)
|
||
* Chromium 79.0.3942.0 - [Puppeteer v2.0.0](https://github.com/puppeteer/puppeteer/blob/v2.0.0/docs/api.md)
|
||
* Chromium 78.0.3882.0 - [Puppeteer v1.20.0](https://github.com/puppeteer/puppeteer/blob/v1.20.0/docs/api.md)
|
||
* Chromium 77.0.3803.0 - [Puppeteer v1.19.0](https://github.com/puppeteer/puppeteer/blob/v1.19.0/docs/api.md)
|
||
* Chromium 76.0.3803.0 - [Puppeteer v1.17.0](https://github.com/puppeteer/puppeteer/blob/v1.17.0/docs/api.md)
|
||
* Chromium 75.0.3765.0 - [Puppeteer v1.15.0](https://github.com/puppeteer/puppeteer/blob/v1.15.0/docs/api.md)
|
||
* Chromium 74.0.3723.0 - [Puppeteer v1.13.0](https://github.com/puppeteer/puppeteer/blob/v1.13.0/docs/api.md)
|
||
* Chromium 73.0.3679.0 - [Puppeteer v1.12.2](https://github.com/puppeteer/puppeteer/blob/v1.12.2/docs/api.md)
|
||
* [All releases](https://github.com/puppeteer/puppeteer/releases)
|
||
<!-- GEN:stop -->
|
||
|
||
<!-- prettier-ignore-end -->
|
||
|
||
##### Table of Contents
|
||
|
||
<!-- prettier-ignore-start -->
|
||
|
||
<!-- GEN:toc -->
|
||
- [Overview](#overview)
|
||
- [puppeteer vs puppeteer-core](#puppeteer-vs-puppeteer-core)
|
||
- [Environment Variables](#environment-variables)
|
||
- [Working with Chrome Extensions](#working-with-chrome-extensions)
|
||
- [class: Puppeteer](#class-puppeteer)
|
||
* [puppeteer.clearCustomQueryHandlers()](#puppeteerclearcustomqueryhandlers)
|
||
* [puppeteer.connect(options)](#puppeteerconnectoptions)
|
||
* [puppeteer.createBrowserFetcher([options])](#puppeteercreatebrowserfetcheroptions)
|
||
* [puppeteer.customQueryHandlerNames()](#puppeteercustomqueryhandlernames)
|
||
* [puppeteer.defaultArgs([options])](#puppeteerdefaultargsoptions)
|
||
* [puppeteer.devices](#puppeteerdevices)
|
||
* [puppeteer.errors](#puppeteererrors)
|
||
* [puppeteer.executablePath()](#puppeteerexecutablepath)
|
||
* [puppeteer.launch([options])](#puppeteerlaunchoptions)
|
||
* [puppeteer.networkConditions](#puppeteernetworkconditions)
|
||
* [puppeteer.product](#puppeteerproduct)
|
||
* [puppeteer.registerCustomQueryHandler(name, queryHandler)](#puppeteerregistercustomqueryhandlername-queryhandler)
|
||
* [puppeteer.unregisterCustomQueryHandler(name)](#puppeteerunregistercustomqueryhandlername)
|
||
- [class: BrowserFetcher](#class-browserfetcher)
|
||
* [browserFetcher.canDownload(revision)](#browserfetchercandownloadrevision)
|
||
* [browserFetcher.download(revision[, progressCallback])](#browserfetcherdownloadrevision-progresscallback)
|
||
* [browserFetcher.host()](#browserfetcherhost)
|
||
* [browserFetcher.localRevisions()](#browserfetcherlocalrevisions)
|
||
* [browserFetcher.platform()](#browserfetcherplatform)
|
||
* [browserFetcher.product()](#browserfetcherproduct)
|
||
* [browserFetcher.remove(revision)](#browserfetcherremoverevision)
|
||
* [browserFetcher.revisionInfo(revision)](#browserfetcherrevisioninforevision)
|
||
- [class: Browser](#class-browser)
|
||
* [event: 'disconnected'](#event-disconnected)
|
||
* [event: 'targetchanged'](#event-targetchanged)
|
||
* [event: 'targetcreated'](#event-targetcreated)
|
||
* [event: 'targetdestroyed'](#event-targetdestroyed)
|
||
* [browser.browserContexts()](#browserbrowsercontexts)
|
||
* [browser.close()](#browserclose)
|
||
* [browser.createIncognitoBrowserContext([options])](#browsercreateincognitobrowsercontextoptions)
|
||
* [browser.defaultBrowserContext()](#browserdefaultbrowsercontext)
|
||
* [browser.disconnect()](#browserdisconnect)
|
||
* [browser.isConnected()](#browserisconnected)
|
||
* [browser.newPage()](#browsernewpage)
|
||
* [browser.pages()](#browserpages)
|
||
* [browser.process()](#browserprocess)
|
||
* [browser.target()](#browsertarget)
|
||
* [browser.targets()](#browsertargets)
|
||
* [browser.userAgent()](#browseruseragent)
|
||
* [browser.version()](#browserversion)
|
||
* [browser.waitForTarget(predicate[, options])](#browserwaitfortargetpredicate-options)
|
||
* [browser.wsEndpoint()](#browserwsendpoint)
|
||
- [class: BrowserContext](#class-browsercontext)
|
||
* [event: 'targetchanged'](#event-targetchanged-1)
|
||
* [event: 'targetcreated'](#event-targetcreated-1)
|
||
* [event: 'targetdestroyed'](#event-targetdestroyed-1)
|
||
* [browserContext.browser()](#browsercontextbrowser)
|
||
* [browserContext.clearPermissionOverrides()](#browsercontextclearpermissionoverrides)
|
||
* [browserContext.close()](#browsercontextclose)
|
||
* [browserContext.isIncognito()](#browsercontextisincognito)
|
||
* [browserContext.newPage()](#browsercontextnewpage)
|
||
* [browserContext.overridePermissions(origin, permissions)](#browsercontextoverridepermissionsorigin-permissions)
|
||
* [browserContext.pages()](#browsercontextpages)
|
||
* [browserContext.targets()](#browsercontexttargets)
|
||
* [browserContext.waitForTarget(predicate[, options])](#browsercontextwaitfortargetpredicate-options)
|
||
- [class: Page](#class-page)
|
||
* [event: 'close'](#event-close)
|
||
* [event: 'console'](#event-console)
|
||
* [event: 'dialog'](#event-dialog)
|
||
* [event: 'domcontentloaded'](#event-domcontentloaded)
|
||
* [event: 'error'](#event-error)
|
||
* [event: 'frameattached'](#event-frameattached)
|
||
* [event: 'framedetached'](#event-framedetached)
|
||
* [event: 'framenavigated'](#event-framenavigated)
|
||
* [event: 'load'](#event-load)
|
||
* [event: 'metrics'](#event-metrics)
|
||
* [event: 'pageerror'](#event-pageerror)
|
||
* [event: 'popup'](#event-popup)
|
||
* [event: 'request'](#event-request)
|
||
* [event: 'requestfailed'](#event-requestfailed)
|
||
* [event: 'requestfinished'](#event-requestfinished)
|
||
* [event: 'response'](#event-response)
|
||
* [event: 'workercreated'](#event-workercreated)
|
||
* [event: 'workerdestroyed'](#event-workerdestroyed)
|
||
* [page.$(selector)](#pageselector)
|
||
* [page.$$(selector)](#pageselector-1)
|
||
* [page.$$eval(selector, pageFunction[, ...args])](#pageevalselector-pagefunction-args)
|
||
* [page.$eval(selector, pageFunction[, ...args])](#pageevalselector-pagefunction-args-1)
|
||
* [page.$x(expression)](#pagexexpression)
|
||
* [page.accessibility](#pageaccessibility)
|
||
* [page.addScriptTag(options)](#pageaddscripttagoptions)
|
||
* [page.addStyleTag(options)](#pageaddstyletagoptions)
|
||
* [page.authenticate(credentials)](#pageauthenticatecredentials)
|
||
* [page.bringToFront()](#pagebringtofront)
|
||
* [page.browser()](#pagebrowser)
|
||
* [page.browserContext()](#pagebrowsercontext)
|
||
* [page.click(selector[, options])](#pageclickselector-options)
|
||
* [page.close([options])](#pagecloseoptions)
|
||
* [page.content()](#pagecontent)
|
||
* [page.cookies([...urls])](#pagecookiesurls)
|
||
* [page.coverage](#pagecoverage)
|
||
* [page.createPDFStream([options])](#pagecreatepdfstreamoptions)
|
||
* [page.deleteCookie(...cookies)](#pagedeletecookiecookies)
|
||
* [page.emulate(options)](#pageemulateoptions)
|
||
* [page.emulateCPUThrottling(factor)](#pageemulatecputhrottlingfactor)
|
||
* [page.emulateIdleState(overrides)](#pageemulateidlestateoverrides)
|
||
* [page.emulateMediaFeatures(features)](#pageemulatemediafeaturesfeatures)
|
||
* [page.emulateMediaType(type)](#pageemulatemediatypetype)
|
||
* [page.emulateNetworkConditions(networkConditions)](#pageemulatenetworkconditionsnetworkconditions)
|
||
* [page.emulateTimezone(timezoneId)](#pageemulatetimezonetimezoneid)
|
||
* [page.emulateVisionDeficiency(type)](#pageemulatevisiondeficiencytype)
|
||
* [page.evaluate(pageFunction[, ...args])](#pageevaluatepagefunction-args)
|
||
* [page.evaluateHandle(pageFunction[, ...args])](#pageevaluatehandlepagefunction-args)
|
||
* [page.evaluateOnNewDocument(pageFunction[, ...args])](#pageevaluateonnewdocumentpagefunction-args)
|
||
* [page.exposeFunction(name, puppeteerFunction)](#pageexposefunctionname-puppeteerfunction)
|
||
* [page.focus(selector)](#pagefocusselector)
|
||
* [page.frames()](#pageframes)
|
||
* [page.goBack([options])](#pagegobackoptions)
|
||
* [page.goForward([options])](#pagegoforwardoptions)
|
||
* [page.goto(url[, options])](#pagegotourl-options)
|
||
* [page.hover(selector)](#pagehoverselector)
|
||
* [page.isClosed()](#pageisclosed)
|
||
* [page.isDragInterceptionEnabled()](#pageisdraginterceptionenabled)
|
||
* [page.isJavaScriptEnabled()](#pageisjavascriptenabled)
|
||
* [page.keyboard](#pagekeyboard)
|
||
* [page.mainFrame()](#pagemainframe)
|
||
* [page.metrics()](#pagemetrics)
|
||
* [page.mouse](#pagemouse)
|
||
* [page.pdf([options])](#pagepdfoptions)
|
||
* [page.queryObjects(prototypeHandle)](#pagequeryobjectsprototypehandle)
|
||
* [page.reload([options])](#pagereloadoptions)
|
||
* [page.screenshot([options])](#pagescreenshotoptions)
|
||
* [page.select(selector, ...values)](#pageselectselector-values)
|
||
* [page.setBypassCSP(enabled)](#pagesetbypasscspenabled)
|
||
* [page.setCacheEnabled([enabled])](#pagesetcacheenabledenabled)
|
||
* [page.setContent(html[, options])](#pagesetcontenthtml-options)
|
||
* [page.setCookie(...cookies)](#pagesetcookiecookies)
|
||
* [page.setDefaultNavigationTimeout(timeout)](#pagesetdefaultnavigationtimeouttimeout)
|
||
* [page.setDefaultTimeout(timeout)](#pagesetdefaulttimeouttimeout)
|
||
* [page.setDragInterception(enabled)](#pagesetdraginterceptionenabled)
|
||
* [page.setExtraHTTPHeaders(headers)](#pagesetextrahttpheadersheaders)
|
||
* [page.setGeolocation(options)](#pagesetgeolocationoptions)
|
||
* [page.setJavaScriptEnabled(enabled)](#pagesetjavascriptenabledenabled)
|
||
* [page.setOfflineMode(enabled)](#pagesetofflinemodeenabled)
|
||
* [page.setRequestInterception(value)](#pagesetrequestinterceptionvalue)
|
||
- [Cooperative Intercept Mode and Legacy Intercept Mode](#cooperative-intercept-mode-and-legacy-intercept-mode)
|
||
- [Upgrading to Cooperative Mode for package maintainers](#upgrading-to-cooperative-mode-for-package-maintainers)
|
||
* [page.setUserAgent(userAgent[, userAgentMetadata])](#pagesetuseragentuseragent-useragentmetadata)
|
||
* [page.setViewport(viewport)](#pagesetviewportviewport)
|
||
* [page.tap(selector)](#pagetapselector)
|
||
* [page.target()](#pagetarget)
|
||
* [page.title()](#pagetitle)
|
||
* [page.touchscreen](#pagetouchscreen)
|
||
* [page.tracing](#pagetracing)
|
||
* [page.type(selector, text[, options])](#pagetypeselector-text-options)
|
||
* [page.url()](#pageurl)
|
||
* [page.viewport()](#pageviewport)
|
||
* [page.waitFor(selectorOrFunctionOrTimeout[, options[, ...args]])](#pagewaitforselectororfunctionortimeout-options-args)
|
||
* [page.waitForFileChooser([options])](#pagewaitforfilechooseroptions)
|
||
* [page.waitForFunction(pageFunction[, options[, ...args]])](#pagewaitforfunctionpagefunction-options-args)
|
||
* [page.waitForNavigation([options])](#pagewaitfornavigationoptions)
|
||
* [page.waitForNetworkIdle([options])](#pagewaitfornetworkidleoptions)
|
||
* [page.waitForRequest(urlOrPredicate[, options])](#pagewaitforrequesturlorpredicate-options)
|
||
* [page.waitForResponse(urlOrPredicate[, options])](#pagewaitforresponseurlorpredicate-options)
|
||
* [page.waitForSelector(selector[, options])](#pagewaitforselectorselector-options)
|
||
* [page.waitForTimeout(milliseconds)](#pagewaitfortimeoutmilliseconds)
|
||
* [page.waitForXPath(xpath[, options])](#pagewaitforxpathxpath-options)
|
||
* [page.workers()](#pageworkers)
|
||
* [GeolocationOptions](#geolocationoptions)
|
||
* [WaitTimeoutOptions](#waittimeoutoptions)
|
||
- [class: WebWorker](#class-webworker)
|
||
* [webWorker.evaluate(pageFunction[, ...args])](#webworkerevaluatepagefunction-args)
|
||
* [webWorker.evaluateHandle(pageFunction[, ...args])](#webworkerevaluatehandlepagefunction-args)
|
||
* [webWorker.executionContext()](#webworkerexecutioncontext)
|
||
* [webWorker.url()](#webworkerurl)
|
||
- [class: Accessibility](#class-accessibility)
|
||
* [accessibility.snapshot([options])](#accessibilitysnapshotoptions)
|
||
- [class: Keyboard](#class-keyboard)
|
||
* [keyboard.down(key[, options])](#keyboarddownkey-options)
|
||
* [keyboard.press(key[, options])](#keyboardpresskey-options)
|
||
* [keyboard.sendCharacter(char)](#keyboardsendcharacterchar)
|
||
* [keyboard.type(text[, options])](#keyboardtypetext-options)
|
||
* [keyboard.up(key)](#keyboardupkey)
|
||
- [class: Mouse](#class-mouse)
|
||
* [mouse.click(x, y[, options])](#mouseclickx-y-options)
|
||
* [mouse.down([options])](#mousedownoptions)
|
||
* [mouse.drag(start, target)](#mousedragstart-target)
|
||
* [mouse.dragAndDrop(start, target[, options])](#mousedraganddropstart-target-options)
|
||
* [mouse.dragEnter(target, data)](#mousedragentertarget-data)
|
||
* [mouse.dragOver(target, data)](#mousedragovertarget-data)
|
||
* [mouse.drop(target, data)](#mousedroptarget-data)
|
||
* [mouse.move(x, y[, options])](#mousemovex-y-options)
|
||
* [mouse.up([options])](#mouseupoptions)
|
||
* [mouse.wheel([options])](#mousewheeloptions)
|
||
- [class: Touchscreen](#class-touchscreen)
|
||
* [touchscreen.tap(x, y)](#touchscreentapx-y)
|
||
- [class: Tracing](#class-tracing)
|
||
* [tracing.start([options])](#tracingstartoptions)
|
||
* [tracing.stop()](#tracingstop)
|
||
- [class: FileChooser](#class-filechooser)
|
||
* [fileChooser.accept(filePaths)](#filechooseracceptfilepaths)
|
||
* [fileChooser.cancel()](#filechoosercancel)
|
||
* [fileChooser.isMultiple()](#filechooserismultiple)
|
||
- [class: Dialog](#class-dialog)
|
||
* [dialog.accept([promptText])](#dialogacceptprompttext)
|
||
* [dialog.defaultValue()](#dialogdefaultvalue)
|
||
* [dialog.dismiss()](#dialogdismiss)
|
||
* [dialog.message()](#dialogmessage)
|
||
* [dialog.type()](#dialogtype)
|
||
- [class: ConsoleMessage](#class-consolemessage)
|
||
* [consoleMessage.args()](#consolemessageargs)
|
||
* [consoleMessage.location()](#consolemessagelocation)
|
||
* [consoleMessage.stackTrace()](#consolemessagestacktrace)
|
||
* [consoleMessage.text()](#consolemessagetext)
|
||
* [consoleMessage.type()](#consolemessagetype)
|
||
- [class: Frame](#class-frame)
|
||
* [frame.$(selector)](#frameselector)
|
||
* [frame.$$(selector)](#frameselector-1)
|
||
* [frame.$$eval(selector, pageFunction[, ...args])](#frameevalselector-pagefunction-args)
|
||
* [frame.$eval(selector, pageFunction[, ...args])](#frameevalselector-pagefunction-args-1)
|
||
* [frame.$x(expression)](#framexexpression)
|
||
* [frame.addScriptTag(options)](#frameaddscripttagoptions)
|
||
* [frame.addStyleTag(options)](#frameaddstyletagoptions)
|
||
* [frame.childFrames()](#framechildframes)
|
||
* [frame.click(selector[, options])](#frameclickselector-options)
|
||
* [frame.content()](#framecontent)
|
||
* [frame.evaluate(pageFunction[, ...args])](#frameevaluatepagefunction-args)
|
||
* [frame.evaluateHandle(pageFunction[, ...args])](#frameevaluatehandlepagefunction-args)
|
||
* [frame.executionContext()](#frameexecutioncontext)
|
||
* [frame.focus(selector)](#framefocusselector)
|
||
* [frame.goto(url[, options])](#framegotourl-options)
|
||
* [frame.hover(selector)](#framehoverselector)
|
||
* [frame.isDetached()](#frameisdetached)
|
||
* [frame.name()](#framename)
|
||
* [frame.parentFrame()](#frameparentframe)
|
||
* [frame.select(selector, ...values)](#frameselectselector-values)
|
||
* [frame.setContent(html[, options])](#framesetcontenthtml-options)
|
||
* [frame.tap(selector)](#frametapselector)
|
||
* [frame.title()](#frametitle)
|
||
* [frame.type(selector, text[, options])](#frametypeselector-text-options)
|
||
* [frame.url()](#frameurl)
|
||
* [frame.waitFor(selectorOrFunctionOrTimeout[, options[, ...args]])](#framewaitforselectororfunctionortimeout-options-args)
|
||
* [frame.waitForFunction(pageFunction[, options[, ...args]])](#framewaitforfunctionpagefunction-options-args)
|
||
* [frame.waitForNavigation([options])](#framewaitfornavigationoptions)
|
||
* [frame.waitForSelector(selector[, options])](#framewaitforselectorselector-options)
|
||
* [frame.waitForTimeout(milliseconds)](#framewaitfortimeoutmilliseconds)
|
||
* [frame.waitForXPath(xpath[, options])](#framewaitforxpathxpath-options)
|
||
- [class: ExecutionContext](#class-executioncontext)
|
||
* [executionContext.evaluate(pageFunction[, ...args])](#executioncontextevaluatepagefunction-args)
|
||
* [executionContext.evaluateHandle(pageFunction[, ...args])](#executioncontextevaluatehandlepagefunction-args)
|
||
* [executionContext.frame()](#executioncontextframe)
|
||
* [executionContext.queryObjects(prototypeHandle)](#executioncontextqueryobjectsprototypehandle)
|
||
- [class: JSHandle](#class-jshandle)
|
||
* [jsHandle.asElement()](#jshandleaselement)
|
||
* [jsHandle.dispose()](#jshandledispose)
|
||
* [jsHandle.evaluate(pageFunction[, ...args])](#jshandleevaluatepagefunction-args)
|
||
* [jsHandle.evaluateHandle(pageFunction[, ...args])](#jshandleevaluatehandlepagefunction-args)
|
||
* [jsHandle.executionContext()](#jshandleexecutioncontext)
|
||
* [jsHandle.getProperties()](#jshandlegetproperties)
|
||
* [jsHandle.getProperty(propertyName)](#jshandlegetpropertypropertyname)
|
||
* [jsHandle.jsonValue()](#jshandlejsonvalue)
|
||
- [class: ElementHandle](#class-elementhandle)
|
||
* [elementHandle.$(selector)](#elementhandleselector)
|
||
* [elementHandle.$$(selector)](#elementhandleselector-1)
|
||
* [elementHandle.$$eval(selector, pageFunction[, ...args])](#elementhandleevalselector-pagefunction-args)
|
||
* [elementHandle.$eval(selector, pageFunction[, ...args])](#elementhandleevalselector-pagefunction-args-1)
|
||
* [elementHandle.$x(expression)](#elementhandlexexpression)
|
||
* [elementHandle.asElement()](#elementhandleaselement)
|
||
* [elementHandle.boundingBox()](#elementhandleboundingbox)
|
||
* [elementHandle.boxModel()](#elementhandleboxmodel)
|
||
* [elementHandle.click([options])](#elementhandleclickoptions)
|
||
* [elementHandle.clickablePoint([offset])](#elementhandleclickablepointoffset)
|
||
* [elementHandle.contentFrame()](#elementhandlecontentframe)
|
||
* [elementHandle.dispose()](#elementhandledispose)
|
||
* [elementHandle.drag(target)](#elementhandledragtarget)
|
||
* [elementHandle.dragAndDrop(target[, options])](#elementhandledraganddroptarget-options)
|
||
* [elementHandle.dragEnter([data])](#elementhandledragenterdata)
|
||
* [elementHandle.dragOver([data])](#elementhandledragoverdata)
|
||
* [elementHandle.drop([data])](#elementhandledropdata)
|
||
* [elementHandle.evaluate(pageFunction[, ...args])](#elementhandleevaluatepagefunction-args)
|
||
* [elementHandle.evaluateHandle(pageFunction[, ...args])](#elementhandleevaluatehandlepagefunction-args)
|
||
* [elementHandle.executionContext()](#elementhandleexecutioncontext)
|
||
* [elementHandle.focus()](#elementhandlefocus)
|
||
* [elementHandle.getProperties()](#elementhandlegetproperties)
|
||
* [elementHandle.getProperty(propertyName)](#elementhandlegetpropertypropertyname)
|
||
* [elementHandle.hover()](#elementhandlehover)
|
||
* [elementHandle.isIntersectingViewport([options])](#elementhandleisintersectingviewportoptions)
|
||
* [elementHandle.jsonValue()](#elementhandlejsonvalue)
|
||
* [elementHandle.press(key[, options])](#elementhandlepresskey-options)
|
||
* [elementHandle.screenshot([options])](#elementhandlescreenshotoptions)
|
||
* [elementHandle.select(...values)](#elementhandleselectvalues)
|
||
* [elementHandle.tap()](#elementhandletap)
|
||
* [elementHandle.toString()](#elementhandletostring)
|
||
* [elementHandle.type(text[, options])](#elementhandletypetext-options)
|
||
* [elementHandle.uploadFile(...filePaths)](#elementhandleuploadfilefilepaths)
|
||
- [class: HTTPRequest](#class-httprequest)
|
||
* [httpRequest.abort([errorCode], [priority])](#httprequestaborterrorcode-priority)
|
||
* [httpRequest.abortErrorReason()](#httprequestaborterrorreason)
|
||
* [httpRequest.continue([overrides], [priority])](#httprequestcontinueoverrides-priority)
|
||
* [httpRequest.continueRequestOverrides()](#httprequestcontinuerequestoverrides)
|
||
* [httpRequest.enqueueInterceptAction(pendingHandler)](#httprequestenqueueinterceptactionpendinghandler)
|
||
* [httpRequest.failure()](#httprequestfailure)
|
||
* [httpRequest.finalizeInterceptions()](#httprequestfinalizeinterceptions)
|
||
* [httpRequest.frame()](#httprequestframe)
|
||
* [httpRequest.headers()](#httprequestheaders)
|
||
* [httpRequest.isNavigationRequest()](#httprequestisnavigationrequest)
|
||
* [httpRequest.method()](#httprequestmethod)
|
||
* [httpRequest.postData()](#httprequestpostdata)
|
||
* [httpRequest.redirectChain()](#httprequestredirectchain)
|
||
* [httpRequest.resourceType()](#httprequestresourcetype)
|
||
* [httpRequest.respond(response, [priority])](#httprequestrespondresponse-priority)
|
||
* [httpRequest.response()](#httprequestresponse)
|
||
* [httpRequest.responseForRequest()](#httprequestresponseforrequest)
|
||
* [httpRequest.url()](#httprequesturl)
|
||
- [class: HTTPResponse](#class-httpresponse)
|
||
* [httpResponse.buffer()](#httpresponsebuffer)
|
||
* [httpResponse.frame()](#httpresponseframe)
|
||
* [httpResponse.fromCache()](#httpresponsefromcache)
|
||
* [httpResponse.fromServiceWorker()](#httpresponsefromserviceworker)
|
||
* [httpResponse.headers()](#httpresponseheaders)
|
||
* [httpResponse.json()](#httpresponsejson)
|
||
* [httpResponse.ok()](#httpresponseok)
|
||
* [httpResponse.remoteAddress()](#httpresponseremoteaddress)
|
||
* [httpResponse.request()](#httpresponserequest)
|
||
* [httpResponse.securityDetails()](#httpresponsesecuritydetails)
|
||
* [httpResponse.status()](#httpresponsestatus)
|
||
* [httpResponse.statusText()](#httpresponsestatustext)
|
||
* [httpResponse.text()](#httpresponsetext)
|
||
* [httpResponse.url()](#httpresponseurl)
|
||
- [class: SecurityDetails](#class-securitydetails)
|
||
* [securityDetails.issuer()](#securitydetailsissuer)
|
||
* [securityDetails.protocol()](#securitydetailsprotocol)
|
||
* [securityDetails.subjectAlternativeNames()](#securitydetailssubjectalternativenames)
|
||
* [securityDetails.subjectName()](#securitydetailssubjectname)
|
||
* [securityDetails.validFrom()](#securitydetailsvalidfrom)
|
||
* [securityDetails.validTo()](#securitydetailsvalidto)
|
||
- [class: Target](#class-target)
|
||
* [target.browser()](#targetbrowser)
|
||
* [target.browserContext()](#targetbrowsercontext)
|
||
* [target.createCDPSession()](#targetcreatecdpsession)
|
||
* [target.opener()](#targetopener)
|
||
* [target.page()](#targetpage)
|
||
* [target.type()](#targettype)
|
||
* [target.url()](#targeturl)
|
||
* [target.worker()](#targetworker)
|
||
- [class: CDPSession](#class-cdpsession)
|
||
* [cdpSession.connection()](#cdpsessionconnection)
|
||
* [cdpSession.detach()](#cdpsessiondetach)
|
||
* [cdpSession.send(method[, ...paramArgs])](#cdpsessionsendmethod-paramargs)
|
||
- [class: Coverage](#class-coverage)
|
||
* [coverage.startCSSCoverage([options])](#coveragestartcsscoverageoptions)
|
||
* [coverage.startJSCoverage([options])](#coveragestartjscoverageoptions)
|
||
* [coverage.stopCSSCoverage()](#coveragestopcsscoverage)
|
||
* [coverage.stopJSCoverage()](#coveragestopjscoverage)
|
||
- [class: TimeoutError](#class-timeouterror)
|
||
- [class: EventEmitter](#class-eventemitter)
|
||
* [eventEmitter.addListener(event, handler)](#eventemitteraddlistenerevent-handler)
|
||
* [eventEmitter.emit(event, [eventData])](#eventemitteremitevent-eventdata)
|
||
* [eventEmitter.listenerCount(event)](#eventemitterlistenercountevent)
|
||
* [eventEmitter.off(event, handler)](#eventemitteroffevent-handler)
|
||
* [eventEmitter.on(event, handler)](#eventemitteronevent-handler)
|
||
* [eventEmitter.once(event, handler)](#eventemitteronceevent-handler)
|
||
* [eventEmitter.removeAllListeners([event])](#eventemitterremovealllistenersevent)
|
||
* [eventEmitter.removeListener(event, handler)](#eventemitterremovelistenerevent-handler)
|
||
- [interface: CustomQueryHandler](#interface-customqueryhandler)
|
||
<!-- GEN:stop -->
|
||
|
||
<!-- prettier-ignore-end -->
|
||
|
||
### Overview
|
||
|
||
Puppeteer is a Node library which provides a high-level API to control Chromium or Chrome over the DevTools Protocol.
|
||
|
||
The Puppeteer API is hierarchical and mirrors the browser structure.
|
||
|
||
> **NOTE** On the following diagram, faded entities are not currently represented in Puppeteer.
|
||
|
||
|
||
|
||
- [`Puppeteer`](#class-puppeteer) communicates with the browser using [DevTools Protocol](https://chromedevtools.github.io/devtools-protocol/).
|
||
- [`Browser`](#class-browser) instance can own multiple browser contexts.
|
||
- [`BrowserContext`](#class-browsercontext) instance defines a browsing session and can own multiple pages.
|
||
- [`Page`](#class-page) has at least one frame: main frame. There might be other frames created by [iframe](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe) or [frame](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/frame) tags.
|
||
- [`Frame`](#class-frame) has at least one execution context - the default execution context - where the frame's JavaScript is executed. A Frame might have additional execution contexts that are associated with [extensions](https://developer.chrome.com/extensions).
|
||
- [`Worker`](#class-worker) has a single execution context and facilitates interacting with [WebWorkers](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API).
|
||
|
||
(Diagram source: [link](https://docs.google.com/drawings/d/1Q_AM6KYs9kbyLZF-Lpp5mtpAWth73Cq8IKCsWYgi8MM/edit?usp=sharing))
|
||
|
||
### puppeteer vs puppeteer-core
|
||
|
||
Every release since v1.7.0 we publish two packages:
|
||
|
||
- [puppeteer](https://www.npmjs.com/package/puppeteer)
|
||
- [puppeteer-core](https://www.npmjs.com/package/puppeteer-core)
|
||
|
||
`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.
|
||
|
||
`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 and disregards all the `PUPPETEER_*` env variables.
|
||
|
||
To sum up, the only differences between `puppeteer-core` and `puppeteer` are:
|
||
|
||
- `puppeteer-core` doesn't automatically download Chromium when installed.
|
||
- `puppeteer-core` ignores all `PUPPETEER_*` env variables.
|
||
|
||
In most cases, you'll be fine using the `puppeteer` package.
|
||
|
||
However, you should use `puppeteer-core` if:
|
||
|
||
- you're building another end-user product or library atop of DevTools protocol. For example, one might build a PDF generator using `puppeteer-core` and write a custom `install.js` script that downloads [`headless_shell`](https://chromium.googlesource.com/chromium/src/+/lkgr/headless/README.md) instead of Chromium to save disk space.
|
||
- you're bundling Puppeteer to use in Chrome Extension / browser with the DevTools protocol where downloading an additional Chromium binary is unnecessary.
|
||
- you're building a set of tools where `puppeteer-core` is one of the ingredients and you want to postpone `install.js` script execution until Chromium is about to be used.
|
||
|
||
When using `puppeteer-core`, remember to change the _include_ line:
|
||
|
||
```js
|
||
const puppeteer = require('puppeteer-core');
|
||
```
|
||
|
||
You will then need to call [`puppeteer.connect([options])`](#puppeteerconnectoptions) or [`puppeteer.launch([options])`](#puppeteerlaunchoptions) with an explicit `executablePath` or `channel` option.
|
||
|
||
### Environment Variables
|
||
|
||
Puppeteer looks for certain [environment variables](https://en.wikipedia.org/wiki/Environment_variable) to aid its operations.
|
||
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_SKIP_CHROMIUM_DOWNLOAD` - do not download bundled Chromium during installation step.
|
||
- `PUPPETEER_DOWNLOAD_HOST` - overwrite 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` - overwrite the path for the downloads folder. Defaults to `<root>/.local-chromium`, where `<root>` is Puppeteer's package root.
|
||
- `PUPPETEER_CHROMIUM_REVISION` - specify a certain version of Chromium you'd like Puppeteer to use. See [puppeteer.launch([options])](#puppeteerlaunchoptions) on how executable path is inferred. **BEWARE**: Puppeteer is only [guaranteed to work](https://github.com/puppeteer/puppeteer/#q-why-doesnt-puppeteer-vxxx-work-with-chromium-vyyy) with the bundled Chromium, use at your own risk.
|
||
- `PUPPETEER_EXECUTABLE_PATH` - specify an executable path to be used in `puppeteer.launch`. See [puppeteer.launch([options])](#puppeteerlaunchoptions) on how the executable path is inferred. **BEWARE**: Puppeteer is only [guaranteed to work](https://github.com/puppeteer/puppeteer/#q-why-doesnt-puppeteer-vxxx-work-with-chromium-vyyy) with the bundled Chromium, use at your own risk.
|
||
- `PUPPETEER_PRODUCT` - specify which browser you'd like Puppeteer to use. Must be one of `chrome` or `firefox`. This can also be used during installation to fetch the recommended browser binary. Setting `product` programmatically in [puppeteer.launch([options])](#puppeteerlaunchoptions) supersedes this environment variable. The product is exposed in [`puppeteer.product`](#puppeteerproduct)
|
||
|
||
> **NOTE** `PUPPETEER_*` env variables are not accounted for in the [`puppeteer-core`](https://www.npmjs.com/package/puppeteer-core) package.
|
||
|
||
### Working with Chrome Extensions
|
||
|
||
Puppeteer can be used for testing Chrome Extensions.
|
||
|
||
> **NOTE** Extensions in Chrome / Chromium currently only work in non-headless mode.
|
||
|
||
The following is code for getting a handle to the [background page](https://developer.chrome.com/extensions/background_pages) of an extension whose source is located in `./my-extension`:
|
||
|
||
```js
|
||
const puppeteer = require('puppeteer');
|
||
|
||
(async () => {
|
||
const pathToExtension = require('path').join(__dirname, 'my-extension');
|
||
const browser = await puppeteer.launch({
|
||
headless: false,
|
||
args: [
|
||
`--disable-extensions-except=${pathToExtension}`,
|
||
`--load-extension=${pathToExtension}`,
|
||
],
|
||
});
|
||
const targets = await browser.targets();
|
||
const backgroundPageTarget = targets.find(
|
||
(target) => target.type() === 'background_page'
|
||
);
|
||
const backgroundPage = await backgroundPageTarget.page();
|
||
// Test the background page as you would any other page.
|
||
await browser.close();
|
||
})();
|
||
```
|
||
|
||
> **NOTE** It is not yet possible to test extension popups or content scripts.
|
||
|
||
### class: Puppeteer
|
||
|
||
Puppeteer module provides a method to launch a Chromium instance.
|
||
The following is a typical example of using Puppeteer to drive automation:
|
||
|
||
```js
|
||
const puppeteer = require('puppeteer');
|
||
|
||
(async () => {
|
||
const browser = await puppeteer.launch();
|
||
const page = await browser.newPage();
|
||
await page.goto('https://www.google.com');
|
||
// other actions...
|
||
await browser.close();
|
||
})();
|
||
```
|
||
|
||
#### puppeteer.clearCustomQueryHandlers()
|
||
|
||
Clears all registered handlers.
|
||
|
||
#### puppeteer.connect(options)
|
||
|
||
- `options` <[Object]>
|
||
- `browserWSEndpoint` <?[string]> a [browser websocket endpoint](#browserwsendpoint) to connect to.
|
||
- `browserURL` <?[string]> a browser URL to connect to, in format `http://${host}:${port}`. Use interchangeably with `browserWSEndpoint` to let Puppeteer fetch it from [metadata endpoint](https://chromedevtools.github.io/devtools-protocol/#how-do-i-access-the-browser-target).
|
||
- `ignoreHTTPSErrors` <[boolean]> Whether to ignore HTTPS errors during navigation. Defaults to `false`.
|
||
- `defaultViewport` <?[Object]> Sets a consistent viewport for each page. Defaults to an 800x600 viewport. `null` disables the default viewport.
|
||
- `width` <[number]> page width in pixels.
|
||
- `height` <[number]> page height in pixels.
|
||
- `deviceScaleFactor` <[number]> Specify device scale factor (can be thought of as DPR). Defaults to `1`.
|
||
- `isMobile` <[boolean]> Whether the `meta viewport` tag is taken into account. Defaults to `false`.
|
||
- `hasTouch`<[boolean]> Specifies if viewport supports touch events. Defaults to `false`
|
||
- `isLandscape` <[boolean]> Specifies if viewport is in landscape mode. Defaults to `false`.
|
||
- `slowMo` <[number]> Slows down Puppeteer operations by the specified amount of milliseconds. Useful so that you can see what is going on.
|
||
- `transport` <[ConnectionTransport]> **Experimental** Specify a custom transport object for Puppeteer to use.
|
||
- `product` <[string]> Possible values are: `chrome`, `firefox`. Defaults to `chrome`.
|
||
- `targetFilter` <?[function]\([Protocol.Target.TargetInfo]\):[boolean]> Use this function to decide if Puppeteer should connect to the given target. If a `targetFilter` is provided, Puppeteer only connects to targets for which `targetFilter` returns `true`. By default, Puppeteer connects to all available targets.
|
||
- returns: <[Promise]<[Browser]>>
|
||
|
||
This methods attaches Puppeteer to an existing browser instance.
|
||
|
||
#### puppeteer.createBrowserFetcher([options])
|
||
|
||
- `options` <[Object]>
|
||
- `host` <[string]> A download host to be used. Defaults to `https://storage.googleapis.com`. If the `product` is `firefox`, this defaults to `https://archive.mozilla.org/pub/firefox/nightly/latest-mozilla-central`.
|
||
- `path` <[string]> A path for the downloads folder. Defaults to `<root>/.local-chromium`, where `<root>` is Puppeteer's package root. If the `product` is `firefox`, this defaults to `<root>/.local-firefox`.
|
||
- `platform` <"linux"|"mac"|"win32"|"win64"> [string] for the current platform. Possible values are: `mac`, `win32`, `win64`, `linux`. Defaults to the current platform.
|
||
- `product` <"chrome"|"firefox"> [string] for the product to run. Possible values are: `chrome`, `firefox`. Defaults to `chrome`.
|
||
- returns: <[BrowserFetcher]>
|
||
|
||
#### puppeteer.customQueryHandlerNames()
|
||
|
||
- returns: <[Array]<string>> A list with the names of all registered custom query handlers.
|
||
|
||
#### puppeteer.defaultArgs([options])
|
||
|
||
- `options` <[Object]> Set of configurable options to set on the browser. Can have the following fields:
|
||
- `headless` <[boolean]> Whether to run browser in [headless mode](https://developers.google.com/web/updates/2017/04/headless-chrome). Defaults to `true` unless the `devtools` option is `true`.
|
||
- `args` <[Array]<[string]>> Additional arguments to pass to the browser instance. The list of Chromium flags can be found [here](http://peter.sh/experiments/chromium-command-line-switches/).
|
||
- `userDataDir` <[string]> Path to a [User Data Directory](https://chromium.googlesource.com/chromium/src/+/refs/heads/main/docs/user_data_dir.md).
|
||
- `devtools` <[boolean]> Whether to auto-open a DevTools panel for each tab. If this option is `true`, the `headless` option will be set `false`.
|
||
- returns: <[Array]<[string]>>
|
||
|
||
The default flags that Chromium will be launched with.
|
||
|
||
#### puppeteer.devices
|
||
|
||
- returns: <[Object]>
|
||
|
||
Returns a list of devices to be used with [`page.emulate(options)`](#pageemulateoptions). Actual list of
|
||
devices can be found in [`src/common/DeviceDescriptors.ts`](https://github.com/puppeteer/puppeteer/blob/main/src/common/DeviceDescriptors.ts).
|
||
|
||
```js
|
||
const puppeteer = require('puppeteer');
|
||
const iPhone = puppeteer.devices['iPhone 6'];
|
||
|
||
(async () => {
|
||
const browser = await puppeteer.launch();
|
||
const page = await browser.newPage();
|
||
await page.emulate(iPhone);
|
||
await page.goto('https://www.google.com');
|
||
// other actions...
|
||
await browser.close();
|
||
})();
|
||
```
|
||
|
||
#### puppeteer.errors
|
||
|
||
- returns: <[Object]>
|
||
- `TimeoutError` <[function]> A class of [TimeoutError].
|
||
|
||
Puppeteer methods might throw errors if they are unable to fulfill a request. For example, [page.waitForSelector(selector[, options])](#pagewaitforselectorselector-options)
|
||
might fail if the selector doesn't match any nodes during the given timeframe.
|
||
|
||
For certain types of errors Puppeteer uses specific error classes.
|
||
These classes are available via [`puppeteer.errors`](#puppeteererrors)
|
||
|
||
An example of handling a timeout error:
|
||
|
||
```js
|
||
try {
|
||
await page.waitForSelector('.foo');
|
||
} catch (e) {
|
||
if (e instanceof puppeteer.errors.TimeoutError) {
|
||
// Do something if this is a timeout.
|
||
}
|
||
}
|
||
```
|
||
|
||
> **NOTE** The old way (Puppeteer versions <= v1.14.0) errors can be obtained with `require('puppeteer/Errors')`.
|
||
|
||
#### puppeteer.executablePath()
|
||
|
||
- returns: <[string]> A path where Puppeteer expects to find the bundled browser. The browser binary might not be there if the download was skipped with [`PUPPETEER_SKIP_CHROMIUM_DOWNLOAD`](#environment-variables).
|
||
|
||
> **NOTE** `puppeteer.executablePath()` is affected by the `PUPPETEER_EXECUTABLE_PATH` and `PUPPETEER_CHROMIUM_REVISION` env variables. See [Environment Variables](#environment-variables) for details.
|
||
|
||
#### puppeteer.launch([options])
|
||
|
||
- `options` <[Object]> Set of configurable options to set on the browser. Can have the following fields:
|
||
- `product` <[string]> Which browser to launch. At this time, this is either `chrome` or `firefox`. See also `PUPPETEER_PRODUCT`.
|
||
- `ignoreHTTPSErrors` <[boolean]> Whether to ignore HTTPS errors during navigation. Defaults to `false`.
|
||
- `headless` <[boolean]> Whether to run browser in [headless mode](https://developers.google.com/web/updates/2017/04/headless-chrome). Defaults to `true` unless the `devtools` option is `true`.
|
||
- `channel` <[string]> When specified, Puppeteer will search for the locally installed release channel of Google Chrome and use it to launch. Available values are `chrome`, `chrome-beta`, `chrome-canary`, `chrome-dev`. When channel is specified, `executablePath` cannot be specified.
|
||
- `executablePath` <[string]> Path to a browser executable to run instead of the bundled Chromium. If `executablePath` is a relative path, then it is resolved relative to [current working directory](https://nodejs.org/api/process.html#process_process_cwd). **BEWARE**: Puppeteer is only [guaranteed to work](https://github.com/puppeteer/puppeteer/#q-why-doesnt-puppeteer-vxxx-work-with-chromium-vyyy) with the bundled Chromium, use at your own risk.
|
||
- `slowMo` <[number]> Slows down Puppeteer operations by the specified amount of milliseconds. Useful so that you can see what is going on.
|
||
- `defaultViewport` <?[Object]> Sets a consistent viewport for each page. Defaults to an 800x600 viewport. `null` disables the default viewport.
|
||
- `width` <[number]> page width in pixels.
|
||
- `height` <[number]> page height in pixels.
|
||
- `deviceScaleFactor` <[number]> Specify device scale factor (can be thought of as DPR). Defaults to `1`.
|
||
- `isMobile` <[boolean]> Whether the `meta viewport` tag is taken into account. Defaults to `false`.
|
||
- `hasTouch`<[boolean]> Specifies if viewport supports touch events. Defaults to `false`
|
||
- `isLandscape` <[boolean]> Specifies if viewport is in landscape mode. Defaults to `false`.
|
||
- `args` <[Array]<[string]>> Additional arguments to pass to the browser instance. The list of Chromium flags can be found [here](http://peter.sh/experiments/chromium-command-line-switches/), and here is the list of [Firefox flags](https://developer.mozilla.org/en-US/docs/Mozilla/Command_Line_Options).
|
||
- `ignoreDefaultArgs` <[boolean]|[Array]<[string]>> If `true`, then do not use [`puppeteer.defaultArgs()`](#puppeteerdefaultargsoptions). If an array is given, then filter out the given default arguments. Dangerous option; use with care. Defaults to `false`.
|
||
- `handleSIGINT` <[boolean]> Close the browser process on Ctrl-C. Defaults to `true`.
|
||
- `handleSIGTERM` <[boolean]> Close the browser process on SIGTERM. Defaults to `true`.
|
||
- `handleSIGHUP` <[boolean]> Close the browser process on SIGHUP. Defaults to `true`.
|
||
- `timeout` <[number]> Maximum time in milliseconds to wait for the browser instance to start. Defaults to `30000` (30 seconds). Pass `0` to disable timeout.
|
||
- `dumpio` <[boolean]> Whether to pipe the browser process stdout and stderr into `process.stdout` and `process.stderr`. Defaults to `false`.
|
||
- `userDataDir` <[string]> Path to a [User Data Directory](https://chromium.googlesource.com/chromium/src/+/refs/heads/main/docs/user_data_dir.md).
|
||
- `env` <[Object]> Specify environment variables that will be visible to the browser. Defaults to `process.env`.
|
||
- `devtools` <[boolean]> Whether to auto-open a DevTools panel for each tab. If this option is `true`, the `headless` option will be set `false`.
|
||
- `pipe` <[boolean]> Connects to the browser over a pipe instead of a WebSocket. Defaults to `false`.
|
||
- `extraPrefsFirefox` <[Object]> Additional [preferences](https://searchfox.org/mozilla-release/source/modules/libpref/init/all.js) that can be passed to Firefox (see `PUPPETEER_PRODUCT`)
|
||
- `targetFilter` <?[function]\([Protocol.Target.TargetInfo]\):[boolean]> Use this function to decide if Puppeteer should connect to the given target. If a `targetFilter` is provided, Puppeteer only connects to targets for which `targetFilter` returns `true`. By default, Puppeteer connects to all available targets.
|
||
- `waitForInitialPage` <[boolean]> Whether to wait for the initial page to be ready. Defaults to `true`.
|
||
- returns: <[Promise]<[Browser]>> Promise which resolves to browser instance.
|
||
|
||
You can use `ignoreDefaultArgs` to filter out `--mute-audio` from default arguments:
|
||
|
||
```js
|
||
const browser = await puppeteer.launch({
|
||
ignoreDefaultArgs: ['--mute-audio'],
|
||
});
|
||
```
|
||
|
||
> **NOTE** Puppeteer can also be used to control the Chrome browser, but it works best with the version of Chromium it is bundled with. There is no guarantee it will work with any other version. Use `executablePath` or `channel` option with extreme caution.
|
||
>
|
||
> If Google Chrome (rather than Chromium) is preferred, a [Chrome Canary](https://www.google.com/chrome/browser/canary.html) or [Dev Channel](https://www.chromium.org/getting-involved/dev-channel) build is suggested.
|
||
>
|
||
> In [puppeteer.launch([options])](#puppeteerlaunchoptions) above, any mention of Chromium also applies to Chrome.
|
||
>
|
||
> See [`this article`](https://www.howtogeek.com/202825/what%E2%80%99s-the-difference-between-chromium-and-chrome/) for a description of the differences between Chromium and Chrome. [`This article`](https://chromium.googlesource.com/chromium/src/+/lkgr/docs/chromium_browser_vs_google_chrome.md) describes some differences for Linux users.
|
||
|
||
#### puppeteer.networkConditions
|
||
|
||
- returns: <[Object]>
|
||
|
||
Returns a list of network conditions to be used with [`page.emulateNetworkConditions(networkConditions)`](#pageemulatenetworkconditionsnetworkconditions). Actual list of
|
||
conditions can be found in [`src/common/NetworkConditions.ts`](https://github.com/puppeteer/puppeteer/blob/main/src/common/NetworkConditions.ts).
|
||
|
||
```js
|
||
const puppeteer = require('puppeteer');
|
||
const slow3G = puppeteer.networkConditions['Slow 3G'];
|
||
|
||
(async () => {
|
||
const browser = await puppeteer.launch();
|
||
const page = await browser.newPage();
|
||
await page.emulateNetworkConditions(slow3G);
|
||
await page.goto('https://www.google.com');
|
||
// other actions...
|
||
await browser.close();
|
||
})();
|
||
```
|
||
|
||
#### puppeteer.product
|
||
|
||
- returns: <[string]> returns the name of the browser that is under automation (`"chrome"` or `"firefox"`)
|
||
|
||
The product is set by the `PUPPETEER_PRODUCT` environment variable or the `product` option in [puppeteer.launch([options])](#puppeteerlaunchoptions) and defaults to `chrome`. Firefox support is experimental and requires to install Puppeteer via `PUPPETEER_PRODUCT=firefox npm i puppeteer`.
|
||
|
||
#### puppeteer.registerCustomQueryHandler(name, queryHandler)
|
||
|
||
- `name` <[string]> The name that the custom query handler will be registered under.
|
||
- `queryHandler` <[CustomQueryHandler]> The [custom query handler](#interface-customqueryhandler) to register.
|
||
|
||
Registers a [custom query handler](#interface-customqueryhandler). After registration, the handler can be used everywhere where a selector is expected by prepending the selection string with `<name>/`. The name is only allowed to consist of lower and upper case Latin letters.
|
||
|
||
Example:
|
||
|
||
```js
|
||
puppeteer.registerCustomQueryHandler('getByClass', {
|
||
queryOne: (element, selector) => {
|
||
return element.querySelector(`.${selector}`);
|
||
},
|
||
queryAll: (element, selector) => {
|
||
return element.querySelectorAll(`.${selector}`);
|
||
},
|
||
});
|
||
const aHandle = await page.$('getByClass/…');
|
||
```
|
||
|
||
#### puppeteer.unregisterCustomQueryHandler(name)
|
||
|
||
- `name` <[string]> The name of the query handler to unregister.
|
||
|
||
### class: BrowserFetcher
|
||
|
||
BrowserFetcher can download and manage different versions of Chromium and Firefox.
|
||
|
||
BrowserFetcher operates on revision strings that specify a precise version of Chromium, e.g. `"533271"`. Revision strings can be obtained from [omahaproxy.appspot.com](http://omahaproxy.appspot.com/).
|
||
|
||
In the Firefox case, BrowserFetcher downloads Firefox Nightly and operates on version numbers such as `"75"`.
|
||
|
||
An example of using BrowserFetcher to download a specific version of Chromium and running
|
||
Puppeteer against it:
|
||
|
||
```js
|
||
const browserFetcher = puppeteer.createBrowserFetcher();
|
||
const revisionInfo = await browserFetcher.download('533271');
|
||
const browser = await puppeteer.launch({
|
||
executablePath: revisionInfo.executablePath,
|
||
});
|
||
```
|
||
|
||
> **NOTE** BrowserFetcher is not designed to work concurrently with other
|
||
> instances of BrowserFetcher that share the same downloads directory.
|
||
|
||
#### browserFetcher.canDownload(revision)
|
||
|
||
- `revision` <[string]> a revision to check availability.
|
||
- returns: <[Promise]<[boolean]>> returns `true` if the revision could be downloaded from the host.
|
||
|
||
The method initiates a HEAD request to check if the revision is available.
|
||
|
||
#### browserFetcher.download(revision[, progressCallback])
|
||
|
||
- `revision` <[string]> a revision to download.
|
||
- `progressCallback` <[function]([number], [number])> A function that will be called with two arguments:
|
||
- `downloadedBytes` <[number]> how many bytes have been downloaded
|
||
- `totalBytes` <[number]> how large is the total download
|
||
- returns: <[Promise]<[Object]>> Resolves with revision information when the revision is downloaded and extracted
|
||
- `revision` <[string]> the revision the info was created from
|
||
- `folderPath` <[string]> path to the extracted revision folder
|
||
- `executablePath` <[string]> path to the revision executable
|
||
- `url` <[string]> URL this revision can be downloaded from
|
||
- `local` <[boolean]> whether the revision is locally available on disk
|
||
|
||
The method initiates a GET request to download the revision from the host.
|
||
|
||
#### browserFetcher.host()
|
||
|
||
- returns: <[string]> The download host being used.
|
||
|
||
#### browserFetcher.localRevisions()
|
||
|
||
- returns: <[Promise]<[Array]<[string]>>> A list of all revisions (for the current `product`) available locally on disk.
|
||
|
||
#### browserFetcher.platform()
|
||
|
||
- returns: <[string]> One of `mac`, `linux`, `win32` or `win64`.
|
||
|
||
#### browserFetcher.product()
|
||
|
||
- returns: <[string]> One of `chrome` or `firefox`.
|
||
|
||
#### browserFetcher.remove(revision)
|
||
|
||
- `revision` <[string]> a revision to remove for the current `product`. The method will throw if the revision has not been downloaded.
|
||
- returns: <[Promise]> Resolves when the revision has been removed.
|
||
|
||
#### browserFetcher.revisionInfo(revision)
|
||
|
||
- `revision` <[string]> a revision to get info for.
|
||
- returns: <[Object]>
|
||
- `revision` <[string]> the revision the info was created from
|
||
- `folderPath` <[string]> path to the extracted revision folder
|
||
- `executablePath` <[string]> path to the revision executable
|
||
- `url` <[string]> URL this revision can be downloaded from
|
||
- `local` <[boolean]> whether the revision is locally available on disk
|
||
- `product` <[string]> one of `chrome` or `firefox`
|
||
|
||
> **NOTE** Many BrowserFetcher methods, like `remove` and `revisionInfo`
|
||
> are affected by the choice of `product`. See [puppeteer.createBrowserFetcher([options])](#puppeteercreatebrowserfetcheroptions).
|
||
|
||
### class: Browser
|
||
|
||
- extends: [EventEmitter](#class-eventemitter)
|
||
|
||
A Browser is created when Puppeteer connects to a Chromium instance, either through [`puppeteer.launch`](#puppeteerlaunchoptions) or [`puppeteer.connect`](#puppeteerconnectoptions).
|
||
|
||
An example of using a [Browser] to create a [Page]:
|
||
|
||
```js
|
||
const puppeteer = require('puppeteer');
|
||
|
||
(async () => {
|
||
const browser = await puppeteer.launch();
|
||
const page = await browser.newPage();
|
||
await page.goto('https://example.com');
|
||
await browser.close();
|
||
})();
|
||
```
|
||
|
||
An example of disconnecting from and reconnecting to a [Browser]:
|
||
|
||
```js
|
||
const puppeteer = require('puppeteer');
|
||
|
||
(async () => {
|
||
const browser = await puppeteer.launch();
|
||
// Store the endpoint to be able to reconnect to Chromium
|
||
const browserWSEndpoint = browser.wsEndpoint();
|
||
// Disconnect puppeteer from Chromium
|
||
browser.disconnect();
|
||
|
||
// Use the endpoint to reestablish a connection
|
||
const browser2 = await puppeteer.connect({ browserWSEndpoint });
|
||
// Close Chromium
|
||
await browser2.close();
|
||
})();
|
||
```
|
||
|
||
#### event: 'disconnected'
|
||
|
||
Emitted when Puppeteer gets disconnected from the Chromium instance. This might happen because of one of the following:
|
||
|
||
- Chromium is closed or crashed
|
||
- The [`browser.disconnect`](#browserdisconnect) method was called
|
||
|
||
#### event: 'targetchanged'
|
||
|
||
- <[Target]>
|
||
|
||
Emitted when the URL of a target changes.
|
||
|
||
> **NOTE** This includes target changes in incognito browser contexts.
|
||
|
||
#### event: 'targetcreated'
|
||
|
||
- <[Target]>
|
||
|
||
Emitted when a target is created, for example when a new page is opened by [`window.open`](https://developer.mozilla.org/en-US/docs/Web/API/Window/open) or [`browser.newPage`](#browsernewpage).
|
||
|
||
> **NOTE** This includes target creations in incognito browser contexts.
|
||
|
||
#### event: 'targetdestroyed'
|
||
|
||
- <[Target]>
|
||
|
||
Emitted when a target is destroyed, for example when a page is closed.
|
||
|
||
> **NOTE** This includes target destructions in incognito browser contexts.
|
||
|
||
#### browser.browserContexts()
|
||
|
||
- returns: <[Array]<[BrowserContext]>>
|
||
|
||
Returns an array of all open browser contexts. In a newly created browser, this will return
|
||
a single instance of [BrowserContext].
|
||
|
||
#### browser.close()
|
||
|
||
- returns: <[Promise]>
|
||
|
||
Closes Chromium and all of its pages (if any were opened). The [Browser] object itself is considered to be disposed and cannot be used anymore.
|
||
|
||
During the process of closing the browser, Puppeteer attempts to delete the temp folder created exclusively for this browser instance. If this fails (either because a file in the temp folder is locked by another process or because of insufficient permissions) an error is logged. This implies that: a) the folder and/or its content is not fully deleted; and b) the connection with the browser is not properly disposed (see [browser.disconnect()](#browserdisconnect)).
|
||
|
||
#### browser.createIncognitoBrowserContext([options])
|
||
- `options` <[Object]> Set of configurable options to set on the browserContext. Can have the following fields:
|
||
- `proxyServer` <[string]> Optional proxy server with optional port to use for all requests. Username and password can be set in [page.authenticate(credentials)](#pageauthenticatecredentials).
|
||
- `proxyBypassList` <[string]> Optional: Bypass the proxy for the given semi-colon-separated list of hosts.
|
||
- returns: <[Promise]<[BrowserContext]>>
|
||
|
||
Creates a new incognito browser context. This won't share cookies/cache with other browser contexts.
|
||
|
||
```js
|
||
(async () => {
|
||
const browser = await puppeteer.launch();
|
||
// Create a new incognito browser context.
|
||
const context = await browser.createIncognitoBrowserContext();
|
||
// Create a new page in a pristine context.
|
||
const page = await context.newPage();
|
||
// Do stuff
|
||
await page.goto('https://example.com');
|
||
})();
|
||
```
|
||
|
||
#### browser.defaultBrowserContext()
|
||
|
||
- returns: <[BrowserContext]>
|
||
|
||
Returns the default browser context. The default browser context can not be closed.
|
||
|
||
#### browser.disconnect()
|
||
|
||
Disconnects Puppeteer from the browser but leaves the Chromium process running. After calling `disconnect`, the [Browser] object is considered disposed and cannot be used anymore.
|
||
|
||
#### browser.isConnected()
|
||
|
||
- returns: <[boolean]>
|
||
|
||
Indicates that the browser is connected.
|
||
|
||
#### browser.newPage()
|
||
|
||
- returns: <[Promise]<[Page]>>
|
||
|
||
Promise which resolves to a new [Page] object. The [Page] is created in a default browser context.
|
||
|
||
#### browser.pages()
|
||
|
||
- returns: <[Promise]<[Array]<[Page]>>> Promise which resolves to an array of all open pages. Non visible pages, such as `"background_page"`, will not be listed here. You can find them using [target.page()](#targetpage).
|
||
|
||
An array of all pages inside the Browser. In case of multiple browser contexts,
|
||
the method will return an array with all the pages in all browser contexts.
|
||
|
||
#### browser.process()
|
||
|
||
- returns: <?[ChildProcess]> Spawned browser process. Returns `null` if the browser instance was created with [`puppeteer.connect`](#puppeteerconnectoptions) method.
|
||
|
||
#### browser.target()
|
||
|
||
- returns: <[Target]>
|
||
|
||
A target associated with the browser.
|
||
|
||
#### browser.targets()
|
||
|
||
- returns: <[Array]<[Target]>>
|
||
|
||
An array of all active targets inside the Browser. In case of multiple browser contexts,
|
||
the method will return an array with all the targets in all browser contexts.
|
||
|
||
#### browser.userAgent()
|
||
|
||
- returns: <[Promise]<[string]>> Promise which resolves to the browser's original user agent.
|
||
|
||
> **NOTE** Pages can override browser user agent with [page.setUserAgent](#pagesetuseragentuseragent-useragentdata)
|
||
|
||
#### browser.version()
|
||
|
||
- returns: <[Promise]<[string]>> For headless Chromium, this is similar to `HeadlessChrome/61.0.3153.0`. For non-headless, this is similar to `Chrome/61.0.3153.0`.
|
||
|
||
> **NOTE** the format of browser.version() might change with future releases of Chromium.
|
||
|
||
#### browser.waitForTarget(predicate[, options])
|
||
|
||
- `predicate` <[function]\([Target]\):[boolean]> A function to be run for every target
|
||
- `options` <[Object]>
|
||
- `timeout` <[number]> Maximum wait time in milliseconds. Pass `0` to disable the timeout. Defaults to 30 seconds.
|
||
- returns: <[Promise]<[Target]>> Promise which resolves to the first target found that matches the `predicate` function.
|
||
|
||
This searches for a target in all browser contexts.
|
||
|
||
An example of finding a target for a page opened via `window.open`:
|
||
|
||
```js
|
||
await page.evaluate(() => window.open('https://www.example.com/'));
|
||
const newWindowTarget = await browser.waitForTarget(
|
||
(target) => target.url() === 'https://www.example.com/'
|
||
);
|
||
```
|
||
|
||
#### browser.wsEndpoint()
|
||
|
||
- returns: <[string]> Browser websocket URL.
|
||
|
||
Browser websocket endpoint which can be used as an argument to
|
||
[puppeteer.connect](#puppeteerconnectoptions). The format is `ws://${host}:${port}/devtools/browser/<id>`
|
||
|
||
You can find the `webSocketDebuggerUrl` from `http://${host}:${port}/json/version`. Learn more about the [devtools protocol](https://chromedevtools.github.io/devtools-protocol) and the [browser endpoint](https://chromedevtools.github.io/devtools-protocol/#how-do-i-access-the-browser-target).
|
||
|
||
### class: BrowserContext
|
||
|
||
- extends: [EventEmitter](#class-eventemitter)
|
||
|
||
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()` creates a page in the default browser context.
|
||
|
||
If a page opens another page, e.g. with a `window.open` call, the popup will belong to the parent page's browser
|
||
context.
|
||
|
||
Puppeteer allows creation of "incognito" browser contexts with `browser.createIncognitoBrowserContext()` method.
|
||
"Incognito" browser contexts don't write any browsing data to disk.
|
||
|
||
```js
|
||
// Create a new incognito browser context
|
||
const context = await browser.createIncognitoBrowserContext();
|
||
// Create a new page inside context.
|
||
const page = await context.newPage();
|
||
// ... do stuff with page ...
|
||
await page.goto('https://example.com');
|
||
// Dispose context once it's no longer needed.
|
||
await context.close();
|
||
```
|
||
|
||
#### event: 'targetchanged'
|
||
|
||
- <[Target]>
|
||
|
||
Emitted when the URL of a target inside the browser context changes.
|
||
|
||
#### event: 'targetcreated'
|
||
|
||
- <[Target]>
|
||
|
||
Emitted when a new target is created inside the browser context, for example when a new page is opened by [`window.open`](https://developer.mozilla.org/en-US/docs/Web/API/Window/open) or [`browserContext.newPage`](#browsercontextnewpage).
|
||
|
||
#### event: 'targetdestroyed'
|
||
|
||
- <[Target]>
|
||
|
||
Emitted when a target inside the browser context is destroyed, for example when a page is closed.
|
||
|
||
#### browserContext.browser()
|
||
|
||
- returns: <[Browser]>
|
||
|
||
The browser this browser context belongs to.
|
||
|
||
#### browserContext.clearPermissionOverrides()
|
||
|
||
- returns: <[Promise]>
|
||
|
||
Clears all permission overrides for the browser context.
|
||
|
||
```js
|
||
const context = browser.defaultBrowserContext();
|
||
context.overridePermissions('https://example.com', ['clipboard-read']);
|
||
// do stuff ..
|
||
context.clearPermissionOverrides();
|
||
```
|
||
|
||
#### browserContext.close()
|
||
|
||
- returns: <[Promise]>
|
||
|
||
Closes the browser context. All the targets that belong to the browser context
|
||
will be closed.
|
||
|
||
> **NOTE** only incognito browser contexts can be closed.
|
||
|
||
#### browserContext.isIncognito()
|
||
|
||
- returns: <[boolean]>
|
||
|
||
Returns whether BrowserContext is incognito.
|
||
The default browser context is the only non-incognito browser context.
|
||
|
||
> **NOTE** the default browser context cannot be closed.
|
||
|
||
#### browserContext.newPage()
|
||
|
||
- returns: <[Promise]<[Page]>>
|
||
|
||
Creates a new page in the browser context.
|
||
|
||
#### browserContext.overridePermissions(origin, permissions)
|
||
|
||
- `origin` <[string]> The [origin] to grant permissions to, e.g. "https://example.com".
|
||
- `permissions` <[Array]<[string]>> An array of permissions to grant. All permissions that are not listed here will be automatically denied. Permissions can be one of the following values:
|
||
- `'geolocation'`
|
||
- `'midi'`
|
||
- `'midi-sysex'` (system-exclusive midi)
|
||
- `'notifications'`
|
||
- `'push'`
|
||
- `'camera'`
|
||
- `'microphone'`
|
||
- `'background-sync'`
|
||
- `'ambient-light-sensor'`
|
||
- `'accelerometer'`
|
||
- `'gyroscope'`
|
||
- `'magnetometer'`
|
||
- `'accessibility-events'`
|
||
- `'clipboard-read'`
|
||
- `'clipboard-write'`
|
||
- `'payment-handler'`
|
||
- `'persistent-storage'`
|
||
- returns: <[Promise]>
|
||
|
||
```js
|
||
const context = browser.defaultBrowserContext();
|
||
await context.overridePermissions('https://html5demos.com', ['geolocation']);
|
||
```
|
||
|
||
#### browserContext.pages()
|
||
|
||
- returns: <[Promise]<[Array]<[Page]>>> Promise which resolves to an array of all open pages. Non visible pages, such as `"background_page"`, will not be listed here. You can find them using [target.page()](#targetpage).
|
||
|
||
An array of all pages inside the browser context.
|
||
|
||
#### browserContext.targets()
|
||
|
||
- returns: <[Array]<[Target]>>
|
||
|
||
An array of all active targets inside the browser context.
|
||
|
||
#### browserContext.waitForTarget(predicate[, options])
|
||
|
||
- `predicate` <[function]\([Target]\):[boolean]> A function to be run for every target
|
||
- `options` <[Object]>
|
||
- `timeout` <[number]> Maximum wait time in milliseconds. Pass `0` to disable the timeout. Defaults to 30 seconds.
|
||
- returns: <[Promise]<[Target]>> Promise which resolves to the first target found that matches the `predicate` function.
|
||
|
||
This searches for a target in this specific browser context.
|
||
|
||
An example of finding a target for a page opened via `window.open`:
|
||
|
||
```js
|
||
await page.evaluate(() => window.open('https://www.example.com/'));
|
||
const newWindowTarget = await browserContext.waitForTarget(
|
||
(target) => target.url() === 'https://www.example.com/'
|
||
);
|
||
```
|
||
|
||
### class: Page
|
||
|
||
- extends: [EventEmitter](#class-eventemitter)
|
||
|
||
Page provides methods to interact with a single tab or [extension background page](https://developer.chrome.com/extensions/background_pages) in Chromium. One [Browser] instance might have multiple [Page] instances.
|
||
|
||
This example creates a page, navigates it to a URL, and then saves a screenshot:
|
||
|
||
```js
|
||
const puppeteer = require('puppeteer');
|
||
|
||
(async () => {
|
||
const browser = await puppeteer.launch();
|
||
const page = await browser.newPage();
|
||
await page.goto('https://example.com');
|
||
await page.screenshot({ path: 'screenshot.png' });
|
||
await browser.close();
|
||
})();
|
||
```
|
||
|
||
The Page class emits various events (described below) which can be handled using
|
||
any of the [`EventEmitter`](#class-eventemitter) methods, such as `on`, `once`
|
||
or `off`.
|
||
|
||
This example logs a message for a single page `load` event:
|
||
|
||
```js
|
||
page.once('load', () => console.log('Page loaded!'));
|
||
```
|
||
|
||
To unsubscribe from events use the `off` method:
|
||
|
||
```js
|
||
function logRequest(interceptedRequest) {
|
||
console.log('A request was made:', interceptedRequest.url());
|
||
}
|
||
page.on('request', logRequest);
|
||
// Sometime later...
|
||
page.off('request', logRequest);
|
||
```
|
||
|
||
#### event: 'close'
|
||
|
||
Emitted when the page closes.
|
||
|
||
#### event: 'console'
|
||
|
||
- <[ConsoleMessage]>
|
||
|
||
Emitted when JavaScript within the page calls one of console API methods, e.g. `console.log` or `console.dir`. Also emitted if the page throws an error or a warning.
|
||
|
||
The arguments passed into `console.log` appear as arguments on the event handler.
|
||
|
||
An example of handling `console` event:
|
||
|
||
```js
|
||
page.on('console', (msg) => {
|
||
for (let i = 0; i < msg.args().length; ++i)
|
||
console.log(`${i}: ${msg.args()[i]}`);
|
||
});
|
||
page.evaluate(() => console.log('hello', 5, { foo: 'bar' }));
|
||
```
|
||
|
||
#### event: 'dialog'
|
||
|
||
- <[Dialog]>
|
||
|
||
Emitted when a JavaScript dialog appears, such as `alert`, `prompt`, `confirm` or `beforeunload`. Puppeteer can respond to the dialog via [Dialog]'s [accept](#dialogacceptprompttext) or [dismiss](#dialogdismiss) methods.
|
||
|
||
#### event: 'domcontentloaded'
|
||
|
||
Emitted when the JavaScript [`DOMContentLoaded`](https://developer.mozilla.org/en-US/docs/Web/Events/DOMContentLoaded) event is dispatched.
|
||
|
||
#### event: 'error'
|
||
|
||
- <[Error]>
|
||
|
||
Emitted when the page crashes.
|
||
|
||
> **NOTE** `error` event has a special meaning in Node, see [error events](https://nodejs.org/api/events.html#events_error_events) for details.
|
||
|
||
#### event: 'frameattached'
|
||
|
||
- <[Frame]>
|
||
|
||
Emitted when a frame is attached.
|
||
|
||
#### event: 'framedetached'
|
||
|
||
- <[Frame]>
|
||
|
||
Emitted when a frame is detached.
|
||
|
||
#### event: 'framenavigated'
|
||
|
||
- <[Frame]>
|
||
|
||
Emitted when a frame is navigated to a new URL.
|
||
|
||
#### event: 'load'
|
||
|
||
Emitted when the JavaScript [`load`](https://developer.mozilla.org/en-US/docs/Web/Events/load) event is dispatched.
|
||
|
||
#### event: 'metrics'
|
||
|
||
- <[Object]>
|
||
- `title` <[string]> The title passed to `console.timeStamp`.
|
||
- `metrics` <[Object]> Object containing metrics as key/value pairs. The values
|
||
of metrics are of <[number]> type.
|
||
|
||
Emitted when the JavaScript code makes a call to `console.timeStamp`. For the list
|
||
of metrics see `page.metrics`.
|
||
|
||
#### event: 'pageerror'
|
||
|
||
- <[Error]> The exception message
|
||
|
||
Emitted when an uncaught exception happens within the page.
|
||
|
||
#### event: 'popup'
|
||
|
||
- <[Page]> Page corresponding to "popup" window
|
||
|
||
Emitted when the page opens a new tab or window.
|
||
|
||
```js
|
||
const [popup] = await Promise.all([
|
||
new Promise((resolve) => page.once('popup', resolve)),
|
||
page.click('a[target=_blank]'),
|
||
]);
|
||
```
|
||
|
||
```js
|
||
const [popup] = await Promise.all([
|
||
new Promise((resolve) => page.once('popup', resolve)),
|
||
page.evaluate(() => window.open('https://example.com')),
|
||
]);
|
||
```
|
||
|
||
#### event: 'request'
|
||
|
||
- <[HTTPRequest]>
|
||
|
||
Emitted when a page issues a request. The [HTTPRequest] object is read-only.
|
||
In order to intercept and mutate requests, see `page.setRequestInterception`.
|
||
|
||
#### event: 'requestfailed'
|
||
|
||
- <[HTTPRequest]>
|
||
|
||
Emitted when a request fails, for example by timing out.
|
||
|
||
> **NOTE** HTTP Error responses, such as 404 or 503, are still successful responses from HTTP standpoint, so request will complete with [`'requestfinished'`](#event-requestfinished) event and not with [`'requestfailed'`](#event-requestfailed).
|
||
|
||
#### event: 'requestfinished'
|
||
|
||
- <[HTTPRequest]>
|
||
|
||
Emitted when a request finishes successfully.
|
||
|
||
#### event: 'response'
|
||
|
||
- <[HTTPResponse]>
|
||
|
||
Emitted when a [HTTPResponse] is received.
|
||
|
||
#### event: 'workercreated'
|
||
|
||
- <[WebWorker]>
|
||
|
||
Emitted when a dedicated [WebWorker](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API) is spawned by the page.
|
||
|
||
#### event: 'workerdestroyed'
|
||
|
||
- <[WebWorker]>
|
||
|
||
Emitted when a dedicated [WebWorker](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API) is terminated.
|
||
|
||
#### page.$(selector)
|
||
|
||
- `selector` <[string]> A [selector] to query page for
|
||
- returns: <[Promise]<?[ElementHandle]>>
|
||
|
||
The method runs `document.querySelector` within the page. If no element matches the selector, the return value resolves to `null`.
|
||
|
||
Shortcut for [page.mainFrame().$(selector)](#frameselector).
|
||
|
||
#### page.$$(selector)
|
||
|
||
- `selector` <[string]> A [selector] to query page for
|
||
- returns: <[Promise]<[Array]<[ElementHandle]>>>
|
||
|
||
The method runs `document.querySelectorAll` within the page. If no elements match the selector, the return value resolves to `[]`.
|
||
|
||
Shortcut for [page.mainFrame().$$(selector)](#frameselector-1).
|
||
|
||
#### page.$$eval(selector, pageFunction[, ...args])
|
||
|
||
- `selector` <[string]> A [selector] to query page for
|
||
- `pageFunction` <[function]\([Array]<[Element]>\)> Function to be evaluated in browser context
|
||
- `...args` <...[Serializable]|[JSHandle]> Arguments to pass to `pageFunction`
|
||
- returns: <[Promise]<[Serializable]>> Promise which resolves to the return value of `pageFunction`
|
||
|
||
This method runs `Array.from(document.querySelectorAll(selector))` within the page and passes it as the first argument to `pageFunction`.
|
||
|
||
If `pageFunction` returns a [Promise], then `page.$$eval` would wait for the promise to resolve and return its value.
|
||
|
||
Examples:
|
||
|
||
```js
|
||
const divCount = await page.$$eval('div', (divs) => divs.length);
|
||
```
|
||
|
||
```js
|
||
const options = await page.$$eval('div > span.options', (options) =>
|
||
options.map((option) => option.textContent)
|
||
);
|
||
```
|
||
|
||
#### page.$eval(selector, pageFunction[, ...args])
|
||
|
||
- `selector` <[string]> A [selector] to query page for
|
||
- `pageFunction` <[function]\([Element]\)> Function to be evaluated in browser context
|
||
- `...args` <...[Serializable]|[JSHandle]> Arguments to pass to `pageFunction`
|
||
- returns: <[Promise]<[Serializable]>> Promise which resolves to the return value of `pageFunction`
|
||
|
||
This method runs `document.querySelector` within the page and passes it as the first argument to `pageFunction`. If there's no element matching `selector`, the method throws an error.
|
||
|
||
If `pageFunction` returns a [Promise], then `page.$eval` would wait for the promise to resolve and return its value.
|
||
|
||
Examples:
|
||
|
||
```js
|
||
const searchValue = await page.$eval('#search', (el) => el.value);
|
||
const preloadHref = await page.$eval('link[rel=preload]', (el) => el.href);
|
||
const html = await page.$eval('.main-container', (e) => e.outerHTML);
|
||
```
|
||
|
||
Shortcut for [page.mainFrame().$eval(selector, pageFunction)](#frameevalselector-pagefunction-args).
|
||
|
||
#### page.$x(expression)
|
||
|
||
- `expression` <[string]> Expression to [evaluate](https://developer.mozilla.org/en-US/docs/Web/API/Document/evaluate).
|
||
- returns: <[Promise]<[Array]<[ElementHandle]>>>
|
||
|
||
The method evaluates the XPath expression relative to the page document as its context node. If there are no such elements, the method resolves to an empty array.
|
||
|
||
Shortcut for [page.mainFrame().$x(expression)](#framexexpression)
|
||
|
||
#### page.accessibility
|
||
|
||
- returns: <[Accessibility]>
|
||
|
||
#### page.addScriptTag(options)
|
||
|
||
- `options` <[Object]>
|
||
- `url` <[string]> URL of a script to be added.
|
||
- `path` <[string]> Path to the JavaScript file to be injected into frame. If `path` is a relative path, then it is resolved relative to [current working directory](https://nodejs.org/api/process.html#process_process_cwd).
|
||
- `content` <[string]> Raw JavaScript content to be injected into frame.
|
||
- `type` <[string]> Script type. Use 'module' in order to load a Javascript ES6 module. See [script](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/script) for more details.
|
||
- `id` <[string]> id attribute to add to the script tag.
|
||
- returns: <[Promise]<[ElementHandle]>> which resolves to the added tag when the script's onload fires or when the script content was injected into frame.
|
||
|
||
Adds a `<script>` tag into the page with the desired URL or content.
|
||
|
||
Shortcut for [page.mainFrame().addScriptTag(options)](#frameaddscripttagoptions).
|
||
|
||
#### page.addStyleTag(options)
|
||
|
||
- `options` <[Object]>
|
||
- `url` <[string]> URL of the `<link>` tag.
|
||
- `path` <[string]> Path to the CSS file to be injected into frame. If `path` is a relative path, then it is resolved relative to [current working directory](https://nodejs.org/api/process.html#process_process_cwd).
|
||
- `content` <[string]> Raw CSS content to be injected into frame.
|
||
- returns: <[Promise]<[ElementHandle]>> which resolves to the added tag when the stylesheet's onload fires or when the CSS content was injected into frame.
|
||
|
||
Adds a `<link rel="stylesheet">` tag into the page with the desired URL or a `<style type="text/css">` tag with the content.
|
||
|
||
Shortcut for [page.mainFrame().addStyleTag(options)](#frameaddstyletagoptions).
|
||
|
||
#### page.authenticate(credentials)
|
||
|
||
- `credentials` <?[Object]>
|
||
- `username` <[string]>
|
||
- `password` <[string]>
|
||
- returns: <[Promise]>
|
||
|
||
Provide credentials for [HTTP authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication).
|
||
|
||
To disable authentication, pass `null`.
|
||
|
||
#### page.bringToFront()
|
||
|
||
- returns: <[Promise]>
|
||
|
||
Brings page to front (activates tab).
|
||
|
||
#### page.browser()
|
||
|
||
- returns: <[Browser]>
|
||
|
||
Get the browser the page belongs to.
|
||
|
||
#### page.browserContext()
|
||
|
||
- returns: <[BrowserContext]>
|
||
|
||
Get the browser context that the page belongs to.
|
||
|
||
#### page.click(selector[, options])
|
||
|
||
- `selector` <[string]> A [selector] to search for element to click. If there are multiple elements satisfying the selector, the first will be clicked.
|
||
- `options` <[Object]>
|
||
- `button` <"left"|"right"|"middle"> Defaults to `left`.
|
||
- `clickCount` <[number]> defaults to 1. See [UIEvent.detail].
|
||
- `delay` <[number]> Time to wait between `mousedown` and `mouseup` in milliseconds. Defaults to 0.
|
||
- returns: <[Promise]> Promise which resolves when the element matching `selector` is successfully clicked. The Promise will be rejected if there is no element matching `selector`.
|
||
|
||
This method fetches an element with `selector`, scrolls it into view if needed, and then uses [page.mouse](#pagemouse) to click in the center of the element.
|
||
If there's no element matching `selector`, the method throws an error.
|
||
|
||
Bear in mind that if `click()` triggers a navigation event and there's a separate `page.waitForNavigation()` promise to be resolved, you may end up with a race condition that yields unexpected results. The correct pattern for click and wait for navigation is the following:
|
||
|
||
```js
|
||
const [response] = await Promise.all([
|
||
page.waitForNavigation(waitOptions),
|
||
page.click(selector, clickOptions),
|
||
]);
|
||
```
|
||
|
||
Shortcut for [page.mainFrame().click(selector[, options])](#frameclickselector-options).
|
||
|
||
#### page.close([options])
|
||
|
||
- `options` <[Object]>
|
||
- `runBeforeUnload` <[boolean]> Defaults to `false`. Whether to run the
|
||
[before unload](https://developer.mozilla.org/en-US/docs/Web/Events/beforeunload)
|
||
page handlers.
|
||
- returns: <[Promise]>
|
||
|
||
By default, `page.close()` **does not** run beforeunload handlers.
|
||
|
||
> **NOTE** if `runBeforeUnload` is passed as true, a `beforeunload` dialog might be summoned
|
||
> and should be handled manually via page's ['dialog'](#event-dialog) event.
|
||
|
||
#### page.content()
|
||
|
||
- returns: <[Promise]<[string]>>
|
||
|
||
Gets the full HTML contents of the page, including the doctype.
|
||
|
||
#### page.cookies([...urls])
|
||
|
||
- `...urls` <...[string]>
|
||
- returns: <[Promise]<[Array]<[Object]>>>
|
||
- `name` <[string]>
|
||
- `value` <[string]>
|
||
- `domain` <[string]>
|
||
- `path` <[string]>
|
||
- `expires` <[number]> Unix time in seconds.
|
||
- `size` <[number]>
|
||
- `httpOnly` <[boolean]>
|
||
- `secure` <[boolean]>
|
||
- `session` <[boolean]>
|
||
- `sameSite` <"Strict"|"Lax"|"Extended"|"None">
|
||
|
||
If no URLs are specified, this method returns cookies for the current page URL.
|
||
If URLs are specified, only cookies for those URLs are returned.
|
||
|
||
#### page.coverage
|
||
|
||
- returns: <[Coverage]>
|
||
|
||
#### page.createPDFStream([options])
|
||
|
||
- `options` <[Object]> Options object which might have the following properties:
|
||
- `path` <[string]> The file path to save the PDF to. If `path` is a relative path, then it is resolved relative to [current working directory](https://nodejs.org/api/process.html#process_process_cwd). If no path is provided, the PDF won't be saved to the disk.
|
||
- `scale` <[number]> Scale of the webpage rendering. Defaults to `1`. Scale amount must be between 0.1 and 2.
|
||
- `displayHeaderFooter` <[boolean]> Display header and footer. Defaults to `false`.
|
||
- `headerTemplate` <[string]> HTML template for the print header. Should be valid HTML markup with following classes used to inject printing values into them:
|
||
- `date` formatted print date
|
||
- `title` document title
|
||
- `url` document location
|
||
- `pageNumber` current page number
|
||
- `totalPages` total pages in the document
|
||
- `footerTemplate` <[string]> HTML template for the print footer. Should use the same format as the `headerTemplate`.
|
||
- `printBackground` <[boolean]> Print background graphics. Defaults to `false`.
|
||
- `landscape` <[boolean]> Paper orientation. Defaults to `false`.
|
||
- `pageRanges` <[string]> Paper ranges to print, e.g., '1-5, 8, 11-13'. Defaults to the empty string, which means print all pages.
|
||
- `format` <[string]> Paper format. If set, takes priority over `width` or `height` options. Defaults to 'Letter'.
|
||
- `width` <[string]|[number]> Paper width, accepts values labeled with units.
|
||
- `height` <[string]|[number]> Paper height, accepts values labeled with units.
|
||
- `margin` <[Object]> Paper margins, defaults to none.
|
||
- `top` <[string]|[number]> Top margin, accepts values labeled with units.
|
||
- `right` <[string]|[number]> Right margin, accepts values labeled with units.
|
||
- `bottom` <[string]|[number]> Bottom margin, accepts values labeled with units.
|
||
- `left` <[string]|[number]> Left margin, accepts values labeled with units.
|
||
- `preferCSSPageSize` <[boolean]> Give any CSS `@page` size declared in the page priority over what is declared in `width` and `height` or `format` options. Defaults to `false`, which will scale the content to fit the paper size.
|
||
- `omitBackground` <[boolean]> Hides default white background and allows capturing screenshots with transparency. Defaults to `false`.
|
||
- returns: <[Promise]<[Readable]>> Promise which resolves with a Node.js stream for the PDF file.
|
||
|
||
> **NOTE** This method is identical to [page.pdf](#pagepdfoptions), except it returns the PDF as a readable stream of binary data. If you are generating very large PDFs, it may be useful to use a stream to avoid high memory usage. This version will ignore the `path` option.
|
||
|
||
```js
|
||
const puppeteer = require('puppeteer');
|
||
|
||
(async () => {
|
||
const browser = await puppeteer.launch();
|
||
const page = await browser.newPage();
|
||
|
||
// Stream a PDF into a file
|
||
const pdfStream = await page.createPDFStream();
|
||
const writeStream = fs.createWriteStream('test.pdf');
|
||
pdfStream.pipe(writeStream);
|
||
pdfStream.on('end', async () => {
|
||
await browser.close();
|
||
});
|
||
})();
|
||
```
|
||
|
||
#### page.deleteCookie(...cookies)
|
||
|
||
- `...cookies` <...[Object]>
|
||
- `name` <[string]> **required**
|
||
- `url` <[string]>
|
||
- `domain` <[string]>
|
||
- `path` <[string]>
|
||
- returns: <[Promise]>
|
||
|
||
#### page.emulate(options)
|
||
|
||
- `options` <[Object]>
|
||
- `viewport` <[Object]>
|
||
- `width` <[number]> page width in pixels.
|
||
- `height` <[number]> page height in pixels.
|
||
- `deviceScaleFactor` <[number]> Specify device scale factor (can be thought of as DPR). Defaults to `1`.
|
||
- `isMobile` <[boolean]> Whether the `meta viewport` tag is taken into account. Defaults to `false`.
|
||
- `hasTouch`<[boolean]> Specifies if viewport supports touch events. Defaults to `false`
|
||
- `isLandscape` <[boolean]> Specifies if viewport is in landscape mode. Defaults to `false`.
|
||
- `userAgent` <[string]>
|
||
- returns: <[Promise]>
|
||
|
||
Emulates given device metrics and user agent. This method is a shortcut for calling two methods:
|
||
|
||
- [page.setUserAgent(userAgent)](#pagesetuseragentuseragent-useragentdata)
|
||
- [page.setViewport(viewport)](#pagesetviewportviewport)
|
||
|
||
To aid emulation, Puppeteer provides a list of device descriptors that can be obtained via the [`puppeteer.devices`](#puppeteerdevices).
|
||
|
||
`page.emulate` will resize the page. A lot of websites don't expect phones to change size, so you should emulate before navigating to the page.
|
||
|
||
```js
|
||
const puppeteer = require('puppeteer');
|
||
const iPhone = puppeteer.devices['iPhone 6'];
|
||
|
||
(async () => {
|
||
const browser = await puppeteer.launch();
|
||
const page = await browser.newPage();
|
||
await page.emulate(iPhone);
|
||
await page.goto('https://www.google.com');
|
||
// other actions...
|
||
await browser.close();
|
||
})();
|
||
```
|
||
|
||
List of all available devices is available in the source code: [src/common/DeviceDescriptors.ts](https://github.com/puppeteer/puppeteer/blob/main/src/common/DeviceDescriptors.ts).
|
||
|
||
#### page.emulateCPUThrottling(factor)
|
||
|
||
- `factor` <?[number]> Factor at which the CPU will be throttled (2x, 2.5x. 3x, ...). Passing `null` disables cpu throttling.
|
||
- returns: <[Promise]>
|
||
|
||
> **NOTE** Real device CPU performance is impacted by many factors that are not trivial to emulate via the Chrome DevTools Protocol / Puppeteer. e.g core count, L1/L2 cache, thermal throttling impacting performance, architecture etc. Simulating CPU performance can be a good guideline, but ideally also verify any numbers you see on a real mobile device.
|
||
|
||
```js
|
||
const puppeteer = require('puppeteer');
|
||
const slow3G = puppeteer.networkConditions['Slow 3G'];
|
||
|
||
(async () => {
|
||
const browser = await puppeteer.launch();
|
||
const page = await browser.newPage();
|
||
await page.emulateCPUThrottling(2);
|
||
await page.goto('https://www.google.com');
|
||
// other actions...
|
||
await browser.close();
|
||
})();
|
||
```
|
||
|
||
#### page.emulateIdleState(overrides)
|
||
|
||
- `overrides` <?[Object]> If not set, clears emulation
|
||
- `isUserActive` <[boolean]> **required**
|
||
- `isScreenUnlocked` <[boolean]> **required**
|
||
- returns: <[Promise]>
|
||
|
||
#### page.emulateMediaFeatures(features)
|
||
|
||
- `features` <?[Array]<[Object]>> Given an array of media feature objects, emulates CSS media features on the page. Each media feature object must have the following properties:
|
||
- `name` <[string]> The CSS media feature name. Supported names are `'prefers-colors-scheme'`, `'prefers-reduced-motion'`, and `'color-gamut'`.
|
||
- `value` <[string]> The value for the given CSS media feature.
|
||
- returns: <[Promise]>
|
||
|
||
```js
|
||
await page.emulateMediaFeatures([
|
||
{ name: 'prefers-color-scheme', value: 'dark' },
|
||
]);
|
||
await page.evaluate(() => matchMedia('(prefers-color-scheme: dark)').matches);
|
||
// → true
|
||
await page.evaluate(() => matchMedia('(prefers-color-scheme: light)').matches);
|
||
// → false
|
||
|
||
await page.emulateMediaFeatures([
|
||
{ name: 'prefers-reduced-motion', value: 'reduce' },
|
||
]);
|
||
await page.evaluate(
|
||
() => matchMedia('(prefers-reduced-motion: reduce)').matches
|
||
);
|
||
// → true
|
||
await page.evaluate(
|
||
() => matchMedia('(prefers-reduced-motion: no-preference)').matches
|
||
);
|
||
// → false
|
||
|
||
await page.emulateMediaFeatures([
|
||
{ name: 'prefers-color-scheme', value: 'dark' },
|
||
{ name: 'prefers-reduced-motion', value: 'reduce' },
|
||
]);
|
||
await page.evaluate(() => matchMedia('(prefers-color-scheme: dark)').matches);
|
||
// → true
|
||
await page.evaluate(() => matchMedia('(prefers-color-scheme: light)').matches);
|
||
// → false
|
||
await page.evaluate(
|
||
() => matchMedia('(prefers-reduced-motion: reduce)').matches
|
||
);
|
||
// → true
|
||
await page.evaluate(
|
||
() => matchMedia('(prefers-reduced-motion: no-preference)').matches
|
||
);
|
||
// → false
|
||
|
||
await page.emulateMediaFeatures([{ name: 'color-gamut', value: 'p3' }]);
|
||
await page.evaluate(() => matchMedia('(color-gamut: srgb)').matches);
|
||
// → true
|
||
await page.evaluate(() => matchMedia('(color-gamut: p3)').matches);
|
||
// → true
|
||
await page.evaluate(() => matchMedia('(color-gamut: rec2020)').matches);
|
||
// → false
|
||
```
|
||
|
||
#### page.emulateMediaType(type)
|
||
|
||
- `type` <?[string]> Changes the CSS media type of the page. The only allowed values are `'screen'`, `'print'` and `null`. Passing `null` disables CSS media emulation.
|
||
- returns: <[Promise]>
|
||
|
||
```js
|
||
await page.evaluate(() => matchMedia('screen').matches);
|
||
// → true
|
||
await page.evaluate(() => matchMedia('print').matches);
|
||
// → false
|
||
|
||
await page.emulateMediaType('print');
|
||
await page.evaluate(() => matchMedia('screen').matches);
|
||
// → false
|
||
await page.evaluate(() => matchMedia('print').matches);
|
||
// → true
|
||
|
||
await page.emulateMediaType(null);
|
||
await page.evaluate(() => matchMedia('screen').matches);
|
||
// → true
|
||
await page.evaluate(() => matchMedia('print').matches);
|
||
// → false
|
||
```
|
||
|
||
#### page.emulateNetworkConditions(networkConditions)
|
||
|
||
- `networkConditions` <?[Object]> Passing `null` disables network condition emulation.
|
||
- `download` <[number]> Download speed (bytes/s), `-1` to disable
|
||
- `upload` <[number]> Upload speed (bytes/s), `-1` to disable
|
||
- `latency` <[number]> Latency (ms), `0` to disable
|
||
- returns: <[Promise]>
|
||
|
||
> **NOTE** This does not affect WebSockets and WebRTC PeerConnections (see https://crbug.com/563644). To set the page offline, you can use [page.setOfflineMode(enabled)](#pagesetofflinemodeenabled).
|
||
|
||
```js
|
||
const puppeteer = require('puppeteer');
|
||
const slow3G = puppeteer.networkConditions['Slow 3G'];
|
||
|
||
(async () => {
|
||
const browser = await puppeteer.launch();
|
||
const page = await browser.newPage();
|
||
await page.emulateNetworkConditions(slow3G);
|
||
await page.goto('https://www.google.com');
|
||
// other actions...
|
||
await browser.close();
|
||
})();
|
||
```
|
||
|
||
#### page.emulateTimezone(timezoneId)
|
||
|
||
- `timezoneId` <?[string]> Changes the timezone of the page. See [ICU’s `metaZones.txt`](https://cs.chromium.org/chromium/src/third_party/icu/source/data/misc/metaZones.txt?rcl=faee8bc70570192d82d2978a71e2a615788597d1) for a list of supported timezone IDs. Passing `null` disables timezone emulation.
|
||
- returns: <[Promise]>
|
||
|
||
#### page.emulateVisionDeficiency(type)
|
||
|
||
- `type` <?[string]> Simulates the given vision deficiency on the page. Supported vision deficiency types are `'achromatopsia'`, `'deuteranopia'`, `'protanopia'`, `'tritanopia'`, `'blurredVision'`, and `'none'`.
|
||
- returns: <[Promise]>
|
||
|
||
```js
|
||
const puppeteer = require('puppeteer');
|
||
|
||
(async () => {
|
||
const browser = await puppeteer.launch();
|
||
const page = await browser.newPage();
|
||
await page.goto('https://v8.dev/blog/10-years');
|
||
|
||
await page.emulateVisionDeficiency('achromatopsia');
|
||
await page.screenshot({ path: 'achromatopsia.png' });
|
||
|
||
await page.emulateVisionDeficiency('deuteranopia');
|
||
await page.screenshot({ path: 'deuteranopia.png' });
|
||
|
||
await page.emulateVisionDeficiency('blurredVision');
|
||
await page.screenshot({ path: 'blurred-vision.png' });
|
||
|
||
await browser.close();
|
||
})();
|
||
```
|
||
|
||
#### page.evaluate(pageFunction[, ...args])
|
||
|
||
- `pageFunction` <[function]|[string]> Function to be evaluated in the page context
|
||
- `...args` <...[Serializable]|[JSHandle]> Arguments to pass to `pageFunction`
|
||
- returns: <[Promise]<[Serializable]>> Promise which resolves to the return value of `pageFunction`
|
||
|
||
If the function passed to the `page.evaluate` returns a [Promise], then `page.evaluate` would wait for the promise to resolve and return its value.
|
||
|
||
If the function passed to the `page.evaluate` returns a non-[Serializable] value, then `page.evaluate` resolves to `undefined`. DevTools Protocol also supports transferring some additional values that are not serializable by `JSON`: `-0`, `NaN`, `Infinity`, `-Infinity`, and bigint literals.
|
||
|
||
Passing arguments to `pageFunction`:
|
||
|
||
```js
|
||
const result = await page.evaluate((x) => {
|
||
return Promise.resolve(8 * x);
|
||
}, 7);
|
||
console.log(result); // prints "56"
|
||
```
|
||
|
||
A string can also be passed in instead of a function:
|
||
|
||
```js
|
||
console.log(await page.evaluate('1 + 2')); // prints "3"
|
||
const x = 10;
|
||
console.log(await page.evaluate(`1 + ${x}`)); // prints "11"
|
||
```
|
||
|
||
[ElementHandle] instances can be passed as arguments to the `page.evaluate`:
|
||
|
||
```js
|
||
const bodyHandle = await page.$('body');
|
||
const html = await page.evaluate((body) => body.innerHTML, bodyHandle);
|
||
await bodyHandle.dispose();
|
||
```
|
||
|
||
Shortcut for [page.mainFrame().evaluate(pageFunction, ...args)](#frameevaluatepagefunction-args).
|
||
|
||
#### page.evaluateHandle(pageFunction[, ...args])
|
||
|
||
- `pageFunction` <[function]|[string]> Function to be evaluated in the page context
|
||
- `...args` <...[Serializable]|[JSHandle]> Arguments to pass to `pageFunction`
|
||
- returns: <[Promise]<[JSHandle]|[ElementHandle]>> Promise which resolves to the return value of `pageFunction` as an in-page object.
|
||
|
||
The only difference between `page.evaluate` and `page.evaluateHandle` is that `page.evaluateHandle` returns in-page object (JSHandle).
|
||
|
||
If the function passed to the `page.evaluateHandle` returns a [Promise], then `page.evaluateHandle` would wait for the promise to resolve and return its value.
|
||
|
||
A string can also be passed in instead of a function:
|
||
|
||
```js
|
||
const aHandle = await page.evaluateHandle('document'); // Handle for the 'document'
|
||
```
|
||
|
||
[JSHandle] instances can be passed as arguments to the `page.evaluateHandle`:
|
||
|
||
```js
|
||
const aHandle = await page.evaluateHandle(() => document.body);
|
||
const resultHandle = await page.evaluateHandle(
|
||
(body) => body.innerHTML,
|
||
aHandle
|
||
);
|
||
console.log(await resultHandle.jsonValue());
|
||
await resultHandle.dispose();
|
||
```
|
||
|
||
This function will return a [JSHandle] by default, however if your `pageFunction` returns an HTML element you will get back an `ElementHandle`:
|
||
|
||
```js
|
||
const button = await page.evaluateHandle(() =>
|
||
document.querySelector('button')
|
||
);
|
||
// button is an ElementHandle, so you can call methods such as click:
|
||
await button.click();
|
||
```
|
||
|
||
Shortcut for [page.mainFrame().executionContext().evaluateHandle(pageFunction, ...args)](#executioncontextevaluatehandlepagefunction-args).
|
||
|
||
#### page.evaluateOnNewDocument(pageFunction[, ...args])
|
||
|
||
- `pageFunction` <[function]|[string]> Function to be evaluated in browser context
|
||
- `...args` <...[Serializable]> Arguments to pass to `pageFunction`
|
||
- returns: <[Promise]>
|
||
|
||
Adds a function which would be invoked in one of the following scenarios:
|
||
|
||
- whenever the page is navigated
|
||
- whenever the child frame is attached or navigated. In this case, the function is invoked in the context of the newly attached frame
|
||
|
||
The function is invoked after the document was created but before any of its scripts were run. This is useful to amend the JavaScript environment, e.g. to seed `Math.random`.
|
||
|
||
An example of overriding the navigator.languages property before the page loads:
|
||
|
||
```js
|
||
// preload.js
|
||
|
||
// overwrite the `languages` property to use a custom getter
|
||
Object.defineProperty(navigator, 'languages', {
|
||
get: function () {
|
||
return ['en-US', 'en', 'bn'];
|
||
},
|
||
});
|
||
|
||
// In your puppeteer script, assuming the preload.js file is in same folder of our script
|
||
const preloadFile = fs.readFileSync('./preload.js', 'utf8');
|
||
await page.evaluateOnNewDocument(preloadFile);
|
||
```
|
||
|
||
#### page.exposeFunction(name, puppeteerFunction)
|
||
|
||
- `name` <[string]> Name of the function on the window object
|
||
- `puppeteerFunction` <[function]> Callback function which will be called in Puppeteer's context.
|
||
- returns: <[Promise]>
|
||
|
||
The method adds a function called `name` on the page's `window` object.
|
||
When called, the function executes `puppeteerFunction` in node.js and returns a [Promise] which resolves to the return value of `puppeteerFunction`.
|
||
|
||
If the `puppeteerFunction` returns a [Promise], it will be awaited.
|
||
|
||
> **NOTE** Functions installed via `page.exposeFunction` survive navigations.
|
||
|
||
An example of adding an `md5` function into the page:
|
||
|
||
```js
|
||
const puppeteer = require('puppeteer');
|
||
const crypto = require('crypto');
|
||
|
||
(async () => {
|
||
const browser = await puppeteer.launch();
|
||
const page = await browser.newPage();
|
||
page.on('console', (msg) => console.log(msg.text()));
|
||
await page.exposeFunction('md5', (text) =>
|
||
crypto.createHash('md5').update(text).digest('hex')
|
||
);
|
||
await page.evaluate(async () => {
|
||
// use window.md5 to compute hashes
|
||
const myString = 'PUPPETEER';
|
||
const myHash = await window.md5(myString);
|
||
console.log(`md5 of ${myString} is ${myHash}`);
|
||
});
|
||
await browser.close();
|
||
})();
|
||
```
|
||
|
||
An example of adding a `window.readfile` function into the page:
|
||
|
||
```js
|
||
const puppeteer = require('puppeteer');
|
||
const fs = require('fs');
|
||
|
||
(async () => {
|
||
const browser = await puppeteer.launch();
|
||
const page = await browser.newPage();
|
||
page.on('console', (msg) => console.log(msg.text()));
|
||
await page.exposeFunction('readfile', async (filePath) => {
|
||
return new Promise((resolve, reject) => {
|
||
fs.readFile(filePath, 'utf8', (err, text) => {
|
||
if (err) reject(err);
|
||
else resolve(text);
|
||
});
|
||
});
|
||
});
|
||
await page.evaluate(async () => {
|
||
// use window.readfile to read contents of a file
|
||
const content = await window.readfile('/etc/hosts');
|
||
console.log(content);
|
||
});
|
||
await browser.close();
|
||
})();
|
||
```
|
||
|
||
#### page.focus(selector)
|
||
|
||
- `selector` <[string]> A [selector] of an element to focus. If there are multiple elements satisfying the selector, the first will be focused.
|
||
- returns: <[Promise]> Promise which resolves when the element matching `selector` is successfully focused. The promise will be rejected if there is no element matching `selector`.
|
||
|
||
This method fetches an element with `selector` and focuses it.
|
||
If there's no element matching `selector`, the method throws an error.
|
||
|
||
Shortcut for [page.mainFrame().focus(selector)](#framefocusselector).
|
||
|
||
#### page.frames()
|
||
|
||
- returns: <[Array]<[Frame]>> An array of all frames attached to the page.
|
||
|
||
#### page.goBack([options])
|
||
|
||
- `options` <[Object]> Navigation parameters which might have the following properties:
|
||
- `timeout` <[number]> Maximum navigation time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed by using the [page.setDefaultNavigationTimeout(timeout)](#pagesetdefaultnavigationtimeouttimeout) or [page.setDefaultTimeout(timeout)](#pagesetdefaulttimeouttimeout) methods.
|
||
- `waitUntil` <"load"|"domcontentloaded"|"networkidle0"|"networkidle2"|Array<PuppeteerLifeCycleMethod>> When to consider navigation succeeded, defaults to `load`. Given an array of event strings, navigation is considered to be successful after all events have been fired. Events can be either:
|
||
- `load` - consider navigation to be finished when the `load` event is fired.
|
||
- `domcontentloaded` - consider navigation to be finished when the `DOMContentLoaded` event is fired.
|
||
- `networkidle0` - consider navigation to be finished when there are no more than 0 network connections for at least `500` ms.
|
||
- `networkidle2` - consider navigation to be finished when there are no more than 2 network connections for at least `500` ms.
|
||
- returns: <[Promise]<?[HTTPResponse]>> Promise which resolves to the main resource response. In case of multiple redirects, the navigation will resolve with the response of the last redirect. If
|
||
can not go back, resolves to `null`.
|
||
|
||
Navigate to the previous page in history.
|
||
|
||
#### page.goForward([options])
|
||
|
||
- `options` <[Object]> Navigation parameters which might have the following properties:
|
||
- `timeout` <[number]> Maximum navigation time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed by using the [page.setDefaultNavigationTimeout(timeout)](#pagesetdefaultnavigationtimeouttimeout) or [page.setDefaultTimeout(timeout)](#pagesetdefaulttimeouttimeout) methods.
|
||
- `waitUntil` <"load"|"domcontentloaded"|"networkidle0"|"networkidle2"|Array<PuppeteerLifeCycleMethod>> When to consider navigation succeeded, defaults to `load`. Given an array of event strings, navigation is considered to be successful after all events have been fired. Events can be either:
|
||
- `load` - consider navigation to be finished when the `load` event is fired.
|
||
- `domcontentloaded` - consider navigation to be finished when the `DOMContentLoaded` event is fired.
|
||
- `networkidle0` - consider navigation to be finished when there are no more than 0 network connections for at least `500` ms.
|
||
- `networkidle2` - consider navigation to be finished when there are no more than 2 network connections for at least `500` ms.
|
||
- returns: <[Promise]<?[HTTPResponse]>> Promise which resolves to the main resource response. In case of multiple redirects, the navigation will resolve with the response of the last redirect. If
|
||
can not go forward, resolves to `null`.
|
||
|
||
Navigate to the next page in history.
|
||
|
||
#### page.goto(url[, options])
|
||
|
||
- `url` <[string]> URL to navigate page to. The URL should include scheme, e.g. `https://`.
|
||
- `options` <[Object]> Navigation parameters which might have the following properties:
|
||
- `timeout` <[number]> Maximum navigation time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed by using the [page.setDefaultNavigationTimeout(timeout)](#pagesetdefaultnavigationtimeouttimeout) or [page.setDefaultTimeout(timeout)](#pagesetdefaulttimeouttimeout) methods.
|
||
- `waitUntil` <"load"|"domcontentloaded"|"networkidle0"|"networkidle2"|Array<PuppeteerLifeCycleMethod>> When to consider navigation succeeded, defaults to `load`. Given an array of event strings, navigation is considered to be successful after all events have been fired. Events can be either:
|
||
- `load` - consider navigation to be finished when the `load` event is fired.
|
||
- `domcontentloaded` - consider navigation to be finished when the `DOMContentLoaded` event is fired.
|
||
- `networkidle0` - consider navigation to be finished when there are no more than 0 network connections for at least `500` ms.
|
||
- `networkidle2` - consider navigation to be finished when there are no more than 2 network connections for at least `500` ms.
|
||
- `referer` <[string]> Referer header value. If provided it will take preference over the referer header value set by [page.setExtraHTTPHeaders()](#pagesetextrahttpheadersheaders).
|
||
- returns: <[Promise]<?[HTTPResponse]>> Promise which resolves to the main resource response. In case of multiple redirects, the navigation will resolve with the response of the last redirect.
|
||
|
||
`page.goto` will throw an error if:
|
||
|
||
- there's an SSL error (e.g. in case of self-signed certificates).
|
||
- target URL is invalid.
|
||
- the `timeout` is exceeded during navigation.
|
||
- the remote server does not respond or is unreachable.
|
||
- the main resource failed to load.
|
||
|
||
`page.goto` will not throw an error when any valid HTTP status code is returned by the remote server, including 404 "Not Found" and 500 "Internal Server Error". The status code for such responses can be retrieved by calling [response.status()](#httpresponsestatus).
|
||
|
||
> **NOTE** `page.goto` either throws an error or returns a main resource response. The only exceptions are navigation to `about:blank` or navigation to the same URL with a different hash, which would succeed and return `null`.
|
||
|
||
> **NOTE** Headless mode doesn't support navigation to a PDF document. See the [upstream issue](https://bugs.chromium.org/p/chromium/issues/detail?id=761295).
|
||
|
||
Shortcut for [page.mainFrame().goto(url, options)](#framegotourl-options)
|
||
|
||
#### page.hover(selector)
|
||
|
||
- `selector` <[string]> A [selector] to search for element to hover. If there are multiple elements satisfying the selector, the first will be hovered.
|
||
- returns: <[Promise]> Promise which resolves when the element matching `selector` is successfully hovered. Promise gets rejected if there's no element matching `selector`.
|
||
|
||
This method fetches an element with `selector`, scrolls it into view if needed, and then uses [page.mouse](#pagemouse) to hover over the center of the element.
|
||
If there's no element matching `selector`, the method throws an error.
|
||
|
||
Shortcut for [page.mainFrame().hover(selector)](#framehoverselector).
|
||
|
||
#### page.isClosed()
|
||
|
||
- returns: <[boolean]>
|
||
|
||
Indicates that the page has been closed.
|
||
|
||
#### page.isDragInterceptionEnabled()
|
||
|
||
- returns: <[boolean]>
|
||
|
||
Indicates that drag events are being intercepted.
|
||
|
||
#### page.isJavaScriptEnabled()
|
||
|
||
- returns: <[boolean]>
|
||
|
||
Returns `true` if the page has JavaScript enabled, `false` otherwise.
|
||
|
||
#### page.keyboard
|
||
|
||
- returns: <[Keyboard]>
|
||
|
||
#### page.mainFrame()
|
||
|
||
- returns: <[Frame]> The page's main frame.
|
||
|
||
Page is guaranteed to have a main frame which persists during navigations.
|
||
|
||
#### page.metrics()
|
||
|
||
- returns: <[Promise]<[Object]>> Object containing metrics as key/value pairs.
|
||
- `Timestamp` <[number]> The timestamp when the metrics sample was taken.
|
||
- `Documents` <[number]> Number of documents in the page.
|
||
- `Frames` <[number]> Number of frames in the page.
|
||
- `JSEventListeners` <[number]> Number of events in the page.
|
||
- `Nodes` <[number]> Number of DOM nodes in the page.
|
||
- `LayoutCount` <[number]> Total number of full or partial page layout.
|
||
- `RecalcStyleCount` <[number]> Total number of page style recalculations.
|
||
- `LayoutDuration` <[number]> Combined durations of all page layouts.
|
||
- `RecalcStyleDuration` <[number]> Combined duration of all page style recalculations.
|
||
- `ScriptDuration` <[number]> Combined duration of JavaScript execution.
|
||
- `TaskDuration` <[number]> Combined duration of all tasks performed by the browser.
|
||
- `JSHeapUsedSize` <[number]> Used JavaScript heap size.
|
||
- `JSHeapTotalSize` <[number]> Total JavaScript heap size.
|
||
|
||
> **NOTE** All timestamps are in monotonic time: monotonically increasing time in seconds since an arbitrary point in the past.
|
||
|
||
#### page.mouse
|
||
|
||
- returns: <[Mouse]>
|
||
|
||
#### page.pdf([options])
|
||
|
||
- `options` <[Object]> Options object which might have the following properties:
|
||
- `path` <[string]> The file path to save the PDF to. If `path` is a relative path, then it is resolved relative to [current working directory](https://nodejs.org/api/process.html#process_process_cwd). If no path is provided, the PDF won't be saved to the disk.
|
||
- `scale` <[number]> Scale of the webpage rendering. Defaults to `1`. Scale amount must be between 0.1 and 2.
|
||
- `displayHeaderFooter` <[boolean]> Display header and footer. Defaults to `false`.
|
||
- `headerTemplate` <[string]> HTML template for the print header. Should be valid HTML markup with following classes used to inject printing values into them:
|
||
- `date` formatted print date
|
||
- `title` document title
|
||
- `url` document location
|
||
- `pageNumber` current page number
|
||
- `totalPages` total pages in the document
|
||
- `footerTemplate` <[string]> HTML template for the print footer. Should use the same format as the `headerTemplate`.
|
||
- `printBackground` <[boolean]> Print background graphics. Defaults to `false`.
|
||
- `landscape` <[boolean]> Paper orientation. Defaults to `false`.
|
||
- `pageRanges` <[string]> Paper ranges to print, e.g., '1-5, 8, 11-13'. Defaults to the empty string, which means print all pages.
|
||
- `format` <[string]> Paper format. If set, takes priority over `width` or `height` options. Defaults to 'Letter'.
|
||
- `width` <[string]|[number]> Paper width, accepts values labeled with units.
|
||
- `height` <[string]|[number]> Paper height, accepts values labeled with units.
|
||
- `margin` <[Object]> Paper margins, defaults to none.
|
||
- `top` <[string]|[number]> Top margin, accepts values labeled with units.
|
||
- `right` <[string]|[number]> Right margin, accepts values labeled with units.
|
||
- `bottom` <[string]|[number]> Bottom margin, accepts values labeled with units.
|
||
- `left` <[string]|[number]> Left margin, accepts values labeled with units.
|
||
- `preferCSSPageSize` <[boolean]> Give any CSS `@page` size declared in the page priority over what is declared in `width` and `height` or `format` options. Defaults to `false`, which will scale the content to fit the paper size.
|
||
- `omitBackground` <[boolean]> Hides default white background and allows capturing screenshots with transparency. Defaults to `false`.
|
||
- `timeout` <[number]> Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout.
|
||
- returns: <[Promise]<[Buffer]>> Promise which resolves with PDF buffer.
|
||
|
||
> **NOTE** Generating a pdf is currently only supported in Chrome headless.
|
||
|
||
`page.pdf()` generates a pdf of the page with `print` CSS media. To generate a pdf with `screen` media, call [page.emulateMediaType('screen')](#pageemulatemediatypetype) before calling `page.pdf()`:
|
||
|
||
> **NOTE** By default, `page.pdf()` generates a pdf with modified colors for printing. Use the [`-webkit-print-color-adjust`](https://developer.mozilla.org/en-US/docs/Web/CSS/-webkit-print-color-adjust) property to force rendering of exact colors.
|
||
|
||
> **NOTE** If you are generating very large PDFs, it may be useful to use the streaming version of this function ([page.createPDFStream](#pagecreatepdfstreamoptions)) to avoid high memory usage.
|
||
|
||
```js
|
||
// Generates a PDF with 'screen' media type.
|
||
await page.emulateMediaType('screen');
|
||
await page.pdf({ path: 'page.pdf' });
|
||
```
|
||
|
||
The `width`, `height`, and `margin` options accept values labeled with units. Unlabeled values are treated as pixels.
|
||
|
||
A few examples:
|
||
|
||
- `page.pdf({ width: 100 })` - prints with width set to 100 pixels
|
||
- `page.pdf({ width: '100px' })` - prints with width set to 100 pixels
|
||
- `page.pdf({ width: '10cm' })` - prints with width set to 10 centimeters.
|
||
|
||
All possible units are:
|
||
|
||
- `px` - pixel
|
||
- `in` - inch
|
||
- `cm` - centimeter
|
||
- `mm` - millimeter
|
||
|
||
The `format` options are:
|
||
|
||
- `Letter`: 8.5in x 11in
|
||
- `Legal`: 8.5in x 14in
|
||
- `Tabloid`: 11in x 17in
|
||
- `Ledger`: 17in x 11in
|
||
- `A0`: 33.1in x 46.8in
|
||
- `A1`: 23.4in x 33.1in
|
||
- `A2`: 16.54in x 23.4in
|
||
- `A3`: 11.7in x 16.54in
|
||
- `A4`: 8.27in x 11.7in
|
||
- `A5`: 5.83in x 8.27in
|
||
- `A6`: 4.13in x 5.83in
|
||
|
||
> **NOTE** `headerTemplate` and `footerTemplate` markup have the following limitations:
|
||
>
|
||
> 1. Script tags inside templates are not evaluated.
|
||
> 2. Page styles are not visible inside templates.
|
||
|
||
#### page.queryObjects(prototypeHandle)
|
||
|
||
- `prototypeHandle` <[JSHandle]> A handle to the object prototype.
|
||
- returns: <[Promise]<[JSHandle]>> Promise which resolves to a handle to an array of objects with this prototype.
|
||
|
||
The method iterates the JavaScript heap and finds all the objects with the given prototype.
|
||
|
||
```js
|
||
// Create a Map object
|
||
await page.evaluate(() => (window.map = new Map()));
|
||
// Get a handle to the Map object prototype
|
||
const mapPrototype = await page.evaluateHandle(() => Map.prototype);
|
||
// Query all map instances into an array
|
||
const mapInstances = await page.queryObjects(mapPrototype);
|
||
// Count amount of map objects in heap
|
||
const count = await page.evaluate((maps) => maps.length, mapInstances);
|
||
await mapInstances.dispose();
|
||
await mapPrototype.dispose();
|
||
```
|
||
|
||
Shortcut for [page.mainFrame().executionContext().queryObjects(prototypeHandle)](#executioncontextqueryobjectsprototypehandle).
|
||
|
||
#### page.reload([options])
|
||
|
||
- `options` <[Object]> Navigation parameters which might have the following properties:
|
||
- `timeout` <[number]> Maximum navigation time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed by using the [page.setDefaultNavigationTimeout(timeout)](#pagesetdefaultnavigationtimeouttimeout) or [page.setDefaultTimeout(timeout)](#pagesetdefaulttimeouttimeout) methods.
|
||
- `waitUntil` <"load"|"domcontentloaded"|"networkidle0"|"networkidle2"|Array<PuppeteerLifeCycleMethod>> When to consider navigation succeeded, defaults to `load`. Given an array of event strings, navigation is considered to be successful after all events have been fired. Events can be either:
|
||
- `load` - consider navigation to be finished when the `load` event is fired.
|
||
- `domcontentloaded` - consider navigation to be finished when the `DOMContentLoaded` event is fired.
|
||
- `networkidle0` - consider navigation to be finished when there are no more than 0 network connections for at least `500` ms.
|
||
- `networkidle2` - consider navigation to be finished when there are no more than 2 network connections for at least `500` ms.
|
||
- returns: <[Promise]<[HTTPResponse]>> Promise which resolves to the main resource response. In case of multiple redirects, the navigation will resolve with the response of the last redirect.
|
||
|
||
#### page.screenshot([options])
|
||
|
||
- `options` <[Object]> Options object which might have the following properties:
|
||
- `path` <[string]> The file path to save the image to. The screenshot type will be inferred from file extension. If `path` is a relative path, then it is resolved relative to [current working directory](https://nodejs.org/api/process.html#process_process_cwd). If no path is provided, the image won't be saved to the disk.
|
||
- `type` <[string]> Specify screenshot type, can be either `jpeg`, `png` or `webp`. Defaults to 'png'.
|
||
- `quality` <[number]> The quality of the image, between 0-100. Not applicable to `png` images.
|
||
- `fullPage` <[boolean]> When true, takes a screenshot of the full scrollable page. Defaults to `false`.
|
||
- `clip` <[Object]> An object which specifies clipping region of the page. Should have the following fields:
|
||
- `x` <[number]> x-coordinate of top-left corner of clip area
|
||
- `y` <[number]> y-coordinate of top-left corner of clip area
|
||
- `width` <[number]> width of clipping area
|
||
- `height` <[number]> height of clipping area
|
||
- `omitBackground` <[boolean]> Hides default white background and allows capturing screenshots with transparency. Defaults to `false`.
|
||
- `encoding` <[string]> The encoding of the image, can be either `base64` or `binary`. Defaults to `binary`.
|
||
- `captureBeyondViewport` <[boolean]> When true, captures screenshot [beyond the viewport](https://chromedevtools.github.io/devtools-protocol/tot/Page/#method-captureScreenshot). Whe false, falls back to old behaviour, and cuts the screenshot by the viewport size. Defaults to `true`.
|
||
- returns: <[Promise]<[string]|[Buffer]>> Promise which resolves to buffer or a base64 string (depending on the value of `encoding`) with captured screenshot.
|
||
|
||
> **NOTE** Screenshots take at least 1/6 second on OS X. See https://crbug.com/741689 for discussion.
|
||
|
||
#### page.select(selector, ...values)
|
||
|
||
- `selector` <[string]> A [selector] to query page for
|
||
- `...values` <...[string]> Values of options to select. If the `<select>` has the `multiple` attribute, all values are considered, otherwise only the first one is taken into account.
|
||
- returns: <[Promise]<[Array]<[string]>>> An array of option values that have been successfully selected.
|
||
|
||
Triggers a `change` and `input` event once all the provided options have been selected.
|
||
If there's no `<select>` element matching `selector`, the method throws an error.
|
||
|
||
```js
|
||
page.select('select#colors', 'blue'); // single selection
|
||
page.select('select#colors', 'red', 'green', 'blue'); // multiple selections
|
||
```
|
||
|
||
Shortcut for [page.mainFrame().select()](#frameselectselector-values)
|
||
|
||
#### page.setBypassCSP(enabled)
|
||
|
||
- `enabled` <[boolean]> sets bypassing of page's Content-Security-Policy.
|
||
- returns: <[Promise]>
|
||
|
||
Toggles bypassing page's Content-Security-Policy.
|
||
|
||
> **NOTE** CSP bypassing happens at the moment of CSP initialization rather than evaluation. Usually, this means
|
||
> that `page.setBypassCSP` should be called before navigating to the domain.
|
||
|
||
#### page.setCacheEnabled([enabled])
|
||
|
||
- `enabled` <[boolean]> sets the `enabled` state of the cache.
|
||
- returns: <[Promise]>
|
||
|
||
Toggles ignoring cache for each request based on the enabled state. By default, caching is enabled.
|
||
|
||
#### page.setContent(html[, options])
|
||
|
||
- `html` <[string]> HTML markup to assign to the page.
|
||
- `options` <[Object]> Parameters that might have the following properties:
|
||
- `timeout` <[number]> Maximum time in milliseconds for resources to load, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed by using the [page.setDefaultNavigationTimeout(timeout)](#pagesetdefaultnavigationtimeouttimeout) or [page.setDefaultTimeout(timeout)](#pagesetdefaulttimeouttimeout) methods.
|
||
- `waitUntil` <"load"|"domcontentloaded"|"networkidle0"|"networkidle2"|Array<PuppeteerLifeCycleMethod>> When to consider setting markup succeeded, defaults to `load`. Given an array of event strings, setting content is considered to be successful after all events have been fired. Events can be either:
|
||
- `load` - consider setting content to be finished when the `load` event is fired.
|
||
- `domcontentloaded` - consider setting content to be finished when the `DOMContentLoaded` event is fired.
|
||
- `networkidle0` - consider setting content to be finished when there are no more than 0 network connections for at least `500` ms.
|
||
- `networkidle2` - consider setting content to be finished when there are no more than 2 network connections for at least `500` ms.
|
||
- returns: <[Promise]>
|
||
|
||
#### page.setCookie(...cookies)
|
||
|
||
- `...cookies` <...[Object]>
|
||
- `name` <[string]> **required**
|
||
- `value` <[string]> **required**
|
||
- `url` <[string]>
|
||
- `domain` <[string]>
|
||
- `path` <[string]>
|
||
- `expires` <[number]> Unix time in seconds.
|
||
- `httpOnly` <[boolean]>
|
||
- `secure` <[boolean]>
|
||
- `sameSite` <"Strict"|"Lax">
|
||
- returns: <[Promise]>
|
||
|
||
```js
|
||
await page.setCookie(cookieObject1, cookieObject2);
|
||
```
|
||
|
||
#### page.setDefaultNavigationTimeout(timeout)
|
||
|
||
- `timeout` <[number]> Maximum navigation time in milliseconds
|
||
|
||
This setting will change the default maximum navigation time for the following methods and related shortcuts:
|
||
|
||
- [page.goBack([options])](#pagegobackoptions)
|
||
- [page.goForward([options])](#pagegoforwardoptions)
|
||
- [page.goto(url[, options])](#pagegotourl-options)
|
||
- [page.reload([options])](#pagereloadoptions)
|
||
- [page.setContent(html[, options])](#pagesetcontenthtml-options)
|
||
- [page.waitForNavigation([options])](#pagewaitfornavigationoptions)
|
||
|
||
> **NOTE** [`page.setDefaultNavigationTimeout`](#pagesetdefaultnavigationtimeouttimeout) takes priority over [`page.setDefaultTimeout`](#pagesetdefaulttimeouttimeout)
|
||
|
||
#### page.setDefaultTimeout(timeout)
|
||
|
||
- `timeout` <[number]> Maximum time in milliseconds
|
||
|
||
This setting will change the default maximum time for the following methods and related shortcuts:
|
||
|
||
- [page.goBack([options])](#pagegobackoptions)
|
||
- [page.goForward([options])](#pagegoforwardoptions)
|
||
- [page.goto(url[, options])](#pagegotourl-options)
|
||
- [page.reload([options])](#pagereloadoptions)
|
||
- [page.setContent(html[, options])](#pagesetcontenthtml-options)
|
||
- [page.waitFor(selectorOrFunctionOrTimeout[, options[, ...args]])](#pagewaitforselectororfunctionortimeout-options-args)
|
||
- [page.waitForFileChooser([options])](#pagewaitforfilechooseroptions)
|
||
- [page.waitForFunction(pageFunction[, options[, ...args]])](#pagewaitforfunctionpagefunction-options-args)
|
||
- [page.waitForNavigation([options])](#pagewaitfornavigationoptions)
|
||
- [page.waitForRequest(urlOrPredicate[, options])](#pagewaitforrequesturlorpredicate-options)
|
||
- [page.waitForResponse(urlOrPredicate[, options])](#pagewaitforresponseurlorpredicate-options)
|
||
- [page.waitForSelector(selector[, options])](#pagewaitforselectorselector-options)
|
||
- [page.waitForXPath(xpath[, options])](#pagewaitforxpathxpath-options)
|
||
|
||
> **NOTE** [`page.setDefaultNavigationTimeout`](#pagesetdefaultnavigationtimeouttimeout) takes priority over [`page.setDefaultTimeout`](#pagesetdefaulttimeouttimeout)
|
||
|
||
#### page.setDragInterception(enabled)
|
||
|
||
- `enabled` <[boolean]>
|
||
- returns: <[Promise]>
|
||
|
||
Enables the Input.drag methods. This provides the capability to cpature drag events emitted on the page, which can then be used to simulate drag-and-drop.
|
||
|
||
#### page.setExtraHTTPHeaders(headers)
|
||
|
||
- `headers` <[Object]> An object containing additional HTTP headers to be sent with every request. All header values must be strings.
|
||
- returns: <[Promise]>
|
||
|
||
The extra HTTP headers will be sent with every request the page initiates.
|
||
|
||
> **NOTE** All HTTP header names are lowercased. (HTTP headers are case-insensitive, so this shouldn’t impact your server code.)
|
||
|
||
> **NOTE** page.setExtraHTTPHeaders does not guarantee the order of headers in the outgoing requests.
|
||
|
||
#### page.setGeolocation(options)
|
||
|
||
- `options` <[GeolocationOptions](#geolocationoptions)>
|
||
- returns: <[Promise]>
|
||
|
||
Sets the page's geolocation.
|
||
|
||
```js
|
||
await page.setGeolocation({ latitude: 59.95, longitude: 30.31667 });
|
||
```
|
||
|
||
> **NOTE** Consider using [browserContext.overridePermissions](#browsercontextoverridepermissionsorigin-permissions) to grant permissions for the page to read its geolocation.
|
||
|
||
#### page.setJavaScriptEnabled(enabled)
|
||
|
||
- `enabled` <[boolean]> Whether or not to enable JavaScript on the page.
|
||
- returns: <[Promise]>
|
||
|
||
> **NOTE** changing this value won't affect scripts that have already been run. It will take full effect on the next [navigation](#pagegotourl-options).
|
||
|
||
#### page.setOfflineMode(enabled)
|
||
|
||
- `enabled` <[boolean]> When `true`, enables offline mode for the page.
|
||
- returns: <[Promise]>
|
||
|
||
> **NOTE** while this method sets the network connection to offline, it does not change the parameters used in [page.emulateNetworkConditions(networkConditions)](#pageemulatenetworkconditionsnetworkconditions).
|
||
|
||
#### page.setRequestInterception(value)
|
||
|
||
- `value` <[boolean]> Whether to enable request interception.
|
||
- returns: <[Promise]>
|
||
|
||
Activating request interception enables `request.abort`, `request.continue` and `request.respond` methods. This provides the capability to modify network requests that are made by a page.
|
||
|
||
Once request interception is enabled, every request will stall unless it's continued, responded or aborted.
|
||
|
||
An example of a naïve request interceptor that aborts all image requests:
|
||
|
||
```js
|
||
const puppeteer = require('puppeteer');
|
||
|
||
(async () => {
|
||
const browser = await puppeteer.launch();
|
||
const page = await browser.newPage();
|
||
await page.setRequestInterception(true);
|
||
page.on('request', (interceptedRequest) => {
|
||
if (
|
||
interceptedRequest.url().endsWith('.png') ||
|
||
interceptedRequest.url().endsWith('.jpg')
|
||
)
|
||
interceptedRequest.abort();
|
||
else interceptedRequest.continue();
|
||
});
|
||
await page.goto('https://example.com');
|
||
await browser.close();
|
||
})();
|
||
```
|
||
|
||
##### Cooperative Intercept Mode and Legacy Intercept Mode
|
||
|
||
`request.respond`, `request.abort`, and `request.continue` can accept an optional `priority` to activate Cooperative Intercept Mode. In Cooperative Mode, all intercept handlers are guaranteed to run and all async handlers are awaited. The interception is resolved to the highest-priority resolution. Here are the rules of Cooperative Mode:
|
||
|
||
- Async handlers finish before intercept resolution is finalized.
|
||
- The highest priority interception resolution "wins", i.e. the interception is ultimately aborted/responded/continued according to which resolution was given the highest priority.
|
||
- In the event of a tie, `abort` > `respond` > `continue`.
|
||
|
||
For standardization, when specifying a Cooperative Mode priority use `0` unless you have a clear reason to use a higher priority. This gracefully prefers `respond` over `continue` and `abort` over `respond`. If you do intentionally want to use a different priority, higher priorities win over lower priorities. Negative priorities are allowed. For example, `continue({}, 4)` would win over `continue({}, -2)`.
|
||
|
||
To preserve backward compatibility, any handler resolving the intercept without specifying `priority` (Legacy Mode) causes immediate resolution. For Cooperative Mode to work, all resolutions must use a `priority`.
|
||
|
||
In this example, Legacy Mode prevails and the request is aborted immediately because at least one handler omits `priority` when resolving the intercept:
|
||
|
||
```ts
|
||
// Final outcome: immediate abort()
|
||
page.setRequestInterception(true);
|
||
page.on('request', (request) => {
|
||
// Legacy Mode: interception is aborted immediately.
|
||
request.abort('failed');
|
||
});
|
||
page.on('request', (request) => {
|
||
// ['already-handled'], meaning a legacy resolution has taken place
|
||
console.log(request.interceptResolution());
|
||
|
||
// Cooperative Mode: votes for continue at priority 0.
|
||
// Ultimately throws an exception after all handlers have finished
|
||
// running and Cooperative Mode resolutions are evaluated becasue
|
||
// abort() was called using Legacy Mode.
|
||
request.continue({}, 0);
|
||
});
|
||
```
|
||
|
||
In this example, Legacy Mode prevails and the request is continued because at least one handler does not specify a `priority`:
|
||
|
||
```ts
|
||
// Final outcome: immediate continue()
|
||
page.setRequestInterception(true);
|
||
page.on('request', (request) => {
|
||
// Cooperative Mode: votes to abort at priority 0.
|
||
// Ultimately throws an exception after all handlers have finished
|
||
// running and Cooperative Mode resolutions are evaluated becasue
|
||
// continue() was called using Legacy Mode.
|
||
request.abort('failed', 0);
|
||
});
|
||
page.on('request', (request) => {
|
||
// ['abort', 0], meaning an abort @ 0 is the current winning resolution
|
||
console.log(request.interceptResolution());
|
||
|
||
// Legacy Mode: intercept continues immediately.
|
||
request.continue({});
|
||
});
|
||
```
|
||
|
||
In this example, Cooperative Mode is active because all handlers specify a `priority`. `continue()` wins because it has a higher priority than `abort()`.
|
||
|
||
```ts
|
||
// Final outcome: cooperative continue() @ 5
|
||
page.setRequestInterception(true);
|
||
page.on('request', (request) => {
|
||
// Cooperative Mode: votes to abort at priority 10
|
||
request.abort('failed', 0);
|
||
});
|
||
page.on('request', (request) => {
|
||
// Cooperative Mode: votes to continue at priority 5
|
||
request.continue(request.continueRequestOverrides(), 5);
|
||
});
|
||
page.on('request', (request) => {
|
||
// ['continue', 5], because continue @ 5 > abort @ 0
|
||
console.log(request.interceptResolution());
|
||
});
|
||
```
|
||
|
||
In this example, Cooperative Mode is active because all handlers specify `priority`. `respond()` wins because its priority ties with `continue()`, but `respond()` beats `continue()`.
|
||
|
||
```ts
|
||
// Final outcome: cooperative respond() @ 15
|
||
page.setRequestInterception(true);
|
||
page.on('request', (request) => {
|
||
// Cooperative Mode: votes to abort at priority 10
|
||
request.abort('failed', 10);
|
||
});
|
||
page.on('request', (request) => {
|
||
// Cooperative Mode: votes to continue at priority 15
|
||
request.continue(request.continueRequestOverrides(), 15);
|
||
});
|
||
page.on('request', (request) => {
|
||
// Cooperative Mode: votes to respond at priority 15
|
||
request.respond(request.responseForRequest(), 15);
|
||
});
|
||
page.on('request', (request) => {
|
||
// Cooperative Mode: votes to respond at priority 12
|
||
request.respond(request.responseForRequest(), 12);
|
||
});
|
||
page.on('request', (request) => {
|
||
// ['respond', 15], because respond @ 15 > continue @ 15 > respond @ 12 > abort @ 10
|
||
console.log(request.interceptResolution());
|
||
});
|
||
```
|
||
|
||
##### Upgrading to Cooperative Mode for package maintainers
|
||
|
||
If you are package maintainer and your package uses intercept handlers, you can update your intercept handlers to use Cooperative Mode. Suppose you have the following existing handler:
|
||
|
||
```ts
|
||
page.on('request', (interceptedRequest) => {
|
||
if (
|
||
interceptedRequest.url().endsWith('.png') ||
|
||
interceptedRequest.url().endsWith('.jpg')
|
||
)
|
||
interceptedRequest.abort();
|
||
else interceptedRequest.continue();
|
||
});
|
||
```
|
||
|
||
To use Cooperative Mode, upgrade `continue()` and `abort()`:
|
||
|
||
```ts
|
||
page.on('request', (interceptedRequest) => {
|
||
if (
|
||
interceptedRequest.url().endsWith('.png') ||
|
||
interceptedRequest.url().endsWith('.jpg')
|
||
)
|
||
interceptedRequest.abort('failed', 0);
|
||
else
|
||
interceptedRequest.continue(
|
||
interceptedRequest.continueRequestOverrides(),
|
||
0
|
||
);
|
||
});
|
||
```
|
||
|
||
With those simple upgrades, your handler now uses Cooperative Mode instead.
|
||
|
||
However, we recommend a slightly more robust solution because the above introduces two subtle issues:
|
||
|
||
1. **Backward compatibility.** Cooperative Mode resolves interceptions only if no Legacy Mode resolution has taken place. If any handler uses a Legacy Mode resolution (ie, does not specify a priority), that handler will resolve the interception immediately even if your handler runs first. This could cause disconcerting behavior for your users because suddenly your handler is not resolving the interception and a different handler is taking priority when all they did was upgrade your package.
|
||
2. **Hard-coded priority.** Your package user has no ability to specify the default resolution priority for your handlers. This can become important when the user wishes to manipulate the priorities based on use case. For example, one user might want your package to take a high priority while another user might want it to take a low priority.
|
||
|
||
To resolve both of these issues, our recommended approach is to export a `setInterceptResolutionStrategy()` from your package. The user can then call `setInterceptResolutionStrategy()` to explicitly activate Cooperative Mode in your package so they aren't surprised by changes in how the interception is resolved. They can also optionally specify a custom priority using `setInterceptResolutionStrategy(priority)` that works for their use case:
|
||
|
||
```ts
|
||
// Defaults to undefined which preserves Legacy Mode behavior
|
||
let _priority = undefined;
|
||
|
||
// Export a module configuration function
|
||
export const setInterceptResolutionStrategy = (defaultPriority = 0) =>
|
||
(_priority = defaultPriority);
|
||
|
||
page.on('request', (interceptedRequest) => {
|
||
if (
|
||
interceptedRequest.url().endsWith('.png') ||
|
||
interceptedRequest.url().endsWith('.jpg')
|
||
)
|
||
interceptedRequest.abort('failed', _priority);
|
||
else
|
||
interceptedRequest.continue(
|
||
interceptedRequest.continueRequestOverrides(),
|
||
_priority
|
||
);
|
||
});
|
||
```
|
||
|
||
If your package calls for more fine-grained control resolution priorities, use a config pattern like this:
|
||
|
||
```ts
|
||
interface ResolutionStrategy {
|
||
abortPriority: number;
|
||
continuePriority: number;
|
||
}
|
||
|
||
// This strategy supports multiple priorities based on situational
|
||
// differences. You could, for example, create a strategy that
|
||
// allowed separate priorities for PNG vs JPG.
|
||
const DEFAULT_STRATEGY: ResolutionStrategy = {
|
||
abortPriority: 0,
|
||
continuePriority: 0,
|
||
};
|
||
|
||
// Defaults to undefined which preserves Legacy Mode behavior
|
||
let _strategy: Partial<ResolutionStrategy> = {};
|
||
|
||
export const setInterceptResolutionStrategy = (strategy: ResolutionStrategy) =>
|
||
(_strategy = { ...DEFAULT_STRATEGY, ...strategy });
|
||
|
||
page.on('request', (interceptedRequest) => {
|
||
if (
|
||
interceptedRequest.url().endsWith('.png') ||
|
||
interceptedRequest.url().endsWith('.jpg')
|
||
)
|
||
interceptedRequest.abort('failed', _strategy.abortPriority);
|
||
else
|
||
interceptedRequest.continue(
|
||
interceptedRequest.continueRequestOverrides(),
|
||
_strategy.continuePriority
|
||
);
|
||
});
|
||
```
|
||
|
||
The above solution ensures backward compatibility while also allowing the user to adjust the importance of your package in the resolution chain when Cooperative Mode is being used. Your package continues to work as expected until the user has fully upgraded their code and all third party packages to use Cooperative Mode. If any handler or package still uses Legacy Mode, your package can still operate in Legacy Mode too.
|
||
|
||
#### page.setUserAgent(userAgent[, userAgentMetadata])
|
||
|
||
- `userAgent` <[string]> Specific user agent to use in this page
|
||
- `userAgentMetadata` <[Object]> Optional user agent data to use in this page. Any
|
||
values not provided will use the client's default.
|
||
- `brands` <[Array]<[Object]>> Optional brand information
|
||
- `brand` <[string]> Browser or client brand name.
|
||
- `version` <[string]> Browser or client major version.
|
||
- `fullVersion` <[string]> Optional browser or client full version.
|
||
- `platform` <[string]> Operating system name.
|
||
- `platformVersion` <[string]> Operating system version.
|
||
- `architecture` <[string]> CPU architecture.
|
||
- `model` <[string]> Device model.
|
||
- `mobile` <[boolean]> Indicate if this is a mobile device.
|
||
- returns: <[Promise]> Promise which resolves when the user agent is set.
|
||
|
||
> **NOTE** support for `userAgentMetadata` is experimental in the DevTools
|
||
> protocol and more properties will be added.
|
||
|
||
Providing the optional `userAgentMetadata` header will update the related
|
||
entries in `navigator.userAgentData` and associated `Sec-CH-UA`\* headers.
|
||
|
||
```js
|
||
const page = await browser.newPage();
|
||
await page.setUserAgent('MyBrowser', {
|
||
architecture: 'My1',
|
||
mobile: false,
|
||
model: 'Mybook',
|
||
platform: 'MyOS',
|
||
platformVersion: '3.1',
|
||
});
|
||
```
|
||
|
||
#### page.setViewport(viewport)
|
||
|
||
- `viewport` <[Object]>
|
||
- `width` <[number]> page width in pixels. **required**
|
||
- `height` <[number]> page height in pixels. **required**
|
||
- `deviceScaleFactor` <[number]> Specify device scale factor (can be thought of as DPR). Defaults to `1`.
|
||
- `isMobile` <[boolean]> Whether the `meta viewport` tag is taken into account. Defaults to `false`.
|
||
- `hasTouch`<[boolean]> Specifies if viewport supports touch events. Defaults to `false`
|
||
- `isLandscape` <[boolean]> Specifies if viewport is in landscape mode. Defaults to `false`.
|
||
- returns: <[Promise]>
|
||
|
||
> **NOTE** in certain cases, setting viewport will reload the page in order to set the `isMobile` or `hasTouch` properties.
|
||
|
||
In the case of multiple pages in a single browser, each page can have its own viewport size.
|
||
|
||
`page.setViewport` will resize the page. A lot of websites don't expect phones to change size, so you should set the viewport before navigating to the page.
|
||
|
||
```js
|
||
const page = await browser.newPage();
|
||
await page.setViewport({
|
||
width: 640,
|
||
height: 480,
|
||
deviceScaleFactor: 1,
|
||
});
|
||
await page.goto('https://example.com');
|
||
```
|
||
|
||
#### page.tap(selector)
|
||
|
||
- `selector` <[string]> A [selector] to search for element to tap. If there are multiple elements satisfying the selector, the first will be tapped.
|
||
- returns: <[Promise]>
|
||
|
||
This method fetches an element with `selector`, scrolls it into view if needed, and then uses [page.touchscreen](#pagetouchscreen) to tap in the center of the element.
|
||
If there's no element matching `selector`, the method throws an error.
|
||
|
||
Shortcut for [page.mainFrame().tap(selector)](#frametapselector).
|
||
|
||
#### page.target()
|
||
|
||
- returns: <[Target]> a target this page was created from.
|
||
|
||
#### page.title()
|
||
|
||
- returns: <[Promise]<[string]>> The page's title.
|
||
|
||
Shortcut for [page.mainFrame().title()](#frametitle).
|
||
|
||
#### page.touchscreen
|
||
|
||
- returns: <[Touchscreen]>
|
||
|
||
#### page.tracing
|
||
|
||
- returns: <[Tracing]>
|
||
|
||
#### page.type(selector, text[, options])
|
||
|
||
- `selector` <[string]> A [selector] of an element to type into. If there are multiple elements satisfying the selector, the first will be used.
|
||
- `text` <[string]> A text to type into a focused element.
|
||
- `options` <[Object]>
|
||
- `delay` <[number]> Time to wait between key presses in milliseconds. Defaults to 0.
|
||
- returns: <[Promise]>
|
||
|
||
Sends a `keydown`, `keypress`/`input`, and `keyup` event for each character in the text.
|
||
|
||
To press a special key, like `Control` or `ArrowDown`, use [`keyboard.press`](#keyboardpresskey-options).
|
||
|
||
```js
|
||
await page.type('#mytextarea', 'Hello'); // Types instantly
|
||
await page.type('#mytextarea', 'World', { delay: 100 }); // Types slower, like a user
|
||
```
|
||
|
||
Shortcut for [page.mainFrame().type(selector, text[, options])](#frametypeselector-text-options).
|
||
|
||
#### page.url()
|
||
|
||
- returns: <[string]>
|
||
|
||
This is a shortcut for [page.mainFrame().url()](#frameurl)
|
||
|
||
#### page.viewport()
|
||
|
||
- returns: <?[Object]>
|
||
- `width` <[number]> page width in pixels.
|
||
- `height` <[number]> page height in pixels.
|
||
- `deviceScaleFactor` <[number]> Specify device scale factor (can be though of as dpr). Defaults to `1`.
|
||
- `isMobile` <[boolean]> Whether the `meta viewport` tag is taken into account. Defaults to `false`.
|
||
- `hasTouch`<[boolean]> Specifies if viewport supports touch events. Defaults to `false`
|
||
- `isLandscape` <[boolean]> Specifies if viewport is in landscape mode. Defaults to `false`.
|
||
|
||
#### page.waitFor(selectorOrFunctionOrTimeout[, options[, ...args]])
|
||
|
||
- `selectorOrFunctionOrTimeout` <[string]|[number]|[function]> A [selector], predicate or timeout to wait for
|
||
- `options` <[Object]> Optional waiting parameters
|
||
- `visible` <[boolean]> wait for element to be present in DOM and to be visible. Defaults to `false`.
|
||
- `timeout` <[number]> maximum time to wait for in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can be changed by using the [page.setDefaultTimeout(timeout)](#pagesetdefaulttimeouttimeout) method.
|
||
- `hidden` <[boolean]> wait for element to not be found in the DOM or to be hidden. Defaults to `false`.
|
||
- `polling` <[string]|[number]> An interval at which the `pageFunction` is executed, defaults to `raf`. If `polling` is a number, then it is treated as an interval in milliseconds at which the function would be executed. If `polling` is a string, then it can be one of the following values:
|
||
- `raf` - to constantly execute `pageFunction` in `requestAnimationFrame` callback. This is the tightest polling mode which is suitable to observe styling changes.
|
||
- `mutation` - to execute `pageFunction` on every DOM mutation.
|
||
- `...args` <...[Serializable]|[JSHandle]> Arguments to pass to `pageFunction`
|
||
- returns: <[Promise]<[JSHandle]>> Promise which resolves to a JSHandle of the success value
|
||
|
||
**This method is deprecated**. You should use the more explicit API methods available:
|
||
|
||
- `page.waitForSelector`
|
||
- `page.waitForXPath`
|
||
- `page.waitForFunction`
|
||
- `page.waitForTimeout`
|
||
|
||
This method behaves differently with respect to the type of the first parameter:
|
||
|
||
- if `selectorOrFunctionOrTimeout` is a `string`, then the first argument is treated as a [selector] or [xpath], depending on whether or not it starts with '//', and the method is a shortcut for
|
||
[page.waitForSelector](#pagewaitforselectorselector-options) or [page.waitForXPath](#pagewaitforxpathxpath-options)
|
||
- if `selectorOrFunctionOrTimeout` is a `function`, then the first argument is treated as a predicate to wait for and the method is a shortcut for [page.waitForFunction()](#pagewaitforfunctionpagefunction-options-args).
|
||
- if `selectorOrFunctionOrTimeout` is a `number`, then the first argument is treated as a timeout in milliseconds and the method returns a promise which resolves after the timeout
|
||
- otherwise, an exception is thrown
|
||
|
||
```js
|
||
// wait for selector
|
||
await page.waitFor('.foo');
|
||
// wait for 1 second
|
||
await page.waitFor(1000);
|
||
// wait for predicate
|
||
await page.waitFor(() => !!document.querySelector('.foo'));
|
||
```
|
||
|
||
To pass arguments from node.js to the predicate of `page.waitFor` function:
|
||
|
||
```js
|
||
const selector = '.foo';
|
||
await page.waitFor(
|
||
(selector) => !!document.querySelector(selector),
|
||
{},
|
||
selector
|
||
);
|
||
```
|
||
|
||
Shortcut for [page.mainFrame().waitFor(selectorOrFunctionOrTimeout[, options[, ...args]])](#framewaitforselectororfunctionortimeout-options-args).
|
||
|
||
#### page.waitForFileChooser([options])
|
||
|
||
- `options` <[WaitTimeoutOptions](####WaitTimeoutOptions)> Optional waiting parameters
|
||
- returns: <[Promise]<[FileChooser]>> A promise that resolves after a page requests a file picker.
|
||
|
||
> **NOTE** In non-headless Chromium, this method results in the native file picker dialog **not showing up** for the user.
|
||
|
||
This method is typically coupled with an action that triggers file choosing.
|
||
The following example clicks a button that issues a file chooser and then
|
||
responds with `/tmp/myfile.pdf` as if a user has selected this file.
|
||
|
||
```js
|
||
const [fileChooser] = await Promise.all([
|
||
page.waitForFileChooser(),
|
||
page.click('#upload-file-button'), // some button that triggers file selection
|
||
]);
|
||
await fileChooser.accept(['/tmp/myfile.pdf']);
|
||
```
|
||
|
||
> **NOTE** This must be called _before_ the file chooser is launched. It will not return a currently active file chooser.
|
||
|
||
> **NOTE** “File picker” refers to the operating system’s file selection UI that lets you browse to a folder and select file(s) to be shared with the web app. It’s not the “Save file” dialog.
|
||
|
||
#### page.waitForFunction(pageFunction[, options[, ...args]])
|
||
|
||
- `pageFunction` <[function]|[string]> Function to be evaluated in browser context
|
||
- `options` <[Object]> Optional waiting parameters
|
||
- `polling` <[string]|[number]> An interval at which the `pageFunction` is executed, defaults to `raf`. If `polling` is a number, then it is treated as an interval in milliseconds at which the function would be executed. If `polling` is a string, then it can be one of the following values:
|
||
- `raf` - to constantly execute `pageFunction` in `requestAnimationFrame` callback. This is the tightest polling mode which is suitable to observe styling changes.
|
||
- `mutation` - to execute `pageFunction` on every DOM mutation.
|
||
- `timeout` <[number]> maximum time to wait for in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can be changed by using the [page.setDefaultTimeout(timeout)](#pagesetdefaulttimeouttimeout) method.
|
||
- `...args` <...[Serializable]|[JSHandle]> Arguments to pass to `pageFunction`
|
||
- returns: <[Promise]<[JSHandle]>> Promise which resolves when the `pageFunction` returns a truthy value. It resolves to a JSHandle of the truthy value.
|
||
|
||
The `waitForFunction` can be used to observe viewport size change:
|
||
|
||
```js
|
||
const puppeteer = require('puppeteer');
|
||
|
||
(async () => {
|
||
const browser = await puppeteer.launch();
|
||
const page = await browser.newPage();
|
||
const watchDog = page.waitForFunction('window.innerWidth < 100');
|
||
await page.setViewport({ width: 50, height: 50 });
|
||
await watchDog;
|
||
await browser.close();
|
||
})();
|
||
```
|
||
|
||
To pass arguments from node.js to the predicate of `page.waitForFunction` function:
|
||
|
||
```js
|
||
const selector = '.foo';
|
||
await page.waitForFunction(
|
||
(selector) => !!document.querySelector(selector),
|
||
{},
|
||
selector
|
||
);
|
||
```
|
||
|
||
The predicate of `page.waitForFunction` can be asynchronous too:
|
||
|
||
```js
|
||
const username = 'github-username';
|
||
await page.waitForFunction(
|
||
async (username) => {
|
||
const githubResponse = await fetch(
|
||
`https://api.github.com/users/${username}`
|
||
);
|
||
const githubUser = await githubResponse.json();
|
||
// show the avatar
|
||
const img = document.createElement('img');
|
||
img.src = githubUser.avatar_url;
|
||
// wait 3 seconds
|
||
await new Promise((resolve, reject) => setTimeout(resolve, 3000));
|
||
img.remove();
|
||
},
|
||
{},
|
||
username
|
||
);
|
||
```
|
||
|
||
Shortcut for [page.mainFrame().waitForFunction(pageFunction[, options[, ...args]])](#framewaitforfunctionpagefunction-options-args).
|
||
|
||
#### page.waitForNavigation([options])
|
||
|
||
- `options` <[Object]> Navigation parameters which might have the following properties:
|
||
- `timeout` <[number]> Maximum navigation time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed by using the [page.setDefaultNavigationTimeout(timeout)](#pagesetdefaultnavigationtimeouttimeout) or [page.setDefaultTimeout(timeout)](#pagesetdefaulttimeouttimeout) methods.
|
||
- `waitUntil` <"load"|"domcontentloaded"|"networkidle0"|"networkidle2"|Array<PuppeteerLifeCycleMethod>> When to consider navigation succeeded, defaults to `load`. Given an array of event strings, navigation is considered to be successful after all events have been fired. Events can be either:
|
||
- `load` - consider navigation to be finished when the `load` event is fired.
|
||
- `domcontentloaded` - consider navigation to be finished when the `DOMContentLoaded` event is fired.
|
||
- `networkidle0` - consider navigation to be finished when there are no more than 0 network connections for at least `500` ms.
|
||
- `networkidle2` - consider navigation to be finished when there are no more than 2 network connections for at least `500` ms.
|
||
- returns: <[Promise]<?[HTTPResponse]>> Promise which resolves to the main resource response. In case of multiple redirects, the navigation will resolve with the response of the last redirect. In case of navigation to a different anchor or navigation due to History API usage, the navigation will resolve with `null`.
|
||
|
||
This resolves when the page navigates to a new URL or reloads. It is useful when you run code
|
||
that will indirectly cause the page to navigate. Consider this example:
|
||
|
||
```js
|
||
const [response] = await Promise.all([
|
||
page.waitForNavigation(), // The promise resolves after navigation has finished
|
||
page.click('a.my-link'), // Clicking the link will indirectly cause a navigation
|
||
]);
|
||
```
|
||
|
||
**NOTE** Usage of the [History API](https://developer.mozilla.org/en-US/docs/Web/API/History_API) to change the URL is considered a navigation.
|
||
|
||
Shortcut for [page.mainFrame().waitForNavigation(options)](#framewaitfornavigationoptions).
|
||
|
||
#### page.waitForNetworkIdle([options])
|
||
- `options` <[Object]> Optional waiting parameters
|
||
- `timeout` <[number]> Maximum wait time in milliseconds, defaults to 30 seconds, pass `0` to disable the timeout. The default value can be changed by using the [page.setDefaultTimeout(timeout)](#pagesetdefaulttimeouttimeout) method.
|
||
- `idleTime` <[number]> How long to wait for no network requests in milliseconds, defaults to 500 milliseconds.
|
||
- returns: <[Promise]<void>> Promise which resolves when network is idle.
|
||
|
||
```js
|
||
page.evaluate(() => fetch('some-url'));
|
||
page.waitForNetworkIdle(); // The promise resolves after fetch above finishes
|
||
```
|
||
|
||
#### page.waitForRequest(urlOrPredicate[, options])
|
||
|
||
- `urlOrPredicate` <[string]|[Function]> A URL or predicate to wait for.
|
||
- `options` <[Object]> Optional waiting parameters
|
||
- `timeout` <[number]> Maximum wait time in milliseconds, defaults to 30 seconds, pass `0` to disable the timeout. The default value can be changed by using the [page.setDefaultTimeout(timeout)](#pagesetdefaulttimeouttimeout) method.
|
||
- returns: <[Promise]<[HTTPRequest]>> Promise which resolves to the matched request.
|
||
|
||
```js
|
||
const firstRequest = await page.waitForRequest('http://example.com/resource');
|
||
const finalRequest = await page.waitForRequest(
|
||
(request) =>
|
||
request.url() === 'http://example.com' && request.method() === 'GET'
|
||
);
|
||
return firstRequest.url();
|
||
```
|
||
|
||
#### page.waitForResponse(urlOrPredicate[, options])
|
||
|
||
- `urlOrPredicate` <[string]|[Function]> A URL or predicate to wait for.
|
||
- `options` <[Object]> Optional waiting parameters
|
||
- `timeout` <[number]> Maximum wait time in milliseconds, defaults to 30 seconds, pass `0` to disable the timeout. The default value can be changed by using the [page.setDefaultTimeout(timeout)](#pagesetdefaulttimeouttimeout) method.
|
||
- returns: <[Promise]<[HTTPResponse]>> Promise which resolves to the matched response.
|
||
|
||
```js
|
||
const firstResponse = await page.waitForResponse(
|
||
'https://example.com/resource'
|
||
);
|
||
const finalResponse = await page.waitForResponse(
|
||
(response) =>
|
||
response.url() === 'https://example.com' && response.status() === 200
|
||
);
|
||
const finalResponse = await page.waitForResponse(async (response) => {
|
||
return (await response.text()).includes('<html>');
|
||
});
|
||
return finalResponse.ok();
|
||
```
|
||
|
||
#### page.waitForSelector(selector[, options])
|
||
|
||
- `selector` <[string]> A [selector] of an element to wait for
|
||
- `options` <[Object]> Optional waiting parameters
|
||
- `visible` <[boolean]> wait for element to be present in DOM and to be visible, i.e. to not have `display: none` or `visibility: hidden` CSS properties. Defaults to `false`.
|
||
- `hidden` <[boolean]> wait for element to not be found in the DOM or to be hidden, i.e. have `display: none` or `visibility: hidden` CSS properties. Defaults to `false`.
|
||
- `timeout` <[number]> maximum time to wait for in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can be changed by using the [page.setDefaultTimeout(timeout)](#pagesetdefaulttimeouttimeout) method.
|
||
- returns: <[Promise]<?[ElementHandle]>> Promise which resolves when element specified by selector string is added to DOM. Resolves to `null` if waiting for `hidden: true` and selector is not found in DOM.
|
||
|
||
Wait for the `selector` to appear in page. If at the moment of calling
|
||
the method the `selector` already exists, the method will return
|
||
immediately. If the selector doesn't appear after the `timeout` milliseconds of waiting, the function will throw.
|
||
|
||
This method works across navigations:
|
||
|
||
```js
|
||
const puppeteer = require('puppeteer');
|
||
|
||
(async () => {
|
||
const browser = await puppeteer.launch();
|
||
const page = await browser.newPage();
|
||
let currentURL;
|
||
page
|
||
.waitForSelector('img')
|
||
.then(() => console.log('First URL with image: ' + currentURL));
|
||
for (currentURL of [
|
||
'https://example.com',
|
||
'https://google.com',
|
||
'https://bbc.com',
|
||
]) {
|
||
await page.goto(currentURL);
|
||
}
|
||
await browser.close();
|
||
})();
|
||
```
|
||
|
||
Shortcut for [page.mainFrame().waitForSelector(selector[, options])](#framewaitforselectorselector-options).
|
||
|
||
#### page.waitForTimeout(milliseconds)
|
||
|
||
- `milliseconds` <[number]> The number of milliseconds to wait for.
|
||
- returns: <[Promise]> Promise which resolves after the timeout has been completed.
|
||
|
||
Pauses script execution for the given number of milliseconds before continuing:
|
||
|
||
```js
|
||
const puppeteer = require('puppeteer');
|
||
|
||
(async () => {
|
||
const browser = await puppeteer.launch();
|
||
const page = await browser.newPage();
|
||
page.waitForTimeout(1000).then(() => console.log('Waited a second!'));
|
||
|
||
await browser.close();
|
||
})();
|
||
```
|
||
|
||
#### page.waitForXPath(xpath[, options])
|
||
|
||
- `xpath` <[string]> A [xpath] of an element to wait for
|
||
- `options` <[Object]> Optional waiting parameters
|
||
- `visible` <[boolean]> wait for element to be present in DOM and to be visible, i.e. to not have `display: none` or `visibility: hidden` CSS properties. Defaults to `false`.
|
||
- `hidden` <[boolean]> wait for element to not be found in the DOM or to be hidden, i.e. have `display: none` or `visibility: hidden` CSS properties. Defaults to `false`.
|
||
- `timeout` <[number]> maximum time to wait for in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can be changed by using the [page.setDefaultTimeout(timeout)](#pagesetdefaulttimeouttimeout) method.
|
||
- returns: <[Promise]<?[ElementHandle]>> Promise which resolves when element specified by xpath string is added to DOM. Resolves to `null` if waiting for `hidden: true` and xpath is not found in DOM.
|
||
|
||
Wait for the `xpath` to appear in page. If at the moment of calling
|
||
the method the `xpath` already exists, the method will return
|
||
immediately. If the xpath doesn't appear after the `timeout` milliseconds of waiting, the function will throw.
|
||
|
||
This method works across navigations:
|
||
|
||
```js
|
||
const puppeteer = require('puppeteer');
|
||
|
||
(async () => {
|
||
const browser = await puppeteer.launch();
|
||
const page = await browser.newPage();
|
||
let currentURL;
|
||
page
|
||
.waitForXPath('//img')
|
||
.then(() => console.log('First URL with image: ' + currentURL));
|
||
for (currentURL of [
|
||
'https://example.com',
|
||
'https://google.com',
|
||
'https://bbc.com',
|
||
]) {
|
||
await page.goto(currentURL);
|
||
}
|
||
await browser.close();
|
||
})();
|
||
```
|
||
|
||
Shortcut for [page.mainFrame().waitForXPath(xpath[, options])](#framewaitforxpathxpath-options).
|
||
|
||
#### page.workers()
|
||
|
||
- returns: <[Array]<[WebWorker]>>
|
||
This method returns all of the dedicated [WebWorkers](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API) associated with the page.
|
||
|
||
> **NOTE** This does not contain ServiceWorkers
|
||
|
||
#### GeolocationOptions
|
||
|
||
- `latitude` <[number]> Latitude between -90 and 90.
|
||
- `longitude` <[number]> Longitude between -180 and 180.
|
||
- `accuracy` <[number]> Optional non-negative accuracy value.
|
||
|
||
#### WaitTimeoutOptions
|
||
|
||
- `timeout` <[number]> Maximum wait time in milliseconds, defaults to 30 seconds, pass `0` to disable the timeout. The default value can be changed by using the [page.setDefaultTimeout(timeout)](#pagesetdefaulttimeouttimeout) method.
|
||
|
||
### class: WebWorker
|
||
|
||
The WebWorker class represents a [WebWorker](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API).
|
||
The events `workercreated` and `workerdestroyed` are emitted on the page object to signal the worker lifecycle.
|
||
|
||
```js
|
||
page.on('workercreated', (worker) =>
|
||
console.log('Worker created: ' + worker.url())
|
||
);
|
||
page.on('workerdestroyed', (worker) =>
|
||
console.log('Worker destroyed: ' + worker.url())
|
||
);
|
||
|
||
console.log('Current workers:');
|
||
for (const worker of page.workers()) console.log(' ' + worker.url());
|
||
```
|
||
|
||
#### webWorker.evaluate(pageFunction[, ...args])
|
||
|
||
- `pageFunction` <[function]|[string]> Function to be evaluated in the worker context
|
||
- `...args` <...[Serializable]|[JSHandle]> Arguments to pass to `pageFunction`
|
||
- returns: <[Promise]<[Serializable]>> Promise which resolves to the return value of `pageFunction`
|
||
|
||
If the function passed to the `worker.evaluate` returns a [Promise], then `worker.evaluate` would wait for the promise to resolve and return its value.
|
||
|
||
If the function passed to the `worker.evaluate` returns a non-[Serializable] value, then `worker.evaluate` resolves to `undefined`. DevTools Protocol also supports transferring some additional values that are not serializable by `JSON`: `-0`, `NaN`, `Infinity`, `-Infinity`, and bigint literals.
|
||
|
||
Shortcut for [(await worker.executionContext()).evaluate(pageFunction, ...args)](#executioncontextevaluatepagefunction-args).
|
||
|
||
#### webWorker.evaluateHandle(pageFunction[, ...args])
|
||
|
||
- `pageFunction` <[function]|[string]> Function to be evaluated in the page context
|
||
- `...args` <...[Serializable]|[JSHandle]> Arguments to pass to `pageFunction`
|
||
- returns: <[Promise]<[JSHandle]|[ElementHandle]>> Promise which resolves to the return value of `pageFunction` as an in-page object.
|
||
|
||
The only difference between `worker.evaluate` and `worker.evaluateHandle` is that `worker.evaluateHandle` returns in-page object (JSHandle).
|
||
|
||
If the function passed to the `worker.evaluateHandle` returns a [Promise], then `worker.evaluateHandle` would wait for the promise to resolve and return its value.
|
||
|
||
If the function returns an element, the returned handle is an [ElementHandle].
|
||
|
||
Shortcut for [(await worker.executionContext()).evaluateHandle(pageFunction, ...args)](#executioncontextevaluatehandlepagefunction-args).
|
||
|
||
#### webWorker.executionContext()
|
||
|
||
- returns: <[Promise]<[ExecutionContext]>>
|
||
|
||
#### webWorker.url()
|
||
|
||
- returns: <[string]>
|
||
|
||
### class: 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).
|
||
|
||
Accessibility is a very platform-specific thing. On different platforms, there are different screen readers that might have wildly different output.
|
||
|
||
Blink - Chrome's rendering engine - has a concept of "accessibility tree", which is then translated into different platform-specific APIs. Accessibility namespace gives users
|
||
access to the Blink Accessibility Tree.
|
||
|
||
Most of the accessibility tree gets filtered out when converting from Blink AX Tree to Platform-specific AX-Tree or by assistive technologies themselves. By default, Puppeteer tries to approximate this filtering, exposing only the "interesting" nodes of the tree.
|
||
|
||
#### accessibility.snapshot([options])
|
||
|
||
- `options` <[Object]>
|
||
- `interestingOnly` <[boolean]> Prune uninteresting nodes from the tree. Defaults to `true`.
|
||
- `root` <[ElementHandle]> The root DOM element for the snapshot. Defaults to the whole page.
|
||
- returns: <[Promise]<[Object]>> An [AXNode] object with the following properties:
|
||
- `role` <[string]> The [role](https://www.w3.org/TR/wai-aria/#usage_intro).
|
||
- `name` <[string]> A human readable name for the node.
|
||
- `value` <[string]|[number]> The current value of the node.
|
||
- `description` <[string]> An additional human readable description of the node.
|
||
- `keyshortcuts` <[string]> Keyboard shortcuts associated with this node.
|
||
- `roledescription` <[string]> A human readable alternative to the role.
|
||
- `valuetext` <[string]> A description of the current value.
|
||
- `disabled` <[boolean]> Whether the node is disabled.
|
||
- `expanded` <[boolean]> Whether the node is expanded or collapsed.
|
||
- `focused` <[boolean]> Whether the node is focused.
|
||
- `modal` <[boolean]> Whether the node is [modal](https://en.wikipedia.org/wiki/Modal_window).
|
||
- `multiline` <[boolean]> Whether the node text input supports multiline.
|
||
- `multiselectable` <[boolean]> Whether more than one child can be selected.
|
||
- `readonly` <[boolean]> Whether the node is read-only.
|
||
- `required` <[boolean]> Whether the node is required.
|
||
- `selected` <[boolean]> Whether the node is selected in its parent node.
|
||
- `checked` <[boolean]|"mixed"> Whether the checkbox is checked, or "mixed".
|
||
- `pressed` <[boolean]|"mixed"> Whether the toggle button is checked, or "mixed".
|
||
- `level` <[number]> The level of a heading.
|
||
- `valuemin` <[number]> The minimum value in a node.
|
||
- `valuemax` <[number]> The maximum value in a node.
|
||
- `autocomplete` <[string]> What kind of autocomplete is supported by a control.
|
||
- `haspopup` <[string]> What kind of popup is currently being shown for a node.
|
||
- `invalid` <[string]> Whether and in what way this node's value is invalid.
|
||
- `orientation` <[string]> Whether the node is oriented horizontally or vertically.
|
||
- `children` <[Array]<[Object]>> Child [AXNode]s of this node, if any.
|
||
|
||
Captures the current state of the accessibility tree. The returned object represents the root accessible node of the page.
|
||
|
||
> **NOTE** The Chromium accessibility tree contains nodes that go unused on most platforms and by
|
||
> most screen readers. Puppeteer will discard them as well for an easier to process tree,
|
||
> unless `interestingOnly` is set to `false`.
|
||
|
||
An example of dumping the entire accessibility tree:
|
||
|
||
```js
|
||
const snapshot = await page.accessibility.snapshot();
|
||
console.log(snapshot);
|
||
```
|
||
|
||
An example of logging the focused node's name:
|
||
|
||
```js
|
||
const snapshot = await page.accessibility.snapshot();
|
||
const node = findFocusedNode(snapshot);
|
||
console.log(node && node.name);
|
||
|
||
function findFocusedNode(node) {
|
||
if (node.focused) return node;
|
||
for (const child of node.children || []) {
|
||
const foundNode = findFocusedNode(child);
|
||
return foundNode;
|
||
}
|
||
return null;
|
||
}
|
||
```
|
||
|
||
### class: Keyboard
|
||
|
||
Keyboard provides an API for managing a virtual keyboard. The high-level API is [`keyboard.type`](#keyboardtypetext-options), which takes raw characters and generates proper keydown, keypress/input, and keyup events on your page.
|
||
|
||
For finer control, you can use [`keyboard.down`](#keyboarddownkey-options), [`keyboard.up`](#keyboardupkey), and [`keyboard.sendCharacter`](#keyboardsendcharacterchar) to manually fire events as if they were generated from a real keyboard.
|
||
|
||
An example of holding down `Shift` in order to select and delete some text:
|
||
|
||
```js
|
||
await page.keyboard.type('Hello World!');
|
||
await page.keyboard.press('ArrowLeft');
|
||
|
||
await page.keyboard.down('Shift');
|
||
for (let i = 0; i < ' World'.length; i++)
|
||
await page.keyboard.press('ArrowLeft');
|
||
await page.keyboard.up('Shift');
|
||
|
||
await page.keyboard.press('Backspace');
|
||
// Result text will end up saying 'Hello!'
|
||
```
|
||
|
||
An example of pressing `A`
|
||
|
||
```js
|
||
await page.keyboard.down('Shift');
|
||
await page.keyboard.press('KeyA');
|
||
await page.keyboard.up('Shift');
|
||
```
|
||
|
||
> **NOTE** On macOS, keyboard shortcuts like `⌘ A` -> Select All does not work. See [#1313](https://github.com/puppeteer/puppeteer/issues/1313)
|
||
|
||
#### keyboard.down(key[, options])
|
||
|
||
- `key` <[string]> Name of key to press, such as `ArrowLeft`. See [USKeyboardLayout] for a list of all key names.
|
||
- `options` <[Object]>
|
||
- `text` <[string]> If specified, generates an input event with this text.
|
||
- returns: <[Promise]>
|
||
|
||
Dispatches a `keydown` event.
|
||
|
||
If `key` is a single character and no modifier keys besides `Shift` are being held down, a `keypress`/`input` event will also be generated. The `text` option can be specified to force an input event to be generated.
|
||
|
||
If `key` is a modifier key, `Shift`, `Meta`, `Control`, or `Alt`, subsequent key presses will be sent with that modifier active. To release the modifier key, use [`keyboard.up`](#keyboardupkey).
|
||
|
||
After the key is pressed once, subsequent calls to [`keyboard.down`](#keyboarddownkey-options) will have [repeat](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/repeat) set to true. To release the key, use [`keyboard.up`](#keyboardupkey).
|
||
|
||
> **NOTE** Modifier keys DO influence `keyboard.down`. Holding down `Shift` will type the text in upper case.
|
||
|
||
#### keyboard.press(key[, options])
|
||
|
||
- `key` <[string]> Name of key to press, such as `ArrowLeft`. See [USKeyboardLayout] for a list of all key names.
|
||
- `options` <[Object]>
|
||
- `text` <[string]> If specified, generates an input event with this text.
|
||
- `delay` <[number]> Time to wait between `keydown` and `keyup` in milliseconds. Defaults to 0.
|
||
- returns: <[Promise]>
|
||
|
||
If `key` is a single character and no modifier keys besides `Shift` are being held down, a `keypress`/`input` event will also be generated. The `text` option can be specified to force an input event to be generated.
|
||
|
||
> **NOTE** Modifier keys DO affect `keyboard.press`. Holding down `Shift` will type the text in upper case.
|
||
|
||
Shortcut for [`keyboard.down`](#keyboarddownkey-options) and [`keyboard.up`](#keyboardupkey).
|
||
|
||
#### keyboard.sendCharacter(char)
|
||
|
||
- `char` <[string]> Character to send into the page.
|
||
- returns: <[Promise]>
|
||
|
||
Dispatches a `keypress` and `input` event. This does not send a `keydown` or `keyup` event.
|
||
|
||
```js
|
||
page.keyboard.sendCharacter('嗨');
|
||
```
|
||
|
||
> **NOTE** Modifier keys DO NOT affect `keyboard.sendCharacter`. Holding down `Shift` will not type the text in upper case.
|
||
|
||
#### keyboard.type(text[, options])
|
||
|
||
- `text` <[string]> A text to type into a focused element.
|
||
- `options` <[Object]>
|
||
- `delay` <[number]> Time to wait between key presses in milliseconds. Defaults to 0.
|
||
- returns: <[Promise]>
|
||
|
||
Sends a `keydown`, `keypress`/`input`, and `keyup` event for each character in the text.
|
||
|
||
To press a special key, like `Control` or `ArrowDown`, use [`keyboard.press`](#keyboardpresskey-options).
|
||
|
||
```js
|
||
await page.keyboard.type('Hello'); // Types instantly
|
||
await page.keyboard.type('World', { delay: 100 }); // Types slower, like a user
|
||
```
|
||
|
||
> **NOTE** Modifier keys DO NOT affect `keyboard.type`. Holding down `Shift` will not type the text in upper case.
|
||
|
||
#### keyboard.up(key)
|
||
|
||
- `key` <[string]> Name of key to release, such as `ArrowLeft`. See [USKeyboardLayout] for a list of all key names.
|
||
- returns: <[Promise]>
|
||
|
||
Dispatches a `keyup` event.
|
||
|
||
### class: Mouse
|
||
|
||
The Mouse class operates in main-frame CSS pixels relative to the top-left corner of the viewport.
|
||
|
||
Every `page` object has its own Mouse, accessible with [`page.mouse`](#pagemouse).
|
||
|
||
```js
|
||
// Using ‘page.mouse’ to trace a 100x100 square.
|
||
await page.mouse.move(0, 0);
|
||
await page.mouse.down();
|
||
await page.mouse.move(0, 100);
|
||
await page.mouse.move(100, 100);
|
||
await page.mouse.move(100, 0);
|
||
await page.mouse.move(0, 0);
|
||
await page.mouse.up();
|
||
```
|
||
|
||
Note that the mouse events trigger synthetic `MouseEvent`s.
|
||
This means that it does not fully replicate the functionality of what a normal user would be able to do with their mouse.
|
||
|
||
For example, dragging and selecting text is not possible using `page.mouse`.
|
||
Instead, you can use the [`DocumentOrShadowRoot.getSelection()`](https://developer.mozilla.org/en-US/docs/Web/API/DocumentOrShadowRoot/getSelection) functionality implemented in the platform.
|
||
|
||
For example, if you want to select all content between nodes:
|
||
|
||
```js
|
||
await page.evaluate(
|
||
(from, to) => {
|
||
const selection = from.getRootNode().getSelection();
|
||
const range = document.createRange();
|
||
range.setStartBefore(from);
|
||
range.setEndAfter(to);
|
||
selection.removeAllRanges();
|
||
selection.addRange(range);
|
||
},
|
||
fromJSHandle,
|
||
toJSHandle
|
||
);
|
||
```
|
||
|
||
If you then would want to copy-paste your selection, you can use the clipboard API:
|
||
|
||
```js
|
||
// The clipboard API does not allow you to copy, unless the tab is focused.
|
||
await page.bringToFront();
|
||
await page.evaluate(() => {
|
||
// Copy the selected content to the clipboard
|
||
document.execCommand('copy');
|
||
// Obtain the content of the clipboard as a string
|
||
return navigator.clipboard.readText();
|
||
});
|
||
```
|
||
|
||
Note that if you want access to the clipboard API, you have to give it permission to do so:
|
||
|
||
```js
|
||
await browser
|
||
.defaultBrowserContext()
|
||
.overridePermissions('<your origin>', ['clipboard-read', 'clipboard-write']);
|
||
```
|
||
|
||
#### mouse.click(x, y[, options])
|
||
|
||
- `x` <[number]>
|
||
- `y` <[number]>
|
||
- `options` <[Object]>
|
||
- `button` <"left"|"right"|"middle"> Defaults to `left`.
|
||
- `clickCount` <[number]> defaults to 1. See [UIEvent.detail].
|
||
- `delay` <[number]> Time to wait between `mousedown` and `mouseup` in milliseconds. Defaults to 0.
|
||
- returns: <[Promise]>
|
||
|
||
Shortcut for [`mouse.move`](#mousemovex-y-options), [`mouse.down`](#mousedownoptions) and [`mouse.up`](#mouseupoptions).
|
||
|
||
#### mouse.down([options])
|
||
|
||
- `options` <[Object]>
|
||
- `button` <"left"|"right"|"middle"> Defaults to `left`.
|
||
- `clickCount` <[number]> defaults to 1. See [UIEvent.detail].
|
||
- returns: <[Promise]>
|
||
|
||
Dispatches a `mousedown` event.
|
||
|
||
#### mouse.drag(start, target)
|
||
|
||
- `start` <[Object]> the position to start dragging from
|
||
- `x` <[number]> x coordinate
|
||
- `y` <[number]> y coordinate
|
||
- `target` <[Object]> the position to drag to
|
||
- `x` <[number]> x coordinate
|
||
- `y` <[number]> y coordinate
|
||
- returns: <[Promise<[DragData]>]>
|
||
|
||
This method creates and captures a dragevent from a given point.
|
||
|
||
#### mouse.dragAndDrop(start, target[, options])
|
||
|
||
- `start` <[Object]>
|
||
- `x` <[number]> x coordinate
|
||
- `y` <[number]> y coordinate
|
||
- `target` <[Object]>
|
||
- `x` <[number]> x coordinate
|
||
- `y` <[number]> y coordinate
|
||
- `options` <[Object]>
|
||
- `delay` <[number]> how long to delay before dropping onto the target point
|
||
- returns: <[Promise<[DragData]>]>
|
||
|
||
This method drags from a given start point and drops onto a target point.
|
||
|
||
#### mouse.dragEnter(target, data)
|
||
|
||
- `target` <[Object]>
|
||
- `x` <[number]> x coordinate
|
||
- `y` <[number]> y coordinate
|
||
- `data` <[Object]>
|
||
- returns: <[Promise]]>
|
||
|
||
This method triggers a dragenter event from the target point.
|
||
|
||
#### mouse.dragOver(target, data)
|
||
|
||
- `target` <[Object]>
|
||
- `x` <[number]> x coordinate
|
||
- `y` <[number]> y coordinate
|
||
- `data` <[Object]>
|
||
- returns: <[Promise]]>
|
||
|
||
This method triggers a dragover event from the target point.
|
||
|
||
#### mouse.drop(target, data)
|
||
|
||
- `target` <[Object]>
|
||
- `x` <[number]> x coordinate
|
||
- `y` <[number]> y coordinate
|
||
- `data` <[Object]>
|
||
- returns: <[Promise]]>
|
||
|
||
This method triggers a drop event from the target point.
|
||
|
||
#### mouse.move(x, y[, options])
|
||
|
||
- `x` <[number]>
|
||
- `y` <[number]>
|
||
- `options` <[Object]>
|
||
- `steps` <[number]> defaults to 1. Sends intermediate `mousemove` events.
|
||
- returns: <[Promise]>
|
||
|
||
Dispatches a `mousemove` event.
|
||
|
||
#### mouse.up([options])
|
||
|
||
- `options` <[Object]>
|
||
- `button` <"left"|"right"|"middle"> Defaults to `left`.
|
||
- `clickCount` <[number]> defaults to 1. See [UIEvent.detail].
|
||
- returns: <[Promise]>
|
||
|
||
Dispatches a `mouseup` event.
|
||
|
||
#### mouse.wheel([options])
|
||
|
||
- `options` <[Object]>
|
||
- `deltaX` X delta in CSS pixels for mouse wheel event (default: 0). Positive values emulate a scroll right and negative values a scroll left event.
|
||
- `deltaY` Y delta in CSS pixels for mouse wheel event (default: 0). Positive values emulate a scroll down and negative values a scroll up event.
|
||
- returns: <[Promise]>
|
||
|
||
Dispatches a `mousewheel` event.
|
||
|
||
Examples:
|
||
|
||
```js
|
||
await page.goto(
|
||
'https://mdn.mozillademos.org/en-US/docs/Web/API/Element/wheel_event$samples/Scaling_an_element_via_the_wheel?revision=1587366'
|
||
);
|
||
|
||
const elem = await page.$('div');
|
||
const boundingBox = await elem.boundingBox();
|
||
await page.mouse.move(
|
||
boundingBox.x + boundingBox.width / 2,
|
||
boundingBox.y + boundingBox.height / 2
|
||
);
|
||
|
||
await page.mouse.wheel({ deltaY: -100 });
|
||
```
|
||
|
||
### class: Touchscreen
|
||
|
||
#### touchscreen.tap(x, y)
|
||
|
||
- `x` <[number]>
|
||
- `y` <[number]>
|
||
- returns: <[Promise]>
|
||
|
||
Dispatches a `touchstart` and `touchend` event.
|
||
|
||
### class: Tracing
|
||
|
||
You can use [`tracing.start`](#tracingstartoptions) and [`tracing.stop`](#tracingstop) to create a trace file which can be opened in Chrome DevTools or [timeline viewer](https://chromedevtools.github.io/timeline-viewer/).
|
||
|
||
```js
|
||
await page.tracing.start({ path: 'trace.json' });
|
||
await page.goto('https://www.google.com');
|
||
await page.tracing.stop();
|
||
```
|
||
|
||
#### tracing.start([options])
|
||
|
||
- `options` <[Object]>
|
||
- `path` <[string]> A path to write the trace file to.
|
||
- `screenshots` <[boolean]> captures screenshots in the trace.
|
||
- `categories` <[Array]<[string]>> specify custom categories to use instead of default.
|
||
- returns: <[Promise]>
|
||
|
||
Only one trace can be active at a time per browser.
|
||
|
||
#### tracing.stop()
|
||
|
||
- returns: <[Promise]<[Buffer]>> Promise which resolves to buffer with trace data.
|
||
|
||
### class: FileChooser
|
||
|
||
[FileChooser] objects are returned via the ['page.waitForFileChooser'](#pagewaitforfilechooseroptions) method.
|
||
|
||
File choosers let you react to the page requesting for file(s) to be loaded by the web app. (This file chooser does not cover the “Save file” dialog.)
|
||
|
||
An example of using [FileChooser]:
|
||
|
||
```js
|
||
const [fileChooser] = await Promise.all([
|
||
page.waitForFileChooser(),
|
||
page.click('#upload-file-button'), // some button that triggers file selection
|
||
]);
|
||
await fileChooser.accept(['/tmp/myfile.pdf']);
|
||
```
|
||
|
||
> **NOTE** In browsers, only one file chooser can be opened at a time.
|
||
> All file choosers must be accepted or canceled. Not doing so will prevent subsequent file choosers from appearing.
|
||
|
||
#### fileChooser.accept(filePaths)
|
||
|
||
- `filePaths` <[Array]<[string]>> Accept the file chooser request with given paths. If some of the `filePaths` are relative paths, then they are resolved relative to the [current working directory](https://nodejs.org/api/process.html#process_process_cwd).
|
||
- returns: <[Promise]>
|
||
|
||
#### fileChooser.cancel()
|
||
|
||
Closes the file chooser without selecting any files.
|
||
|
||
#### fileChooser.isMultiple()
|
||
|
||
- returns: <[boolean]> Whether file chooser allow for [multiple](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/file#attr-multiple) file selection.
|
||
|
||
### class: Dialog
|
||
|
||
[Dialog] objects are dispatched by page via the ['dialog'](#event-dialog) event.
|
||
|
||
An example of using `Dialog` class:
|
||
|
||
```js
|
||
const puppeteer = require('puppeteer');
|
||
|
||
(async () => {
|
||
const browser = await puppeteer.launch();
|
||
const page = await browser.newPage();
|
||
page.on('dialog', async (dialog) => {
|
||
console.log(dialog.message());
|
||
await dialog.dismiss();
|
||
await browser.close();
|
||
});
|
||
page.evaluate(() => alert('1'));
|
||
})();
|
||
```
|
||
|
||
#### dialog.accept([promptText])
|
||
|
||
- `promptText` <[string]> A text to enter in prompt. Does not cause any effects if the dialog's `type` is not prompt.
|
||
- returns: <[Promise]> Promise which resolves when the dialog has been accepted.
|
||
|
||
#### dialog.defaultValue()
|
||
|
||
- returns: <[string]> If dialog is prompt, returns default prompt value. Otherwise, returns empty string.
|
||
|
||
#### dialog.dismiss()
|
||
|
||
- returns: <[Promise]> Promise which resolves when the dialog has been dismissed.
|
||
|
||
#### dialog.message()
|
||
|
||
- returns: <[string]> A message displayed in the dialog.
|
||
|
||
#### dialog.type()
|
||
|
||
- returns: <[string]> Dialog's type, can be one of `alert`, `beforeunload`, `confirm` or `prompt`.
|
||
|
||
### class: ConsoleMessage
|
||
|
||
[ConsoleMessage] objects are dispatched by page via the ['console'](#event-console) event.
|
||
|
||
#### consoleMessage.args()
|
||
|
||
- returns: <[Array]<[JSHandle]>>
|
||
|
||
#### consoleMessage.location()
|
||
|
||
- returns: <[Object]>
|
||
- `url` <[string]> URL of the resource if known or `undefined` otherwise.
|
||
- `lineNumber` <[number]> 0-based line number in the resource if known or `undefined` otherwise.
|
||
- `columnNumber` <[number]> 0-based column number in the resource if known or `undefined` otherwise.
|
||
|
||
#### consoleMessage.stackTrace()
|
||
|
||
- returns: <[Array]<[Object]>>
|
||
- `url` <[string]> URL of the resource if known or `undefined` otherwise.
|
||
- `lineNumber` <[number]> 0-based line number in the resource if known or `undefined` otherwise.
|
||
- `columnNumber` <[number]> 0-based column number in the resource if known or `undefined` otherwise.
|
||
|
||
#### consoleMessage.text()
|
||
|
||
- returns: <[string]>
|
||
|
||
#### consoleMessage.type()
|
||
|
||
- returns: <[string]>
|
||
|
||
One of the following values: `'log'`, `'debug'`, `'info'`, `'error'`, `'warning'`, `'dir'`, `'dirxml'`, `'table'`, `'trace'`, `'clear'`, `'startGroup'`, `'startGroupCollapsed'`, `'endGroup'`, `'assert'`, `'profile'`, `'profileEnd'`, `'count'`, `'timeEnd'`.
|
||
|
||
### class: Frame
|
||
|
||
At every point of time, page exposes its current frame tree via the [page.mainFrame()](#pagemainframe) and [frame.childFrames()](#framechildframes) methods.
|
||
|
||
[Frame] object's lifecycle is controlled by three events, dispatched on the page object:
|
||
|
||
- ['frameattached'](#event-frameattached) - fired when the frame gets attached to the page. A Frame can be attached to the page only once.
|
||
- ['framenavigated'](#event-framenavigated) - fired when the frame commits navigation to a different URL.
|
||
- ['framedetached'](#event-framedetached) - fired when the frame gets detached from the page. A Frame can be detached from the page only once.
|
||
|
||
An example of dumping frame tree:
|
||
|
||
```js
|
||
const puppeteer = require('puppeteer');
|
||
|
||
(async () => {
|
||
const browser = await puppeteer.launch();
|
||
const page = await browser.newPage();
|
||
await page.goto('https://www.google.com/chrome/browser/canary.html');
|
||
dumpFrameTree(page.mainFrame(), '');
|
||
await browser.close();
|
||
|
||
function dumpFrameTree(frame, indent) {
|
||
console.log(indent + frame.url());
|
||
for (const child of frame.childFrames()) {
|
||
dumpFrameTree(child, indent + ' ');
|
||
}
|
||
}
|
||
})();
|
||
```
|
||
|
||
An example of getting text from an iframe element:
|
||
|
||
```js
|
||
const frame = page.frames().find((frame) => frame.name() === 'myframe');
|
||
const text = await frame.$eval('.selector', (element) => element.textContent);
|
||
console.log(text);
|
||
```
|
||
|
||
#### frame.$(selector)
|
||
|
||
- `selector` <[string]> A [selector] to query frame for
|
||
- returns: <[Promise]<?[ElementHandle]>> Promise which resolves to ElementHandle pointing to the frame element.
|
||
|
||
The method queries frame for the selector. If there's no such element within the frame, the method resolves to `null`.
|
||
|
||
#### frame.$$(selector)
|
||
|
||
- `selector` <[string]> A [selector] to query frame for
|
||
- returns: <[Promise]<[Array]<[ElementHandle]>>> Promise which resolves to ElementHandles pointing to the frame elements.
|
||
|
||
The method runs `document.querySelectorAll` within the frame. If no elements match the selector, the return value resolves to `[]`.
|
||
|
||
#### frame.$$eval(selector, pageFunction[, ...args])
|
||
|
||
- `selector` <[string]> A [selector] to query frame for
|
||
- `pageFunction` <[function]\([Array]<[Element]>\)> Function to be evaluated in browser context
|
||
- `...args` <...[Serializable]|[JSHandle]> Arguments to pass to `pageFunction`
|
||
- returns: <[Promise]<[Serializable]>> Promise which resolves to the return value of `pageFunction`
|
||
|
||
This method runs `Array.from(document.querySelectorAll(selector))` within the frame and passes it as the first argument to `pageFunction`.
|
||
|
||
If `pageFunction` returns a [Promise], then `frame.$$eval` would wait for the promise to resolve and return its value.
|
||
|
||
Examples:
|
||
|
||
```js
|
||
const divsCounts = await frame.$$eval('div', (divs) => divs.length);
|
||
```
|
||
|
||
#### frame.$eval(selector, pageFunction[, ...args])
|
||
|
||
- `selector` <[string]> A [selector] to query frame for
|
||
- `pageFunction` <[function]\([Element]\)> Function to be evaluated in browser context
|
||
- `...args` <...[Serializable]|[JSHandle]> Arguments to pass to `pageFunction`
|
||
- returns: <[Promise]<[Serializable]>> Promise which resolves to the return value of `pageFunction`
|
||
|
||
This method runs `document.querySelector` within the frame and passes it as the first argument to `pageFunction`. If there's no element matching `selector`, the method throws an error.
|
||
|
||
If `pageFunction` returns a [Promise], then `frame.$eval` would wait for the promise to resolve and return its value.
|
||
|
||
Examples:
|
||
|
||
```js
|
||
const searchValue = await frame.$eval('#search', (el) => el.value);
|
||
const preloadHref = await frame.$eval('link[rel=preload]', (el) => el.href);
|
||
const html = await frame.$eval('.main-container', (e) => e.outerHTML);
|
||
```
|
||
|
||
#### frame.$x(expression)
|
||
|
||
- `expression` <[string]> Expression to [evaluate](https://developer.mozilla.org/en-US/docs/Web/API/Document/evaluate).
|
||
- returns: <[Promise]<[Array]<[ElementHandle]>>>
|
||
|
||
The method evaluates the XPath expression relative to the frame document as its context node. If there are no such elements, the method resolves to an empty array.
|
||
|
||
#### frame.addScriptTag(options)
|
||
|
||
- `options` <[Object]>
|
||
- `url` <[string]> URL of a script to be added.
|
||
- `path` <[string]> Path to the JavaScript file to be injected into frame. If `path` is a relative path, then it is resolved relative to [current working directory](https://nodejs.org/api/process.html#process_process_cwd).
|
||
- `content` <[string]> Raw JavaScript content to be injected into frame.
|
||
- `type` <[string]> Script type. Use 'module' in order to load a Javascript ES6 module. See [script](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/script) for more details.
|
||
- `id` <[string]> id attribute to add to the script tag.
|
||
- returns: <[Promise]<[ElementHandle]>> which resolves to the added tag when the script's onload fires or when the script content was injected into frame.
|
||
|
||
Adds a `<script>` tag into the page with the desired URL or content.
|
||
|
||
#### frame.addStyleTag(options)
|
||
|
||
- `options` <[Object]>
|
||
- `url` <[string]> URL of the `<link>` tag.
|
||
- `path` <[string]> Path to the CSS file to be injected into frame. If `path` is a relative path, then it is resolved relative to [current working directory](https://nodejs.org/api/process.html#process_process_cwd).
|
||
- `content` <[string]> Raw CSS content to be injected into frame.
|
||
- returns: <[Promise]<[ElementHandle]>> which resolves to the added tag when the stylesheet's onload fires or when the CSS content was injected into frame.
|
||
|
||
Adds a `<link rel="stylesheet">` tag into the page with the desired URL or a `<style type="text/css">` tag with the content.
|
||
|
||
#### frame.childFrames()
|
||
|
||
- returns: <[Array]<[Frame]>>
|
||
|
||
#### frame.click(selector[, options])
|
||
|
||
- `selector` <[string]> A [selector] to search for element to click. If there are multiple elements satisfying the selector, the first will be clicked.
|
||
- `options` <[Object]>
|
||
- `button` <"left"|"right"|"middle"> Defaults to `left`.
|
||
- `clickCount` <[number]> defaults to 1. See [UIEvent.detail].
|
||
- `delay` <[number]> Time to wait between `mousedown` and `mouseup` in milliseconds. Defaults to 0.
|
||
- returns: <[Promise]> Promise which resolves when the element matching `selector` is successfully clicked. The Promise will be rejected if there is no element matching `selector`.
|
||
|
||
This method fetches an element with `selector`, scrolls it into view if needed, and then uses [page.mouse](#pagemouse) to click in the center of the element.
|
||
If there's no element matching `selector`, the method throws an error.
|
||
|
||
Bear in mind that if `click()` triggers a navigation event and there's a separate `page.waitForNavigation()` promise to be resolved, you may end up with a race condition that yields unexpected results. The correct pattern for click and wait for navigation is the following:
|
||
|
||
```js
|
||
const [response] = await Promise.all([
|
||
page.waitForNavigation(waitOptions),
|
||
frame.click(selector, clickOptions),
|
||
]);
|
||
```
|
||
|
||
#### frame.content()
|
||
|
||
- returns: <[Promise]<[string]>>
|
||
|
||
Gets the full HTML contents of the frame, including the doctype.
|
||
|
||
#### frame.evaluate(pageFunction[, ...args])
|
||
|
||
- `pageFunction` <[function]|[string]> Function to be evaluated in browser context
|
||
- `...args` <...[Serializable]|[JSHandle]> Arguments to pass to `pageFunction`
|
||
- returns: <[Promise]<[Serializable]>> Promise which resolves to the return value of `pageFunction`
|
||
|
||
If the function passed to the `frame.evaluate` returns a [Promise], then `frame.evaluate` would wait for the promise to resolve and return its value.
|
||
|
||
If the function passed to the `frame.evaluate` returns a non-[Serializable] value, then `frame.evaluate` resolves to `undefined`. DevTools Protocol also supports transferring some additional values that are not serializable by `JSON`: `-0`, `NaN`, `Infinity`, `-Infinity`, and bigint literals.
|
||
|
||
```js
|
||
const result = await frame.evaluate(() => {
|
||
return Promise.resolve(8 * 7);
|
||
});
|
||
console.log(result); // prints "56"
|
||
```
|
||
|
||
A string can also be passed in instead of a function.
|
||
|
||
```js
|
||
console.log(await frame.evaluate('1 + 2')); // prints "3"
|
||
```
|
||
|
||
[ElementHandle] instances can be passed as arguments to the `frame.evaluate`:
|
||
|
||
```js
|
||
const bodyHandle = await frame.$('body');
|
||
const html = await frame.evaluate((body) => body.innerHTML, bodyHandle);
|
||
await bodyHandle.dispose();
|
||
```
|
||
|
||
#### frame.evaluateHandle(pageFunction[, ...args])
|
||
|
||
- `pageFunction` <[function]|[string]> Function to be evaluated in the page context
|
||
- `...args` <...[Serializable]|[JSHandle]> Arguments to pass to `pageFunction`
|
||
- returns: <[Promise]<[JSHandle]|[ElementHandle]>> Promise which resolves to the return value of `pageFunction` as an in-page object.
|
||
|
||
The only difference between `frame.evaluate` and `frame.evaluateHandle` is that `frame.evaluateHandle` returns in-page object (JSHandle).
|
||
|
||
If the function, passed to the `frame.evaluateHandle`, returns a [Promise], then `frame.evaluateHandle` would wait for the promise to resolve and return its value.
|
||
|
||
If the function returns an element, the returned handle is an [ElementHandle].
|
||
|
||
```js
|
||
const aWindowHandle = await frame.evaluateHandle(() => Promise.resolve(window));
|
||
aWindowHandle; // Handle for the window object.
|
||
```
|
||
|
||
A string can also be passed in instead of a function.
|
||
|
||
```js
|
||
const aHandle = await frame.evaluateHandle('document'); // Handle for the 'document'.
|
||
```
|
||
|
||
[JSHandle] instances can be passed as arguments to the `frame.evaluateHandle`:
|
||
|
||
```js
|
||
const aHandle = await frame.evaluateHandle(() => document.body);
|
||
const resultHandle = await frame.evaluateHandle(
|
||
(body) => body.innerHTML,
|
||
aHandle
|
||
);
|
||
console.log(await resultHandle.jsonValue());
|
||
await resultHandle.dispose();
|
||
```
|
||
|
||
#### frame.executionContext()
|
||
|
||
- returns: <[Promise]<[ExecutionContext]>>
|
||
|
||
Returns promise that resolves to the frame's default execution context.
|
||
|
||
#### frame.focus(selector)
|
||
|
||
- `selector` <[string]> A [selector] of an element to focus. If there are multiple elements satisfying the selector, the first will be focused.
|
||
- returns: <[Promise]> Promise which resolves when the element matching `selector` is successfully focused. The promise will be rejected if there is no element matching `selector`.
|
||
|
||
This method fetches an element with `selector` and focuses it.
|
||
If there's no element matching `selector`, the method throws an error.
|
||
|
||
#### frame.goto(url[, options])
|
||
|
||
- `url` <[string]> URL to navigate frame to. The URL should include scheme, e.g. `https://`.
|
||
- `options` <[Object]> Navigation parameters which might have the following properties:
|
||
- `timeout` <[number]> Maximum navigation time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed by using the [page.setDefaultNavigationTimeout(timeout)](#pagesetdefaultnavigationtimeouttimeout) or [page.setDefaultTimeout(timeout)](#pagesetdefaulttimeouttimeout) methods.
|
||
- `waitUntil` <"load"|"domcontentloaded"|"networkidle0"|"networkidle2"|Array<PuppeteerLifeCycleMethod>> When to consider navigation succeeded, defaults to `load`. Given an array of event strings, navigation is considered to be successful after all events have been fired. Events can be either:
|
||
- `load` - consider navigation to be finished when the `load` event is fired.
|
||
- `domcontentloaded` - consider navigation to be finished when the `DOMContentLoaded` event is fired.
|
||
- `networkidle0` - consider navigation to be finished when there are no more than 0 network connections for at least `500` ms.
|
||
- `networkidle2` - consider navigation to be finished when there are no more than 2 network connections for at least `500` ms.
|
||
- `referer` <[string]> Referer header value. If provided it will take preference over the referer header value set by [page.setExtraHTTPHeaders()](#pagesetextrahttpheadersheaders).
|
||
- returns: <[Promise]<?[HTTPResponse]>> Promise which resolves to the main resource response. In case of multiple redirects, the navigation will resolve with the response of the last redirect.
|
||
|
||
`frame.goto` will throw an error if:
|
||
|
||
- there's an SSL error (e.g. in case of self-signed certificates).
|
||
- target URL is invalid.
|
||
- the `timeout` is exceeded during navigation.
|
||
- the remote server does not respond or is unreachable.
|
||
- the main resource failed to load.
|
||
|
||
`frame.goto` will not throw an error when any valid HTTP status code is returned by the remote server, including 404 "Not Found" and 500 "Internal Server Error". The status code for such responses can be retrieved by calling [response.status()](#httpresponsestatus).
|
||
|
||
> **NOTE** `frame.goto` either throws an error or returns a main resource response. The only exceptions are navigation to `about:blank` or navigation to the same URL with a different hash, which would succeed and return `null`.
|
||
|
||
> **NOTE** Headless mode doesn't support navigation to a PDF document. See the [upstream issue](https://bugs.chromium.org/p/chromium/issues/detail?id=761295).
|
||
|
||
#### frame.hover(selector)
|
||
|
||
- `selector` <[string]> A [selector] to search for element to hover. If there are multiple elements satisfying the selector, the first will be hovered.
|
||
- returns: <[Promise]> Promise which resolves when the element matching `selector` is successfully hovered. Promise gets rejected if there's no element matching `selector`.
|
||
|
||
This method fetches an element with `selector`, scrolls it into view if needed, and then uses [page.mouse](#pagemouse) to hover over the center of the element.
|
||
If there's no element matching `selector`, the method throws an error.
|
||
|
||
#### frame.isDetached()
|
||
|
||
- returns: <[boolean]>
|
||
|
||
Returns `true` if the frame has been detached, or `false` otherwise.
|
||
|
||
#### frame.name()
|
||
|
||
- returns: <[string]>
|
||
|
||
Returns frame's name attribute as specified in the tag.
|
||
|
||
If the name is empty, returns the id attribute instead.
|
||
|
||
> **NOTE** This value is calculated once when the frame is created, and will not update if the attribute is changed later.
|
||
|
||
#### frame.parentFrame()
|
||
|
||
- returns: <?[Frame]> Parent frame, if any. Detached frames and main frames return `null`.
|
||
|
||
#### frame.select(selector, ...values)
|
||
|
||
- `selector` <[string]> A [selector] to query frame for
|
||
- `...values` <...[string]> Values of options to select. If the `<select>` has the `multiple` attribute, all values are considered, otherwise only the first one is taken into account.
|
||
- returns: <[Promise]<[Array]<[string]>>> An array of option values that have been successfully selected.
|
||
|
||
Triggers a `change` and `input` event once all the provided options have been selected.
|
||
If there's no `<select>` element matching `selector`, the method throws an error.
|
||
|
||
```js
|
||
frame.select('select#colors', 'blue'); // single selection
|
||
frame.select('select#colors', 'red', 'green', 'blue'); // multiple selections
|
||
```
|
||
|
||
#### frame.setContent(html[, options])
|
||
|
||
- `html` <[string]> HTML markup to assign to the page.
|
||
- `options` <[Object]> Parameters which might have the following properties:
|
||
- `timeout` <[number]> Maximum time in milliseconds for resources to load, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed by using the [page.setDefaultNavigationTimeout(timeout)](#pagesetdefaultnavigationtimeouttimeout) or [page.setDefaultTimeout(timeout)](#pagesetdefaulttimeouttimeout) methods.
|
||
- `waitUntil` <"load"|"domcontentloaded"|"networkidle0"|"networkidle2"|Array<PuppeteerLifeCycleMethod>> When to consider setting markup succeeded, defaults to `load`. Given an array of event strings, setting content is considered to be successful after all events have been fired. Events can be either:
|
||
- `load` - consider setting content to be finished when the `load` event is fired.
|
||
- `domcontentloaded` - consider setting content to be finished when the `DOMContentLoaded` event is fired.
|
||
- `networkidle0` - consider setting content to be finished when there are no more than 0 network connections for at least `500` ms.
|
||
- `networkidle2` - consider setting content to be finished when there are no more than 2 network connections for at least `500` ms.
|
||
- returns: <[Promise]>
|
||
|
||
#### frame.tap(selector)
|
||
|
||
- `selector` <[string]> A [selector] to search for element to tap. If there are multiple elements satisfying the selector, the first will be tapped.
|
||
- returns: <[Promise]>
|
||
|
||
This method fetches an element with `selector`, scrolls it into view if needed, and then uses [page.touchscreen](#pagetouchscreen) to tap in the center of the element.
|
||
If there's no element matching `selector`, the method throws an error.
|
||
|
||
#### frame.title()
|
||
|
||
- returns: <[Promise]<[string]>> The page's title.
|
||
|
||
#### frame.type(selector, text[, options])
|
||
|
||
- `selector` <[string]> A [selector] of an element to type into. If there are multiple elements satisfying the selector, the first will be used.
|
||
- `text` <[string]> A text to type into a focused element.
|
||
- `options` <[Object]>
|
||
- `delay` <[number]> Time to wait between key presses in milliseconds. Defaults to 0.
|
||
- returns: <[Promise]>
|
||
|
||
Sends a `keydown`, `keypress`/`input`, and `keyup` event for each character in the text.
|
||
|
||
To press a special key, like `Control` or `ArrowDown`, use [`keyboard.press`](#keyboardpresskey-options).
|
||
|
||
```js
|
||
await frame.type('#mytextarea', 'Hello'); // Types instantly
|
||
await frame.type('#mytextarea', 'World', { delay: 100 }); // Types slower, like a user
|
||
```
|
||
|
||
#### frame.url()
|
||
|
||
- returns: <[string]>
|
||
|
||
Returns frame's URL.
|
||
|
||
#### frame.waitFor(selectorOrFunctionOrTimeout[, options[, ...args]])
|
||
|
||
- `selectorOrFunctionOrTimeout` <[string]|[number]|[function]> A [selector], predicate or timeout to wait for
|
||
- `options` <[Object]> Optional waiting parameters
|
||
- `...args` <...[Serializable]|[JSHandle]> Arguments to pass to `pageFunction`
|
||
- returns: <[Promise]<[JSHandle]>> Promise which resolves to a JSHandle of the success value
|
||
|
||
**This method is deprecated**. You should use the more explicit API methods available:
|
||
|
||
- `frame.waitForSelector`
|
||
- `frame.waitForXPath`
|
||
- `frame.waitForFunction`
|
||
- `frame.waitForTimeout`
|
||
|
||
This method behaves differently with respect to the type of the first parameter:
|
||
|
||
- if `selectorOrFunctionOrTimeout` is a `string`, then the first argument is treated as a [selector] or [xpath], depending on whether or not it starts with '//', and the method is a shortcut for
|
||
[frame.waitForSelector](#framewaitforselectorselector-options) or [frame.waitForXPath](#framewaitforxpathxpath-options)
|
||
- if `selectorOrFunctionOrTimeout` is a `function`, then the first argument is treated as a predicate to wait for and the method is a shortcut for [frame.waitForFunction()](#framewaitforfunctionpagefunction-options-args).
|
||
- if `selectorOrFunctionOrTimeout` is a `number`, then the first argument is treated as a timeout in milliseconds and the method returns a promise which resolves after the timeout
|
||
- otherwise, an exception is thrown
|
||
|
||
```js
|
||
// wait for selector
|
||
await page.waitFor('.foo');
|
||
// wait for 1 second
|
||
await page.waitFor(1000);
|
||
// wait for predicate
|
||
await page.waitFor(() => !!document.querySelector('.foo'));
|
||
```
|
||
|
||
To pass arguments from node.js to the predicate of `page.waitFor` function:
|
||
|
||
```js
|
||
const selector = '.foo';
|
||
await page.waitFor(
|
||
(selector) => !!document.querySelector(selector),
|
||
{},
|
||
selector
|
||
);
|
||
```
|
||
|
||
#### frame.waitForFunction(pageFunction[, options[, ...args]])
|
||
|
||
- `pageFunction` <[function]|[string]> Function to be evaluated in browser context
|
||
- `options` <[Object]> Optional waiting parameters
|
||
- `polling` <[string]|[number]> An interval at which the `pageFunction` is executed, defaults to `raf`. If `polling` is a number, then it is treated as an interval in milliseconds at which the function would be executed. If `polling` is a string, then it can be one of the following values:
|
||
- `raf` - to constantly execute `pageFunction` in `requestAnimationFrame` callback. This is the tightest polling mode which is suitable to observe styling changes.
|
||
- `mutation` - to execute `pageFunction` on every DOM mutation.
|
||
- `timeout` <[number]> maximum time to wait for in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can be changed by using the [page.setDefaultTimeout(timeout)](#pagesetdefaulttimeouttimeout) method.
|
||
- `...args` <...[Serializable]|[JSHandle]> Arguments to pass to `pageFunction`
|
||
- returns: <[Promise]<[JSHandle]>> Promise which resolves when the `pageFunction` returns a truthy value. It resolves to a JSHandle of the truthy value.
|
||
|
||
The `waitForFunction` can be used to observe viewport size change:
|
||
|
||
```js
|
||
const puppeteer = require('puppeteer');
|
||
|
||
(async () => {
|
||
const browser = await puppeteer.launch();
|
||
const page = await browser.newPage();
|
||
const watchDog = page.mainFrame().waitForFunction('window.innerWidth < 100');
|
||
page.setViewport({ width: 50, height: 50 });
|
||
await watchDog;
|
||
await browser.close();
|
||
})();
|
||
```
|
||
|
||
To pass arguments from node.js to the predicate of `page.waitForFunction` function:
|
||
|
||
```js
|
||
const selector = '.foo';
|
||
await page.waitForFunction(
|
||
(selector) => !!document.querySelector(selector),
|
||
{},
|
||
selector
|
||
);
|
||
```
|
||
|
||
#### frame.waitForNavigation([options])
|
||
|
||
- `options` <[Object]> Navigation parameters which might have the following properties:
|
||
- `timeout` <[number]> Maximum navigation time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed by using the [page.setDefaultNavigationTimeout(timeout)](#pagesetdefaultnavigationtimeouttimeout) or [page.setDefaultTimeout(timeout)](#pagesetdefaulttimeouttimeout) methods.
|
||
- `waitUntil` <"load"|"domcontentloaded"|"networkidle0"|"networkidle2"|Array<PuppeteerLifeCycleMethod>> When to consider navigation succeeded, defaults to `load`. Given an array of event strings, navigation is considered to be successful after all events have been fired. Events can be either:
|
||
- `load` - consider navigation to be finished when the `load` event is fired.
|
||
- `domcontentloaded` - consider navigation to be finished when the `DOMContentLoaded` event is fired.
|
||
- `networkidle0` - consider navigation to be finished when there are no more than 0 network connections for at least `500` ms.
|
||
- `networkidle2` - consider navigation to be finished when there are no more than 2 network connections for at least `500` ms.
|
||
- returns: <[Promise]<?[HTTPResponse]>> Promise which resolves to the main resource response. In case of multiple redirects, the navigation will resolve with the response of the last redirect. In case of navigation to a different anchor or navigation due to History API usage, the navigation will resolve with `null`.
|
||
|
||
This resolves when the frame navigates to a new URL. It is useful when you run code
|
||
that will indirectly cause the frame to navigate. Consider this example:
|
||
|
||
```js
|
||
const [response] = await Promise.all([
|
||
frame.waitForNavigation(), // The navigation promise resolves after navigation has finished
|
||
frame.click('a.my-link'), // Clicking the link will indirectly cause a navigation
|
||
]);
|
||
```
|
||
|
||
**NOTE** Usage of the [History API](https://developer.mozilla.org/en-US/docs/Web/API/History_API) to change the URL is considered a navigation.
|
||
|
||
#### frame.waitForSelector(selector[, options])
|
||
|
||
- `selector` <[string]> A [selector] of an element to wait for
|
||
- `options` <[Object]> Optional waiting parameters
|
||
- `visible` <[boolean]> wait for element to be present in DOM and to be visible, i.e. to not have `display: none` or `visibility: hidden` CSS properties. Defaults to `false`.
|
||
- `hidden` <[boolean]> wait for element to not be found in the DOM or to be hidden, i.e. have `display: none` or `visibility: hidden` CSS properties. Defaults to `false`.
|
||
- `timeout` <[number]> maximum time to wait for in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can be changed by using the [page.setDefaultTimeout(timeout)](#pagesetdefaulttimeouttimeout) method.
|
||
- returns: <[Promise]<?[ElementHandle]>> Promise which resolves when element specified by selector string is added to DOM. Resolves to `null` if waiting for `hidden: true` and selector is not found in DOM.
|
||
|
||
Wait for the `selector` to appear in page. If at the moment of calling
|
||
the method the `selector` already exists, the method will return
|
||
immediately. If the selector doesn't appear after the `timeout` milliseconds of waiting, the function will throw.
|
||
|
||
This method works across navigations:
|
||
|
||
```js
|
||
const puppeteer = require('puppeteer');
|
||
|
||
(async () => {
|
||
const browser = await puppeteer.launch();
|
||
const page = await browser.newPage();
|
||
let currentURL;
|
||
page
|
||
.mainFrame()
|
||
.waitForSelector('img')
|
||
.then(() => console.log('First URL with image: ' + currentURL));
|
||
for (currentURL of [
|
||
'https://example.com',
|
||
'https://google.com',
|
||
'https://bbc.com',
|
||
]) {
|
||
await page.goto(currentURL);
|
||
}
|
||
await browser.close();
|
||
})();
|
||
```
|
||
|
||
#### frame.waitForTimeout(milliseconds)
|
||
|
||
- `milliseconds` <[number]> The number of milliseconds to wait for.
|
||
- returns: <[Promise]> Promise which resolves after the timeout has been completed.
|
||
|
||
Pauses script execution for the given number of seconds before continuing:
|
||
|
||
```js
|
||
const puppeteer = require('puppeteer');
|
||
|
||
(async () => {
|
||
const browser = await puppeteer.launch();
|
||
const page = await browser.newPage();
|
||
page
|
||
.mainFrame()
|
||
.waitForTimeout(1000)
|
||
.then(() => console.log('Waited a second!'));
|
||
|
||
await browser.close();
|
||
})();
|
||
```
|
||
|
||
#### frame.waitForXPath(xpath[, options])
|
||
|
||
- `xpath` <[string]> A [xpath] of an element to wait for
|
||
- `options` <[Object]> Optional waiting parameters
|
||
- `visible` <[boolean]> wait for element to be present in DOM and to be visible, i.e. to not have `display: none` or `visibility: hidden` CSS properties. Defaults to `false`.
|
||
- `hidden` <[boolean]> wait for element to not be found in the DOM or to be hidden, i.e. have `display: none` or `visibility: hidden` CSS properties. Defaults to `false`.
|
||
- `timeout` <[number]> maximum time to wait for in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can be changed by using the [page.setDefaultTimeout(timeout)](#pagesetdefaulttimeouttimeout) method.
|
||
- returns: <[Promise]<?[ElementHandle]>> Promise which resolves when element specified by xpath string is added to DOM. Resolves to `null` if waiting for `hidden: true` and xpath is not found in DOM.
|
||
|
||
Wait for the `xpath` to appear in page. If at the moment of calling
|
||
the method the `xpath` already exists, the method will return
|
||
immediately. If the xpath doesn't appear after the `timeout` milliseconds of waiting, the function will throw.
|
||
|
||
This method works across navigations:
|
||
|
||
```js
|
||
const puppeteer = require('puppeteer');
|
||
|
||
(async () => {
|
||
const browser = await puppeteer.launch();
|
||
const page = await browser.newPage();
|
||
let currentURL;
|
||
page
|
||
.mainFrame()
|
||
.waitForXPath('//img')
|
||
.then(() => console.log('First URL with image: ' + currentURL));
|
||
for (currentURL of [
|
||
'https://example.com',
|
||
'https://google.com',
|
||
'https://bbc.com',
|
||
]) {
|
||
await page.goto(currentURL);
|
||
}
|
||
await browser.close();
|
||
})();
|
||
```
|
||
|
||
### class: ExecutionContext
|
||
|
||
The class represents a context for JavaScript execution. A [Page] might have many execution contexts:
|
||
|
||
- each [frame](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe) has "default" execution context that is
|
||
always created after frame is attached to DOM. This context is returned by the [`frame.executionContext()`](#frameexecutioncontext) method.
|
||
- [Extensions](https://developer.chrome.com/extensions)'s content scripts create additional execution contexts.
|
||
|
||
Besides pages, execution contexts can be found in [workers](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API).
|
||
|
||
#### executionContext.evaluate(pageFunction[, ...args])
|
||
|
||
- `pageFunction` <[function]|[string]> Function to be evaluated in `executionContext`
|
||
- `...args` <...[Serializable]|[JSHandle]> Arguments to pass to `pageFunction`
|
||
- returns: <[Promise]<[Serializable]>> Promise which resolves to the return value of `pageFunction`
|
||
|
||
If the function passed to the `executionContext.evaluate` returns a [Promise], then `executionContext.evaluate` would wait for the promise to resolve and return its value.
|
||
|
||
If the function passed to the `executionContext.evaluate` returns a non-[Serializable] value, then `executionContext.evaluate` resolves to `undefined`. DevTools Protocol also supports transferring some additional values that are not serializable by `JSON`: `-0`, `NaN`, `Infinity`, `-Infinity`, and bigint literals.
|
||
|
||
```js
|
||
const executionContext = await page.mainFrame().executionContext();
|
||
const result = await executionContext.evaluate(() => Promise.resolve(8 * 7));
|
||
console.log(result); // prints "56"
|
||
```
|
||
|
||
A string can also be passed in instead of a function.
|
||
|
||
```js
|
||
console.log(await executionContext.evaluate('1 + 2')); // prints "3"
|
||
```
|
||
|
||
[JSHandle] instances can be passed as arguments to the `executionContext.evaluate`:
|
||
|
||
```js
|
||
const oneHandle = await executionContext.evaluateHandle(() => 1);
|
||
const twoHandle = await executionContext.evaluateHandle(() => 2);
|
||
const result = await executionContext.evaluate(
|
||
(a, b) => a + b,
|
||
oneHandle,
|
||
twoHandle
|
||
);
|
||
await oneHandle.dispose();
|
||
await twoHandle.dispose();
|
||
console.log(result); // prints '3'.
|
||
```
|
||
|
||
#### executionContext.evaluateHandle(pageFunction[, ...args])
|
||
|
||
- `pageFunction` <[function]|[string]> Function to be evaluated in the `executionContext`
|
||
- `...args` <...[Serializable]|[JSHandle]> Arguments to pass to `pageFunction`
|
||
- returns: <[Promise]<[JSHandle]|[ElementHandle]>> Promise which resolves to the return value of `pageFunction` as an in-page object.
|
||
|
||
The only difference between `executionContext.evaluate` and `executionContext.evaluateHandle` is that `executionContext.evaluateHandle` returns in-page object (JSHandle).
|
||
|
||
If the function returns an element, the returned handle is an [ElementHandle].
|
||
|
||
If the function passed to the `executionContext.evaluateHandle` returns a [Promise], then `executionContext.evaluateHandle` would wait for the promise to resolve and return its value.
|
||
|
||
```js
|
||
const context = await page.mainFrame().executionContext();
|
||
const aHandle = await context.evaluateHandle(() => Promise.resolve(self));
|
||
aHandle; // Handle for the global object.
|
||
```
|
||
|
||
A string can also be passed in instead of a function.
|
||
|
||
```js
|
||
const aHandle = await context.evaluateHandle('1 + 2'); // Handle for the '3' object.
|
||
```
|
||
|
||
[JSHandle] instances can be passed as arguments to the `executionContext.evaluateHandle`:
|
||
|
||
```js
|
||
const aHandle = await context.evaluateHandle(() => document.body);
|
||
const resultHandle = await context.evaluateHandle(
|
||
(body) => body.innerHTML,
|
||
aHandle
|
||
);
|
||
console.log(await resultHandle.jsonValue()); // prints body's innerHTML
|
||
await aHandle.dispose();
|
||
await resultHandle.dispose();
|
||
```
|
||
|
||
#### executionContext.frame()
|
||
|
||
- returns: <?[Frame]> Frame associated with this execution context.
|
||
|
||
> **NOTE** Not every execution context is associated with a frame. For example, workers and extensions have execution contexts that are not associated with frames.
|
||
|
||
#### executionContext.queryObjects(prototypeHandle)
|
||
|
||
- `prototypeHandle` <[JSHandle]> A handle to the object prototype.
|
||
- returns: <[Promise]<[JSHandle]>> A handle to an array of objects with this prototype
|
||
|
||
The method iterates the JavaScript heap and finds all the objects with the given prototype.
|
||
|
||
```js
|
||
// Create a Map object
|
||
await page.evaluate(() => (window.map = new Map()));
|
||
// Get a handle to the Map object prototype
|
||
const mapPrototype = await page.evaluateHandle(() => Map.prototype);
|
||
// Query all map instances into an array
|
||
const mapInstances = await page.queryObjects(mapPrototype);
|
||
// Count amount of map objects in heap
|
||
const count = await page.evaluate((maps) => maps.length, mapInstances);
|
||
await mapInstances.dispose();
|
||
await mapPrototype.dispose();
|
||
```
|
||
|
||
### class: JSHandle
|
||
|
||
JSHandle represents an in-page JavaScript object. JSHandles can be created with the [page.evaluateHandle](#pageevaluatehandlepagefunction-args) method.
|
||
|
||
```js
|
||
const windowHandle = await page.evaluateHandle(() => window);
|
||
// ...
|
||
```
|
||
|
||
JSHandle prevents the referenced JavaScript object from garbage collection unless the handle is [disposed](#jshandledispose). JSHandles are auto-disposed when their origin frame gets navigated or the parent context gets destroyed.
|
||
|
||
JSHandle instances can be used as arguments in [`page.$eval()`](#pageevalselector-pagefunction-args), [`page.evaluate()`](#pageevaluatepagefunction-args) and [`page.evaluateHandle`](#pageevaluatehandlepagefunction-args) methods.
|
||
|
||
#### jsHandle.asElement()
|
||
|
||
- returns: <?[ElementHandle]>
|
||
|
||
Returns either `null` or the object handle itself if the object handle is an instance of [ElementHandle].
|
||
|
||
#### jsHandle.dispose()
|
||
|
||
- returns: <[Promise]> Promise which resolves when the object handle is successfully disposed.
|
||
|
||
The `jsHandle.dispose` method stops referencing the element handle.
|
||
|
||
#### jsHandle.evaluate(pageFunction[, ...args])
|
||
|
||
- `pageFunction` <[function]\([Object]\)> Function to be evaluated in browser context
|
||
- `...args` <...[Serializable]|[JSHandle]> Arguments to pass to `pageFunction`
|
||
- returns: <[Promise]<[Serializable]>> Promise which resolves to the return value of `pageFunction`
|
||
|
||
This method passes this handle as the first argument to `pageFunction`.
|
||
|
||
If `pageFunction` returns a [Promise], then `handle.evaluate` would wait for the promise to resolve and return its value.
|
||
|
||
Examples:
|
||
|
||
```js
|
||
const tweetHandle = await page.$('.tweet .retweets');
|
||
expect(await tweetHandle.evaluate((node) => node.innerText)).toBe('10');
|
||
```
|
||
|
||
#### jsHandle.evaluateHandle(pageFunction[, ...args])
|
||
|
||
- `pageFunction` <[function]|[string]> Function to be evaluated
|
||
- `...args` <...[Serializable]|[JSHandle]> Arguments to pass to `pageFunction`
|
||
- returns: <[Promise]<[JSHandle]|[ElementHandle]>> Promise which resolves to the return value of `pageFunction` as an in-page object.
|
||
|
||
This method passes this handle as the first argument to `pageFunction`.
|
||
|
||
The only difference between `jsHandle.evaluate` and `jsHandle.evaluateHandle` is that `executionContext.evaluateHandle` returns in-page object (JSHandle).
|
||
|
||
If the function returns an element, the returned handle is an [ElementHandle].
|
||
|
||
If the function passed to the `jsHandle.evaluateHandle` returns a [Promise], then `jsHandle.evaluateHandle` would wait for the promise to resolve and return its value.
|
||
|
||
See [Page.evaluateHandle](#pageevaluatehandlepagefunction-args) for more details.
|
||
|
||
#### jsHandle.executionContext()
|
||
|
||
- returns: <[ExecutionContext]>
|
||
|
||
Returns execution context the handle belongs to.
|
||
|
||
#### jsHandle.getProperties()
|
||
|
||
- returns: <[Promise]<[Map]<[string], [JSHandle]>>>
|
||
|
||
The method returns a map with property names as keys and JSHandle instances for the property values.
|
||
|
||
```js
|
||
const handle = await page.evaluateHandle(() => ({ window, document }));
|
||
const properties = await handle.getProperties();
|
||
const windowHandle = properties.get('window');
|
||
const documentHandle = properties.get('document');
|
||
await handle.dispose();
|
||
```
|
||
|
||
#### jsHandle.getProperty(propertyName)
|
||
|
||
- `propertyName` <[string]> property to get
|
||
- returns: <[Promise]<[JSHandle]>>
|
||
|
||
Fetches a single property from the referenced object.
|
||
|
||
#### jsHandle.jsonValue()
|
||
|
||
- returns: <[Promise]<[Object]>>
|
||
|
||
Returns a JSON representation of the object. If the object has a
|
||
[`toJSON`](<https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#toJSON()_behavior>)
|
||
function, it **will not be called**.
|
||
|
||
> **NOTE** The method will return an empty JSON object if the referenced object is not stringifiable. It will throw an error if the object has circular references.
|
||
|
||
### class: ElementHandle
|
||
|
||
- extends: [JSHandle]
|
||
|
||
ElementHandle represents an in-page DOM element. ElementHandles can be created with the [page.$](#pageselector) method.
|
||
|
||
```js
|
||
const puppeteer = require('puppeteer');
|
||
|
||
(async () => {
|
||
const browser = await puppeteer.launch();
|
||
const page = await browser.newPage();
|
||
await page.goto('https://example.com');
|
||
const hrefElement = await page.$('a');
|
||
await hrefElement.click();
|
||
// ...
|
||
})();
|
||
```
|
||
|
||
ElementHandle prevents DOM element from garbage collection unless the handle is [disposed](#elementhandledispose). ElementHandles are auto-disposed when their origin frame gets navigated.
|
||
|
||
ElementHandle instances can be used as arguments in [`page.$eval()`](#pageevalselector-pagefunction-args) and [`page.evaluate()`](#pageevaluatepagefunction-args) methods.
|
||
|
||
#### elementHandle.$(selector)
|
||
|
||
- `selector` <[string]> A [selector] to query element for
|
||
- returns: <[Promise]<?[ElementHandle]>>
|
||
|
||
The method runs `element.querySelector` within the page. If no element matches the selector, the return value resolves to `null`.
|
||
|
||
#### elementHandle.$$(selector)
|
||
|
||
- `selector` <[string]> A [selector] to query element for
|
||
- returns: <[Promise]<[Array]<[ElementHandle]>>>
|
||
|
||
The method runs `element.querySelectorAll` within the page. If no elements match the selector, the return value resolves to `[]`.
|
||
|
||
#### elementHandle.$$eval(selector, pageFunction[, ...args])
|
||
|
||
- `selector` <[string]> A [selector] to query page for
|
||
- `pageFunction` <[function]\([Array]<[Element]>\)> Function to be evaluated in browser context
|
||
- `...args` <...[Serializable]|[JSHandle]> Arguments to pass to `pageFunction`
|
||
- returns: <[Promise]<[Serializable]>> Promise which resolves to the return value of `pageFunction`
|
||
|
||
This method runs `document.querySelectorAll` within the element and passes it as the first argument to `pageFunction`. If there's no element matching `selector`, the method throws an error.
|
||
|
||
If `pageFunction` returns a [Promise], then `frame.$$eval` would wait for the promise to resolve and return its value.
|
||
|
||
Examples:
|
||
|
||
```html
|
||
<div class="feed">
|
||
<div class="tweet">Hello!</div>
|
||
<div class="tweet">Hi!</div>
|
||
</div>
|
||
```
|
||
|
||
```js
|
||
const feedHandle = await page.$('.feed');
|
||
expect(
|
||
await feedHandle.$$eval('.tweet', (nodes) => nodes.map((n) => n.innerText))
|
||
).toEqual(['Hello!', 'Hi!']);
|
||
```
|
||
|
||
#### elementHandle.$eval(selector, pageFunction[, ...args])
|
||
|
||
- `selector` <[string]> A [selector] to query page for
|
||
- `pageFunction` <[function]\([Element]\)> Function to be evaluated in browser context
|
||
- `...args` <...[Serializable]|[JSHandle]> Arguments to pass to `pageFunction`
|
||
- returns: <[Promise]<[Serializable]>> Promise which resolves to the return value of `pageFunction`
|
||
|
||
This method runs `document.querySelector` within the element and passes it as the first argument to `pageFunction`. If there's no element matching `selector`, the method throws an error.
|
||
|
||
If `pageFunction` returns a [Promise], then `frame.$eval` would wait for the promise to resolve and return its value.
|
||
|
||
Examples:
|
||
|
||
```js
|
||
const tweetHandle = await page.$('.tweet');
|
||
expect(await tweetHandle.$eval('.like', (node) => node.innerText)).toBe('100');
|
||
expect(await tweetHandle.$eval('.retweets', (node) => node.innerText)).toBe(
|
||
'10'
|
||
);
|
||
```
|
||
|
||
#### elementHandle.$x(expression)
|
||
|
||
- `expression` <[string]> Expression to [evaluate](https://developer.mozilla.org/en-US/docs/Web/API/Document/evaluate).
|
||
- returns: <[Promise]<[Array]<[ElementHandle]>>>
|
||
|
||
The method evaluates the XPath expression relative to the `elementHandle` as its context node. If there are no such elements, the method resolves to an empty array.
|
||
|
||
The `expression` should have the context node to be evaluated properly:
|
||
|
||
```js
|
||
const [childHandle] = await parentHandle.$x('./div');
|
||
```
|
||
|
||
#### elementHandle.asElement()
|
||
|
||
- returns: <[ElementHandle]>
|
||
|
||
#### elementHandle.boundingBox()
|
||
|
||
- returns: <[Promise]<?[Object]>>
|
||
- x <[number]> the x coordinate of the element in pixels.
|
||
- y <[number]> the y coordinate of the element in pixels.
|
||
- width <[number]> the width of the element in pixels.
|
||
- height <[number]> the height of the element in pixels.
|
||
|
||
This method returns the bounding box of the element (relative to the main frame), or `null` if the element is not visible.
|
||
|
||
#### elementHandle.boxModel()
|
||
|
||
- returns: <[Promise]<?[Object]>>
|
||
- content <[Array]<[Object]>> Content box.
|
||
- x <[number]>
|
||
- y <[number]>
|
||
- padding <[Array]<[Object]>> Padding box.
|
||
- x <[number]>
|
||
- y <[number]>
|
||
- border <[Array]<[Object]>> Border box.
|
||
- x <[number]>
|
||
- y <[number]>
|
||
- margin <[Array]<[Object]>> Margin box.
|
||
- x <[number]>
|
||
- y <[number]>
|
||
- width <[number]> Element's width.
|
||
- height <[number]> Element's height.
|
||
|
||
This method returns boxes of the element, or `null` if the element is not visible. Boxes are represented as an array of points; each Point is an object `{x, y}`. Box points are sorted clock-wise.
|
||
|
||
#### elementHandle.click([options])
|
||
|
||
- `options` <[Object]>
|
||
- `button` <"left"|"right"|"middle"> Defaults to `left`.
|
||
- `clickCount` <[number]> defaults to 1. See [UIEvent.detail].
|
||
- `delay` <[number]> Time to wait between `mousedown` and `mouseup` in milliseconds. Defaults to 0.
|
||
- `offset` <[Object]> Offset in pixels relative to the top-left corder of the border box of the element.
|
||
- `x` <number> x-offset in pixels relative to the top-left corder of the border box of the element.
|
||
- `y` <number> y-offset in pixels relative to the top-left corder of the border box of the element.
|
||
- returns: <[Promise]> Promise which resolves when the element is successfully clicked. Promise gets rejected if the element is detached from DOM.
|
||
|
||
This method scrolls element into view if needed, and then uses [page.mouse](#pagemouse) to click in the center of the element.
|
||
If the element is detached from DOM, the method throws an error.
|
||
|
||
#### elementHandle.clickablePoint([offset])
|
||
|
||
- `offset` <[Object]>
|
||
- `x` <number> x-offset in pixels relative to the top-left corder of the border box of the element.
|
||
- `y` <number> y-offset in pixels relative to the top-left corder of the border box of the element.
|
||
- returns: <[Promise<[Point]>]> Resolves to the x, y point that describes the element's position.
|
||
|
||
#### elementHandle.contentFrame()
|
||
|
||
- returns: <[Promise]<?[Frame]>> Resolves to the content frame for element handles referencing iframe nodes, or null otherwise
|
||
|
||
#### elementHandle.dispose()
|
||
|
||
- returns: <[Promise]> Promise which resolves when the element handle is successfully disposed.
|
||
|
||
The `elementHandle.dispose` method stops referencing the element handle.
|
||
|
||
#### elementHandle.drag(target)
|
||
|
||
- `target` <[Object]>
|
||
- `x` <[number]> x coordinate
|
||
- `y` <[number]> y coordinate
|
||
- returns: <[Promise<[DragData]>]>
|
||
|
||
This method creates and captures a drag event from the element.
|
||
|
||
#### elementHandle.dragAndDrop(target[, options])
|
||
|
||
- `target` <[ElementHandle]>
|
||
- `options` <[Object]>
|
||
- `delay` <[number]> how long to delay before dropping onto the target element
|
||
- returns: <[Promise]>
|
||
|
||
This method will drag a given element and drop it onto a target element.
|
||
|
||
#### elementHandle.dragEnter([data])
|
||
|
||
- `data` <[Object]> drag data created from `element.drag`
|
||
- returns: <[Promise]>
|
||
|
||
This method will trigger a dragenter event from the given element.
|
||
|
||
#### elementHandle.dragOver([data])
|
||
|
||
- `data` <[Object]> drag data created from `element.drag`
|
||
- returns: <[Promise]>
|
||
|
||
This method will trigger a dragover event from the given element.
|
||
|
||
#### elementHandle.drop([data])
|
||
|
||
- `data` <[Object]> drag data created from `element.drag`
|
||
- returns: <[Promise]>
|
||
|
||
This method will trigger a drop event from the given element.
|
||
|
||
#### elementHandle.evaluate(pageFunction[, ...args])
|
||
|
||
- `pageFunction` <[function]\([Object]\)> Function to be evaluated in browser context
|
||
- `...args` <...[Serializable]|[JSHandle]> Arguments to pass to `pageFunction`
|
||
- returns: <[Promise]<[Serializable]>> Promise which resolves to the return value of `pageFunction`
|
||
|
||
This method passes this handle as the first argument to `pageFunction`.
|
||
|
||
If `pageFunction` returns a [Promise], then `handle.evaluate` would wait for the promise to resolve and return its value.
|
||
|
||
Examples:
|
||
|
||
```js
|
||
const tweetHandle = await page.$('.tweet .retweets');
|
||
expect(await tweetHandle.evaluate((node) => node.innerText)).toBe('10');
|
||
```
|
||
|
||
#### elementHandle.evaluateHandle(pageFunction[, ...args])
|
||
|
||
- `pageFunction` <[function]|[string]> Function to be evaluated
|
||
- `...args` <...[Serializable]|[JSHandle]> Arguments to pass to `pageFunction`
|
||
- returns: <[Promise]<[JSHandle]|[ElementHandle]>> Promise which resolves to the return value of `pageFunction` as an in-page object.
|
||
|
||
This method passes this handle as the first argument to `pageFunction`.
|
||
|
||
The only difference between `elementHandle.evaluate` and `elementHandle.evaluateHandle` is that `executionContext.evaluateHandle` returns in-page object (JSHandle).
|
||
|
||
If the function returns an element, the returned handle is an [ElementHandle].
|
||
|
||
If the function passed to the `elementHandle.evaluateHandle` returns a [Promise], then `elementHandle.evaluateHandle` would wait for the promise to resolve and return its value.
|
||
|
||
See [Page.evaluateHandle](#pageevaluatehandlepagefunction-args) for more details.
|
||
|
||
#### elementHandle.executionContext()
|
||
|
||
- returns: <[ExecutionContext]>
|
||
|
||
#### elementHandle.focus()
|
||
|
||
- returns: <[Promise]>
|
||
|
||
Calls [focus](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus) on the element.
|
||
|
||
#### elementHandle.getProperties()
|
||
|
||
- returns: <[Promise]<[Map]<[string], [JSHandle]>>>
|
||
|
||
The method returns a map with property names as keys and JSHandle instances for the property values.
|
||
|
||
```js
|
||
const listHandle = await page.evaluateHandle(() => document.body.children);
|
||
const properties = await listHandle.getProperties();
|
||
const children = [];
|
||
for (const property of properties.values()) {
|
||
const element = property.asElement();
|
||
if (element) children.push(element);
|
||
}
|
||
children; // holds elementHandles to all children of document.body
|
||
```
|
||
|
||
#### elementHandle.getProperty(propertyName)
|
||
|
||
- `propertyName` <[string]> property to get
|
||
- returns: <[Promise]<[JSHandle]>>
|
||
|
||
Fetches a single property from the objectHandle.
|
||
|
||
#### elementHandle.hover()
|
||
|
||
- returns: <[Promise]> Promise which resolves when the element is successfully hovered.
|
||
|
||
This method scrolls element into view if needed, and then uses [page.mouse](#pagemouse) to hover over the center of the element.
|
||
If the element is detached from DOM, the method throws an error.
|
||
|
||
#### elementHandle.isIntersectingViewport([options])
|
||
- `options` <[Object]>
|
||
- `threshold` <[number]> threshold for the intersection between 0 (no intersection) and 1 (full intersection). Defaults to 1.
|
||
- returns: <[Promise]<[boolean]>> Resolves to true if the element is visible in the current viewport.
|
||
|
||
#### elementHandle.jsonValue()
|
||
|
||
- returns: <[Promise]<[Object]>>
|
||
|
||
Returns a JSON representation of the object. The JSON is generated by running [`JSON.stringify`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify) on the object in page and consequent [`JSON.parse`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse) in puppeteer.
|
||
|
||
> **NOTE** The method will throw if the referenced object is not stringifiable.
|
||
|
||
#### elementHandle.press(key[, options])
|
||
|
||
- `key` <[string]> Name of key to press, such as `ArrowLeft`. See [USKeyboardLayout] for a list of all key names.
|
||
- `options` <[Object]>
|
||
- `text` <[string]> If specified, generates an input event with this text.
|
||
- `delay` <[number]> Time to wait between `keydown` and `keyup` in milliseconds. Defaults to 0.
|
||
- returns: <[Promise]>
|
||
|
||
Focuses the element, and then uses [`keyboard.down`](#keyboarddownkey-options) and [`keyboard.up`](#keyboardupkey).
|
||
|
||
If `key` is a single character and no modifier keys besides `Shift` are being held down, a `keypress`/`input` event will also be generated. The `text` option can be specified to force an input event to be generated.
|
||
|
||
> **NOTE** Modifier keys DO affect `elementHandle.press`. Holding down `Shift` will type the text in upper case.
|
||
|
||
#### elementHandle.screenshot([options])
|
||
|
||
- `options` <[Object]> Same options as in [page.screenshot](#pagescreenshotoptions).
|
||
- returns: <[Promise]<[string]|[Buffer]>> Promise which resolves to buffer or a base64 string (depending on the value of `options.encoding`) with captured screenshot.
|
||
|
||
This method scrolls element into view if needed, and then uses [page.screenshot](#pagescreenshotoptions) to take a screenshot of the element.
|
||
If the element is detached from DOM, the method throws an error.
|
||
|
||
#### elementHandle.select(...values)
|
||
|
||
- `...values` <...[string]> Values of options to select. If the `<select>` has the `multiple` attribute, all values are considered, otherwise only the first one is taken into account.
|
||
- returns: <[Promise]<[Array]<[string]>>> An array of option values that have been successfully selected.
|
||
|
||
Triggers a `change` and `input` event once all the provided options have been selected.
|
||
If there's no `<select>` element matching `selector`, the method throws an error.
|
||
|
||
```js
|
||
handle.select('blue'); // single selection
|
||
handle.select('red', 'green', 'blue'); // multiple selections
|
||
```
|
||
|
||
#### elementHandle.tap()
|
||
|
||
- returns: <[Promise]> Promise which resolves when the element is successfully tapped. Promise gets rejected if the element is detached from DOM.
|
||
|
||
This method scrolls element into view if needed, and then uses [touchscreen.tap](#touchscreentapx-y) to tap in the center of the element.
|
||
If the element is detached from DOM, the method throws an error.
|
||
|
||
#### elementHandle.toString()
|
||
|
||
- returns: <[string]>
|
||
|
||
#### elementHandle.type(text[, options])
|
||
|
||
- `text` <[string]> A text to type into a focused element.
|
||
- `options` <[Object]>
|
||
- `delay` <[number]> Time to wait between key presses in milliseconds. Defaults to 0.
|
||
- returns: <[Promise]>
|
||
|
||
Focuses the element, and then sends a `keydown`, `keypress`/`input`, and `keyup` event for each character in the text.
|
||
|
||
To press a special key, like `Control` or `ArrowDown`, use [`elementHandle.press`](#elementhandlepresskey-options).
|
||
|
||
```js
|
||
await elementHandle.type('Hello'); // Types instantly
|
||
await elementHandle.type('World', { delay: 100 }); // Types slower, like a user
|
||
```
|
||
|
||
An example of typing into a text field and then submitting the form:
|
||
|
||
```js
|
||
const elementHandle = await page.$('input');
|
||
await elementHandle.type('some text');
|
||
await elementHandle.press('Enter');
|
||
```
|
||
|
||
#### elementHandle.uploadFile(...filePaths)
|
||
|
||
- `...filePaths` <...[string]> Sets the value of the file input to these paths. If some of the `filePaths` are relative paths, then they are resolved relative to the [current working directory](https://nodejs.org/api/process.html#process_process_cwd).
|
||
- returns: <[Promise]>
|
||
|
||
This method expects `elementHandle` to point to an [input element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input).
|
||
|
||
### class: HTTPRequest
|
||
|
||
Whenever the page sends a request, such as for a network resource, the following events are emitted by Puppeteer's page:
|
||
|
||
- [`'request'`](#event-request) emitted when the request is issued by the page.
|
||
- [`'response'`](#event-response) emitted when/if the response is received for the request.
|
||
- [`'requestfinished'`](#event-requestfinished) emitted when the response body is downloaded and the request is complete.
|
||
|
||
If request fails at some point, then instead of `'requestfinished'` event (and possibly instead of 'response' event), the [`'requestfailed'`](#event-requestfailed) event is emitted.
|
||
|
||
> **NOTE** HTTP Error responses, such as 404 or 503, are still successful responses from HTTP standpoint, so request will complete with `'requestfinished'` event.
|
||
|
||
If request gets a 'redirect' response, the request is successfully finished with the 'requestfinished' event, and a new request is issued to a redirected URL.
|
||
|
||
#### httpRequest.abort([errorCode], [priority])
|
||
|
||
- `errorCode` <[string]> Optional error code. Defaults to `failed`, could be
|
||
one of the following:
|
||
- `aborted` - An operation was aborted (due to user action).
|
||
- `accessdenied` - Permission to access a resource, other than the network, was denied.
|
||
- `addressunreachable` - The IP address is unreachable. This usually means
|
||
that there is no route to the specified host or network.
|
||
- `blockedbyclient` - The client chose to block the request.
|
||
- `blockedbyresponse` - The request failed because the response was delivered along with requirements which are not met ('X-Frame-Options' and 'Content-Security-Policy' ancestor checks, for instance).
|
||
- `connectionaborted` - A connection timed out as a result of not receiving an ACK for data sent.
|
||
- `connectionclosed` - A connection was closed (corresponding to a TCP FIN).
|
||
- `connectionfailed` - A connection attempt failed.
|
||
- `connectionrefused` - A connection attempt was refused.
|
||
- `connectionreset` - A connection was reset (corresponding to a TCP RST).
|
||
- `internetdisconnected` - The Internet connection has been lost.
|
||
- `namenotresolved` - The host name could not be resolved.
|
||
- `timedout` - An operation timed out.
|
||
- `failed` - A generic failure occurred.
|
||
- `priority` <[number]> - Optional intercept abort priority. If provided, intercept will be resolved using coopeative handling rules. Otherwise, intercept will be resovled immediately.
|
||
- returns: <[Promise]>
|
||
|
||
Aborts request. To use this, request interception should be enabled with `page.setRequestInterception`.
|
||
Exception is immediately thrown if the request interception is not enabled.
|
||
|
||
#### httpRequest.abortErrorReason()
|
||
|
||
- returns: <[string]> of type [Protocol.Network.ErrorReason](https://chromedevtools.github.io/devtools-protocol/tot/Network/#type-ErrorReason).
|
||
|
||
Returns the most recent reason for aborting set by the previous call to abort() in Cooperative Mode.
|
||
|
||
#### httpRequest.continue([overrides], [priority])
|
||
|
||
- `overrides` <[Object]> Optional request overwrites, which can be one of the following:
|
||
- `url` <[string]> If set changes the request URL. This is not a redirect. The request will be silently forwarded to the new URL. For example, the address bar will show the original URL.
|
||
- `method` <[string]> If set changes the request method (e.g. `GET` or `POST`).
|
||
- `postData` <[string]> If set changes the post data of request.
|
||
- `headers` <[Object]> If set changes the request HTTP headers. Header values will be converted to a string.
|
||
- `priority` <[number]> - Optional intercept abort priority. If provided, intercept will be resolved using coopeative handling rules. Otherwise, intercept will be resovled immediately.
|
||
- returns: <[Promise]>
|
||
|
||
Continues request with optional request overrides. To use this, request interception should be enabled with `page.setRequestInterception`.
|
||
Exception is immediately thrown if the request interception is not enabled.
|
||
|
||
```js
|
||
await page.setRequestInterception(true);
|
||
page.on('request', (request) => {
|
||
// Override headers
|
||
const headers = Object.assign({}, request.headers(), {
|
||
foo: 'bar', // set "foo" header
|
||
origin: undefined, // remove "origin" header
|
||
});
|
||
request.continue({ headers });
|
||
});
|
||
```
|
||
|
||
#### httpRequest.continueRequestOverrides()
|
||
|
||
- returns: <[Object]> Optional request overwrites, which can be one of the following:
|
||
- `url` <[string]> If set changes the request URL. This is not a redirect. The request will be silently forwarded to the new URL. For example, the address bar will show the original URL.
|
||
- `method` <[string]> If set changes the request method (e.g. `GET` or `POST`).
|
||
- `postData` <[string]> If set changes the post data of request.
|
||
- `headers` <[Object]> If set changes the request HTTP headers. Header values will be converted to a string.
|
||
|
||
Returns the most recent set of request overrides set with a previous call to continue() in Cooperative Mode.
|
||
|
||
#### httpRequest.enqueueInterceptAction(pendingHandler)
|
||
|
||
- `pendingHandler` <[function]> The request interception handler to enqueue
|
||
|
||
Enqueues a request handler for processing. This facilitates proper execution of async handlers.
|
||
|
||
#### httpRequest.failure()
|
||
|
||
- returns: <?[Object]> Object describing request failure, if any
|
||
- `errorText` <[string]> Human-readable error message, e.g. `'net::ERR_FAILED'`.
|
||
|
||
The method returns `null` unless this request was failed, as reported by
|
||
`requestfailed` event.
|
||
|
||
Example of logging all failed requests:
|
||
|
||
```js
|
||
page.on('requestfailed', (request) => {
|
||
console.log(request.url() + ' ' + request.failure().errorText);
|
||
});
|
||
```
|
||
|
||
#### httpRequest.finalizeInterceptions()
|
||
|
||
- returns: <[Promise<unknown>]>
|
||
|
||
When in Cooperative Mode, awaits pending interception handlers and then decides how to fulfill the request interception.
|
||
|
||
#### httpRequest.frame()
|
||
|
||
- returns: <?[Frame]> A [Frame] that initiated this request, or `null` if navigating to error pages.
|
||
|
||
#### httpRequest.headers()
|
||
|
||
- returns: <[Object]> An object with HTTP headers associated with the request. All header names are lower-case.
|
||
|
||
#### httpRequest.isNavigationRequest()
|
||
|
||
- returns: <[boolean]>
|
||
|
||
Whether this request is driving frame's navigation.
|
||
|
||
#### httpRequest.method()
|
||
|
||
- returns: <[string]> Request's method (GET, POST, etc.)
|
||
|
||
#### httpRequest.postData()
|
||
|
||
- returns: <[string]> Request's post body, if any.
|
||
|
||
#### httpRequest.redirectChain()
|
||
|
||
- returns: <[Array]<[HTTPRequest]>>
|
||
|
||
A `redirectChain` is a chain of requests initiated to fetch a resource.
|
||
|
||
- If there are no redirects and the request was successful, the chain will be empty.
|
||
- If a server responds with at least a single redirect, then the chain will
|
||
contain all the requests that were redirected.
|
||
|
||
`redirectChain` is shared between all the requests of the same chain.
|
||
|
||
For example, if the website `http://example.com` has a single redirect to
|
||
`https://example.com`, then the chain will contain one request:
|
||
|
||
```js
|
||
const response = await page.goto('http://example.com');
|
||
const chain = response.request().redirectChain();
|
||
console.log(chain.length); // 1
|
||
console.log(chain[0].url()); // 'http://example.com'
|
||
```
|
||
|
||
If the website `https://google.com` has no redirects, then the chain will be empty:
|
||
|
||
```js
|
||
const response = await page.goto('https://google.com');
|
||
const chain = response.request().redirectChain();
|
||
console.log(chain.length); // 0
|
||
```
|
||
|
||
#### httpRequest.resourceType()
|
||
|
||
- returns: <[string]>
|
||
|
||
Contains the request's resource type as it was perceived by the rendering engine.
|
||
ResourceType will be one of the following: `document`, `stylesheet`, `image`, `media`, `font`, `script`, `texttrack`, `xhr`, `fetch`, `eventsource`, `websocket`, `manifest`, `other`.
|
||
|
||
#### httpRequest.respond(response, [priority])
|
||
|
||
- `response` <[Object]> Response that will fulfill this request
|
||
- `status` <[number]> Response status code, defaults to `200`.
|
||
- `headers` <[Object]> Optional response headers. Header values will be converted to a string.
|
||
- `contentType` <[string]> If set, equals to setting `Content-Type` response header
|
||
- `body` <[string]|[Buffer]> Optional response body
|
||
- `priority` <[number]> - Optional intercept abort priority. If provided, intercept will be resolved using coopeative handling rules. Otherwise, intercept will be resovled immediately.
|
||
- returns: <[Promise]>
|
||
|
||
Fulfills request with given response. To use this, request interception should
|
||
be enabled with `page.setRequestInterception`. Exception is thrown if
|
||
request interception is not enabled.
|
||
|
||
An example of fulfilling all requests with 404 responses:
|
||
|
||
```js
|
||
await page.setRequestInterception(true);
|
||
page.on('request', (request) => {
|
||
request.respond({
|
||
status: 404,
|
||
contentType: 'text/plain',
|
||
body: 'Not Found!',
|
||
});
|
||
});
|
||
```
|
||
|
||
> **NOTE** Mocking responses for dataURL requests is not supported.
|
||
> Calling `request.respond` for a dataURL request is a noop.
|
||
|
||
#### httpRequest.response()
|
||
|
||
- returns: <?[HTTPResponse]> A matching [HTTPResponse] object, or `null` if the response has not been received yet.
|
||
|
||
#### httpRequest.responseForRequest()
|
||
|
||
- returns: <?[HTTPResponse]> A matching [HTTPResponse] object, or `null` if the response has not been received yet.
|
||
|
||
Returns the current response object set by the previous call to respond() in Cooperative Mode.
|
||
|
||
#### httpRequest.url()
|
||
|
||
- returns: <[string]> URL of the request.
|
||
|
||
### class: HTTPResponse
|
||
|
||
[HTTPResponse] class represents responses which are received by page.
|
||
|
||
#### httpResponse.buffer()
|
||
|
||
- returns: <[Promise]<[Buffer]>> Promise which resolves to a buffer with response body.
|
||
|
||
#### httpResponse.frame()
|
||
|
||
- returns: <?[Frame]> A [Frame] that initiated this response, or `null` if navigating to error pages.
|
||
|
||
#### httpResponse.fromCache()
|
||
|
||
- returns: <[boolean]>
|
||
|
||
True if the response was served from either the browser's disk cache or memory cache.
|
||
|
||
#### httpResponse.fromServiceWorker()
|
||
|
||
- returns: <[boolean]>
|
||
|
||
True if the response was served by a service worker.
|
||
|
||
#### httpResponse.headers()
|
||
|
||
- returns: <[Object]> An object with HTTP headers associated with the response. All header names are lower-case.
|
||
|
||
#### httpResponse.json()
|
||
|
||
- returns: <[Promise]<[Object]>> Promise which resolves to a JSON representation of response body.
|
||
|
||
This method will throw if the response body is not parsable via `JSON.parse`.
|
||
|
||
#### httpResponse.ok()
|
||
|
||
- returns: <[boolean]>
|
||
|
||
Contains a boolean stating whether the response was successful (status in the range 200-299) or not.
|
||
|
||
#### httpResponse.remoteAddress()
|
||
|
||
- returns: <[Object]>
|
||
- `ip` <[string]> the IP address of the remote server
|
||
- `port` <[number]> the port used to connect to the remote server
|
||
|
||
#### httpResponse.request()
|
||
|
||
- returns: <[HTTPRequest]> A matching [HTTPRequest] object.
|
||
|
||
#### httpResponse.securityDetails()
|
||
|
||
- returns: <?[SecurityDetails]> Security details if the response was received over the secure connection, or `null` otherwise.
|
||
|
||
#### httpResponse.status()
|
||
|
||
- returns: <[number]>
|
||
|
||
Contains the status code of the response (e.g., 200 for a success).
|
||
|
||
#### httpResponse.statusText()
|
||
|
||
- returns: <[string]>
|
||
|
||
Contains the status text of the response (e.g. usually an "OK" for a success).
|
||
|
||
#### httpResponse.text()
|
||
|
||
- returns: <[Promise]<[string]>> Promise which resolves to a text representation of response body.
|
||
|
||
#### httpResponse.url()
|
||
|
||
- returns: <[string]>
|
||
|
||
Contains the URL of the response.
|
||
|
||
### class: SecurityDetails
|
||
|
||
[SecurityDetails] class represents the security details when response was received over the secure connection.
|
||
|
||
#### securityDetails.issuer()
|
||
|
||
- returns: <[string]> A string with the name of issuer of the certificate.
|
||
|
||
#### securityDetails.protocol()
|
||
|
||
- returns: <[string]> String with the security protocol, eg. "TLS 1.2".
|
||
|
||
#### securityDetails.subjectAlternativeNames()
|
||
|
||
- returns: <[Array]<[string]>> Returns the list of SANs (subject alternative names) of the certificate.
|
||
|
||
#### securityDetails.subjectName()
|
||
|
||
- returns: <[string]> Name of the subject to which the certificate was issued to.
|
||
|
||
#### securityDetails.validFrom()
|
||
|
||
- returns: <[number]> [UnixTime] stating the start of validity of the certificate.
|
||
|
||
#### securityDetails.validTo()
|
||
|
||
- returns: <[number]> [UnixTime] stating the end of validity of the certificate.
|
||
|
||
### class: Target
|
||
|
||
#### target.browser()
|
||
|
||
- returns: <[Browser]>
|
||
|
||
Get the browser the target belongs to.
|
||
|
||
#### target.browserContext()
|
||
|
||
- returns: <[BrowserContext]>
|
||
|
||
The browser context the target belongs to.
|
||
|
||
#### target.createCDPSession()
|
||
|
||
- returns: <[Promise]<[CDPSession]>>
|
||
|
||
Creates a Chrome Devtools Protocol session attached to the target.
|
||
|
||
#### target.opener()
|
||
|
||
- returns: <?[Target]>
|
||
|
||
Get the target that opened this target. Top-level targets return `null`.
|
||
|
||
#### target.page()
|
||
|
||
- returns: <[Promise]<?[Page]>>
|
||
|
||
If the target is not of type `"page"` or `"background_page"`, returns `null`.
|
||
|
||
#### target.type()
|
||
|
||
- returns: <"page"|"background_page"|"service_worker"|"shared_worker"|"other"|"browser">
|
||
|
||
Identifies what kind of target this is. Can be `"page"`, [`"background_page"`](https://developer.chrome.com/extensions/background_pages), `"service_worker"`, `"shared_worker"`, `"browser"` or `"other"`.
|
||
|
||
#### target.url()
|
||
|
||
- returns: <[string]>
|
||
|
||
#### target.worker()
|
||
|
||
- returns: <[Promise]<?[WebWorker]>>
|
||
|
||
If the target is not of type `"service_worker"` or `"shared_worker"`, returns `null`.
|
||
|
||
### class: CDPSession
|
||
|
||
- extends: [EventEmitter](#class-eventemitter)
|
||
|
||
The `CDPSession` instances are used to talk raw Chrome Devtools Protocol:
|
||
|
||
- protocol methods can be called with `session.send` method.
|
||
- protocol events can be subscribed to with `session.on` method.
|
||
|
||
Useful links:
|
||
|
||
- Documentation on DevTools Protocol can be found here: [DevTools Protocol Viewer](https://chromedevtools.github.io/devtools-protocol/).
|
||
- Getting Started with DevTools Protocol: https://github.com/aslushnikov/getting-started-with-cdp/blob/HEAD/README.md
|
||
|
||
```js
|
||
const client = await page.target().createCDPSession();
|
||
await client.send('Animation.enable');
|
||
client.on('Animation.animationCreated', () =>
|
||
console.log('Animation created!')
|
||
);
|
||
const response = await client.send('Animation.getPlaybackRate');
|
||
console.log('playback rate is ' + response.playbackRate);
|
||
await client.send('Animation.setPlaybackRate', {
|
||
playbackRate: response.playbackRate / 2,
|
||
});
|
||
```
|
||
|
||
#### cdpSession.connection()
|
||
|
||
- returns: <[Connection]>
|
||
|
||
Returns the underlying connection associated with the session. Can be used to obtain other related sessions.
|
||
|
||
#### cdpSession.detach()
|
||
|
||
- returns: <[Promise]>
|
||
|
||
Detaches the cdpSession from the target. Once detached, the cdpSession object won't emit any events and can't be used
|
||
to send messages.
|
||
|
||
#### cdpSession.send(method[, ...paramArgs])
|
||
|
||
- `method` <[string]> protocol method name
|
||
- `...paramArgs` <[Object]> Optional method parameters
|
||
- returns: <[Promise]<[Object]>>
|
||
|
||
### class: Coverage
|
||
|
||
Coverage gathers information about parts of JavaScript and CSS that were used by the page.
|
||
|
||
An example of using JavaScript and CSS coverage to get percentage of initially
|
||
executed code:
|
||
|
||
```js
|
||
// Enable both JavaScript and CSS coverage
|
||
await Promise.all([
|
||
page.coverage.startJSCoverage(),
|
||
page.coverage.startCSSCoverage(),
|
||
]);
|
||
// Navigate to page
|
||
await page.goto('https://example.com');
|
||
// Disable both JavaScript and CSS coverage
|
||
const [jsCoverage, cssCoverage] = await Promise.all([
|
||
page.coverage.stopJSCoverage(),
|
||
page.coverage.stopCSSCoverage(),
|
||
]);
|
||
let totalBytes = 0;
|
||
let usedBytes = 0;
|
||
const coverage = [...jsCoverage, ...cssCoverage];
|
||
for (const entry of coverage) {
|
||
totalBytes += entry.text.length;
|
||
for (const range of entry.ranges) usedBytes += range.end - range.start - 1;
|
||
}
|
||
console.log(`Bytes used: ${(usedBytes / totalBytes) * 100}%`);
|
||
```
|
||
|
||
_To output coverage in a form consumable by [Istanbul](https://github.com/istanbuljs),
|
||
see [puppeteer-to-istanbul](https://github.com/istanbuljs/puppeteer-to-istanbul)._
|
||
|
||
#### coverage.startCSSCoverage([options])
|
||
|
||
- `options` <[Object]> Set of configurable options for coverage
|
||
- `resetOnNavigation` <[boolean]> Whether to reset coverage on every navigation. Defaults to `true`.
|
||
- returns: <[Promise]> Promise that resolves when coverage is started
|
||
|
||
#### coverage.startJSCoverage([options])
|
||
|
||
- `options` <[Object]> Set of configurable options for coverage
|
||
- `resetOnNavigation` <[boolean]> Whether to reset coverage on every navigation. Defaults to `true`.
|
||
- `reportAnonymousScripts` <[boolean]> Whether anonymous scripts generated by the page should be reported. Defaults to `false`.
|
||
- returns: <[Promise]> Promise that resolves when coverage is started
|
||
|
||
> **NOTE** Anonymous scripts are ones that don't have an associated URL. These are scripts that are dynamically created on the page using `eval` or `new Function`. If `reportAnonymousScripts` is set to `true`, anonymous scripts will have `__puppeteer_evaluation_script__` as their URL.
|
||
|
||
#### coverage.stopCSSCoverage()
|
||
|
||
- returns: <[Promise]<[Array]<[Object]>>> Promise that resolves to the array of coverage reports for all stylesheets
|
||
- `url` <[string]> StyleSheet URL
|
||
- `text` <[string]> StyleSheet content
|
||
- `ranges` <[Array]<[Object]>> StyleSheet ranges that were used. Ranges are sorted and non-overlapping.
|
||
- `start` <[number]> A start offset in text, inclusive
|
||
- `end` <[number]> An end offset in text, exclusive
|
||
|
||
> **NOTE** CSS Coverage doesn't include dynamically injected style tags without sourceURLs.
|
||
|
||
#### coverage.stopJSCoverage()
|
||
|
||
- returns: <[Promise]<[Array]<[Object]>>> Promise that resolves to the array of coverage reports for all scripts
|
||
- `url` <[string]> Script URL
|
||
- `text` <[string]> Script content
|
||
- `ranges` <[Array]<[Object]>> Script ranges that were executed. Ranges are sorted and non-overlapping.
|
||
- `start` <[number]> A start offset in text, inclusive
|
||
- `end` <[number]> An end offset in text, exclusive
|
||
|
||
> **NOTE** JavaScript Coverage doesn't include anonymous scripts by default. However, scripts with sourceURLs are
|
||
> reported.
|
||
|
||
### class: TimeoutError
|
||
|
||
- extends: [Error]
|
||
|
||
TimeoutError is emitted whenever certain operations are terminated due to timeout, e.g. [page.waitForSelector(selector[, options])](#pagewaitforselectorselector-options) or [puppeteer.launch([options])](#puppeteerlaunchoptions).
|
||
|
||
### class: EventEmitter
|
||
|
||
A small EventEmitter class backed by [Mitt](https://github.com/developit/mitt/).
|
||
|
||
#### eventEmitter.addListener(event, handler)
|
||
|
||
- `event` <[string]|[symbol]> the event to add the handler to.
|
||
- `handler` <[Function]> the event listener that will be added.
|
||
- returns: `this` so you can chain method calls
|
||
|
||
This method is identical to `on` and maintained for compatibility with Node's EventEmitter. We recommend using `on` by default.
|
||
|
||
#### eventEmitter.emit(event, [eventData])
|
||
|
||
- `event` <[string]|[symbol]> the event to trigger.
|
||
- `eventData` <[Object]> additional data to send with the event.
|
||
- returns: `boolean`; `true` if there are any listeners for the event, `false` if there are none.
|
||
|
||
#### eventEmitter.listenerCount(event)
|
||
|
||
- `event` <[string]|[symbol]> the event to check for listeners.
|
||
- returns: <[number]> the number of listeners for the given event.
|
||
|
||
#### eventEmitter.off(event, handler)
|
||
|
||
- `event` <[string]|[symbol]> the event to remove the handler from.
|
||
- `handler` <[Function]> the event listener that will be removed.
|
||
- returns: `this` so you can chain method calls
|
||
|
||
#### eventEmitter.on(event, handler)
|
||
|
||
- `event` <[string]|[symbol]> the event to add the handler to.
|
||
- `handler` <[Function]> the event listener that will be added.
|
||
- returns: `this` so you can chain method calls
|
||
|
||
#### eventEmitter.once(event, handler)
|
||
|
||
- `event` <[string]|[symbol]> the event to add the handler to.
|
||
- `handler` <[Function]> the event listener that will be added.
|
||
- returns: `this` so you can chain method calls
|
||
|
||
#### eventEmitter.removeAllListeners([event])
|
||
|
||
- `event` <[string]|[symbol]> optional argument to remove all listeners for the given event. If it's not given this method will remove all listeners for all events.
|
||
- returns: `this` so you can chain method calls
|
||
|
||
#### eventEmitter.removeListener(event, handler)
|
||
|
||
- `event` <[string]|[symbol]> the event to remove the handler from.
|
||
- `handler` <[Function]> the event listener that will be removed.
|
||
- returns: `this` so you can chain method calls
|
||
|
||
This method is identical to `off` and maintained for compatibility with Node's EventEmitter. We recommend using `off` by default.
|
||
|
||
### interface: CustomQueryHandler
|
||
|
||
Contains two functions `queryOne` and `queryAll` that can be [registered](#puppeteerregistercustomqueryhandlername-queryhandler) as alternative querying strategies. The functions `queryOne` and `queryAll` are executed in the page context. `queryOne` should take an `Element` and a selector string as argument and return a single `Element` or `null` if no element is found. `queryAll` takes the same arguments but should instead return a `NodeList<Element>` or `Array<Element>` with all the elements that match the given query selector.
|
||
|
||
[axnode]: #accessibilitysnapshotoptions 'AXNode'
|
||
[accessibility]: #class-accessibility 'Accessibility'
|
||
[array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array 'Array'
|
||
[body]: #class-body 'Body'
|
||
[browsercontext]: #class-browsercontext 'BrowserContext'
|
||
[browserfetcher]: #class-browserfetcher 'BrowserFetcher'
|
||
[browser]: #class-browser 'Browser'
|
||
[buffer]: https://nodejs.org/api/buffer.html#buffer_class_buffer 'Buffer'
|
||
[cdpsession]: #class-cdpsession 'CDPSession'
|
||
[childprocess]: https://nodejs.org/api/child_process.html 'ChildProcess'
|
||
[connectiontransport]: ../src/WebSocketTransport.js 'ConnectionTransport'
|
||
[consolemessage]: #class-consolemessage 'ConsoleMessage'
|
||
[coverage]: #class-coverage 'Coverage'
|
||
[dialog]: #class-dialog 'Dialog'
|
||
[elementhandle]: #class-elementhandle 'ElementHandle'
|
||
[element]: https://developer.mozilla.org/en-US/docs/Web/API/element 'Element'
|
||
[error]: https://nodejs.org/api/errors.html#errors_class_error 'Error'
|
||
[executioncontext]: #class-executioncontext 'ExecutionContext'
|
||
[filechooser]: #class-filechooser 'FileChooser'
|
||
[frame]: #class-frame 'Frame'
|
||
[jshandle]: #class-jshandle 'JSHandle'
|
||
[keyboard]: #class-keyboard 'Keyboard'
|
||
[map]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map 'Map'
|
||
[mouse]: #class-mouse 'Mouse'
|
||
[object]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object 'Object'
|
||
[page]: #class-page 'Page'
|
||
[promise]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise 'Promise'
|
||
[httprequest]: #class-httprequest 'HTTPRequest'
|
||
[httpresponse]: #class-httpresponse 'HTTPResponse'
|
||
[securitydetails]: #class-securitydetails 'SecurityDetails'
|
||
[serializable]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#Description 'Serializable'
|
||
[target]: #class-target 'Target'
|
||
[timeouterror]: #class-timeouterror 'TimeoutError'
|
||
[touchscreen]: #class-touchscreen 'Touchscreen'
|
||
[tracing]: #class-tracing 'Tracing'
|
||
[uievent.detail]: https://developer.mozilla.org/en-US/docs/Web/API/UIEvent/detail 'UIEvent.detail'
|
||
[uskeyboardlayout]: ../src/common/USKeyboardLayout.ts 'USKeyboardLayout'
|
||
[unixtime]: https://en.wikipedia.org/wiki/Unix_time 'Unix Time'
|
||
[webworker]: #class-webworker 'Worker'
|
||
[boolean]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type 'Boolean'
|
||
[function]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function 'Function'
|
||
[iterator]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols 'Iterator'
|
||
[number]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type 'Number'
|
||
[origin]: https://developer.mozilla.org/en-US/docs/Glossary/Origin 'Origin'
|
||
[selector]: https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors 'selector'
|
||
[stream.readable]: https://nodejs.org/api/stream.html#stream_class_stream_readable 'stream.Readable'
|
||
[string]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type 'String'
|
||
[symbol]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Symbol_type 'Symbol'
|
||
[xpath]: https://developer.mozilla.org/en-US/docs/Web/XPath 'xpath'
|
||
[customqueryhandler]: #interface-customqueryhandler 'CustomQueryHandler'
|