- Overview
- Environment Variables
- class: Puppeteer
- class: Browser
- class: Page
- event: 'console'
- event: 'dialog'
- event: 'error'
- event: 'frameattached'
- event: 'framedetached'
- event: 'framenavigated'
- event: 'load'
- event: 'metrics'
- event: 'pageerror'
- event: 'request'
- event: 'requestfailed'
- event: 'requestfinished'
- event: 'response'
- page.$(selector)
- page.$$(selector)
- page.$$eval(selector, pageFunction[, ...args])
- page.$eval(selector, pageFunction[, ...args])
- page.addScriptTag(options)
- page.addStyleTag(options)
- page.authenticate(credentials)
- page.click(selector[, options])
- page.close()
- page.content()
- page.cookies(...urls)
- page.deleteCookie(...cookies)
- page.emulate(options)
- page.emulateMedia(mediaType)
- page.evaluate(pageFunction, ...args)
- page.evaluateHandle(pageFunction, ...args)
- page.evaluateOnNewDocument(pageFunction, ...args)
- page.exposeFunction(name, puppeteerFunction)
- page.focus(selector)
- page.frames()
- page.getMetrics()
- page.goBack(options)
- page.goForward(options)
- page.goto(url, options)
- page.hover(selector)
- page.keyboard
- page.mainFrame()
- page.mouse
- page.pdf(options)
- page.queryObjects(prototypeHandle)
- page.reload(options)
- page.screenshot([options])
- page.select(selector, ...values)
- page.setContent(html)
- page.setCookie(...cookies)
- page.setExtraHTTPHeaders(headers)
- page.setJavaScriptEnabled(enabled)
- page.setOfflineMode(enabled)
- page.setRequestInterceptionEnabled(value)
- page.setUserAgent(userAgent)
- page.setViewport(viewport)
- page.tap(selector)
- page.title()
- page.touchscreen
- page.tracing
- page.type(selector, text[, options])
- page.url()
- page.viewport()
- page.waitFor(selectorOrFunctionOrTimeout[, options[, ...args]])
- page.waitForFunction(pageFunction[, options[, ...args]])
- page.waitForNavigation(options)
- page.waitForSelector(selector[, options])
- class: Keyboard
- class: Mouse
- class: Touchscreen
- class: Tracing
- class: Dialog
- class: ConsoleMessage
- class: Frame
- frame.$(selector)
- frame.$$(selector)
- frame.$$eval(selector, pageFunction[, ...args])
- frame.$eval(selector, pageFunction[, ...args])
- frame.addScriptTag(options)
- frame.addStyleTag(options)
- frame.childFrames()
- frame.evaluate(pageFunction, ...args)
- frame.executionContext()
- frame.isDetached()
- frame.name()
- frame.parentFrame()
- frame.title()
- frame.url()
- frame.waitFor(selectorOrFunctionOrTimeout[, options[, ...args]])
- frame.waitForFunction(pageFunction[, options[, ...args]])
- frame.waitForSelector(selector[, options])
- class: ExecutionContext
- class: JSHandle
- class: ElementHandle
- elementHandle.asElement()
- elementHandle.boundingBox()
- elementHandle.click([options])
- elementHandle.dispose()
- elementHandle.executionContext()
- elementHandle.focus()
- elementHandle.getProperties()
- elementHandle.getProperty(propertyName)
- elementHandle.hover()
- elementHandle.jsonValue()
- elementHandle.press(key[, options])
- elementHandle.screenshot([options])
- elementHandle.tap()
- elementHandle.toString()
- elementHandle.type(text[, options])
- elementHandle.uploadFile(...filePaths)
- class: Request
- class: Response
- class: Target
Puppeteer is a Node library which provides a high-level API to control Chromium over the DevTools Protocol.
Puppeteer API is hierarchical and mirrors browser structure. On the following diagram, faded entities are not currently represented in Puppeteer.
Puppeteer
communicates with browser using devtools protocol.Browser
instance owns multiple pages.Page
has at least one frame: main frame. There might be other frames created by iframe or frame tags.Frame
has at least one execution context - default execution context - where frame's JavaScript is executed. Frame might have additional execution contexts associated with extensions.
(Diagram source: link)
Puppeteer looks for certain environment variables to aid its operations. These variables can either be set in the environment or in the npm config.
HTTP_PROXY
,HTTPS_PROXY
,NO_PROXY
- defines HTTP proxy settings that are used to download and run Chromium.PUPPETEER_SKIP_CHROMIUM_DOWNLOAD
- do not download bundled Chromium during installation step.PUPPETEER_DOWNLOAD_HOST
- overwrite host part of URL that is used to download Chromium
Puppeteer module provides a method to launch a Chromium instance. The following is a typical example of using a Puppeteer to drive automation:
const puppeteer = require('puppeteer');
puppeteer.launch().then(async browser => {
const page = await browser.newPage();
await page.goto('https://www.google.com');
// other actions...
await browser.close();
});
options
<Object>browserWSEndpoint
<string> a browser websocket endpoint to connect to.ignoreHTTPSErrors
<boolean> Whether to ignore HTTPS errors during navigation. Defaults tofalse
.
- returns: <Promise<Browser>>
This methods attaches Puppeteer to an existing Chromium instance.
- returns: <string> A path where Puppeteer expects to find bundled Chromium. Chromium might not exist there if the download was skipped with
PUPPETEER_SKIP_CHROMIUM_DOWNLOAD
.
options
<Object> Set of configurable options to set on the browser. Can have the following fields:ignoreHTTPSErrors
<boolean> Whether to ignore HTTPS errors during navigation. Defaults tofalse
.headless
<boolean> Whether to run Chromium in headless mode. Defaults totrue
unless thedevtools
option istrue
.executablePath
<string> Path to a Chromium executable to run instead of bundled Chromium. IfexecutablePath
is a relative path, then it is resolved relative to current working directory.slowMo
<number> Slows down Puppeteer operations by the specified amount of milliseconds. Useful so that you can see what is going on.args
<Array<string>> Additional arguments to pass to the Chromium instance. List of Chromium flags can be found here.handleSIGINT
<boolean> Close chrome process on Ctrl-C. Defaults totrue
.timeout
<number> Maximum time in milliseconds to wait for the Chrome instance to start. Defaults to30000
(30 seconds). Pass0
to disable timeout.dumpio
<boolean> Whether to pipe browser process stdout and stderr intoprocess.stdout
andprocess.stderr
. Defaults tofalse
.userDataDir
<string> Path to a User Data Directory.env
<Object> Specify environment variables that will be visible to Chromium. Defaults toprocess.env
.devtools
<boolean> Whether to auto-open DevTools panel for each tab. If this option istrue
, theheadless
option will be setfalse
.
- returns: <Promise<Browser>> Promise which resolves to browser instance.
The method launches a browser instance with given arguments. The browser will be closed when the parent node.js process is closed.
NOTE Puppeteer works best with the version of Chromium it is bundled with. There is no guarantee it will work with any other version. Use
executablePath
option with extreme caution. If Google Chrome (rather than Chromium) is preferred, a Chrome Canary or Dev Channel build is suggested.
A Browser is created when Puppeteer connects to a Chromium instance, either through puppeteer.launch
or puppeteer.connect
.
An example of using a Browser to create a Page:
const puppeteer = require('puppeteer');
puppeteer.launch().then(async browser => {
const page = await browser.newPage();
await page.goto('https://example.com');
await browser.close();
});
An example of disconnecting from and reconnecting to a Browser:
const puppeteer = require('puppeteer');
puppeteer.launch().then(async browser => {
// 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();
});
- <Target>
Emitted when the url of a target changes.
- <Target>
Emitted when a target is created, for example when a new page is opened by window.open
or browser.newPage
.
- <Target>
Emitted when a target is destroyed, for example when a page is closed.
- returns: <Promise>
Closes Chromium and all of its pages (if any were opened). The browser object itself is considered disposed and cannot be used anymore.
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.
- returns: <Promise<string>> For headless Chromium, this is similar to
HeadlessChrome/61.0.3153.0
. For non-headless, this is similar toChrome/61.0.3153.0
.
NOTE the format of browser.version() might change with future releases of Chromium.
- returns: <string> Browser websocket url.
Browser websocket endpoint which can be used as an argument to
puppeteer.connect. 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 and the browser endpoint.
Page provides methods to interact with a single tab 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:
const puppeteer = require('puppeteer');
puppeteer.launch().then(async browser => {
const page = await browser.newPage();
await page.goto('https://example.com');
await page.screenshot({path: 'screenshot.png'});
await browser.close();
});
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:
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'}));
- <Dialog>
Emitted when a JavaScript dialog appears, such as alert
, prompt
, confirm
or beforeunload
. Puppeteer can respond to the dialog via Dialog's accept or dismiss methods.
- <Error>
Emitted when the page crashes.
NOTE
error
event has a special meaning in Node, see error events for details.
- <Frame>
Emitted when a frame is attached.
- <Frame>
Emitted when a frame is detached.
- <Frame>
Emitted when a frame is navigated to a new url.
Emitted when the JavaScript load
event is dispatched.
- <Object>
Emitted when the JavaScript code makes a call to console.timeStamp
. For the list
of metrics see page.getMetrics
.
- <string> The exception message
Emitted when an uncaught exception happens within the page.
- <Request>
Emitted when a page issues a request. The request object is read-only.
In order to intercept and mutate requests, see page.setRequestInterceptionEnabled
.
- <Request>
Emitted when a request fails, for example by timing out.
- <Request>
Emitted when a request finishes successfully.
- <Response>
Emitted when a response is received.
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 resolve to null
.
Shortcut for page.mainFrame().$(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 resolve to []
.
Shortcut for page.mainFrame().$$(selector).
selector
<string> A selector to query frame forpageFunction
<function> Function to be evaluated in browser context...args
<...Serializable|ElementHandle> Arguments to pass topageFunction
- returns: <Promise<Serializable>> Promise which resolves to the return value of
pageFunction
This method runs document.querySelectorAll
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:
const divsCounts = await page.$$eval('div', divs => divs.length);
selector
<string> A selector to query page forpageFunction
<function> Function to be evaluated in browser context...args
<...Serializable|ElementHandle> Arguments to pass topageFunction
- 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:
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).
options
<Object>url
<string> Url of a script to be added.path
<string> Path to the JavaScript file to be injected into frame. Ifpath
is a relative path, then it is resolved relative to current working directory.content
<string> Raw JavaScript content to be injected into frame.
- returns: <Promise> which resolves 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).
options
<Object>url
<string> Url of the<link>
tag.path
<string> Path to the CSS file to be injected into frame. Ifpath
is a relative path, then it is resolved relative to current working directory.content
<string> Raw CSS content to be injected into frame.
- returns: <Promise> which resolves 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).
Provide credentials for http authentication.
To disable authentication, pass null
.
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
<string>left
,right
, ormiddle
, defaults toleft
.clickCount
<number> defaults to 1. See UIEvent.detail.delay
<number> Time to wait betweenmousedown
andmouseup
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 matchingselector
.
This method fetches an element with selector
, scrolls it into view if needed, and then uses page.mouse to click in the center of the element.
If there's no element matching selector
, the method throws an error.
- returns: <Promise>
Gets the full HTML contents of the page, including the doctype.
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.
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 to1
.isMobile
<boolean> Whether themeta viewport
tag is taken into account. Defaults tofalse
.hasTouch
<boolean> Specifies if viewport supports touch events. Defaults tofalse
isLandscape
<boolean> Specifies if viewport is in landscape mode. Defaults tofalse
.
userAgent
<string>
- returns: <Promise>
Emulates given device metrics and user agent. This method is a shortcut for calling two methods:
To aid emulation, puppeteer provides a list of device descriptors which can be obtained via the require('puppeteer/DeviceDescriptors')
command.
Below is an example of emulating an iPhone 6 in puppeteer:
const puppeteer = require('puppeteer');
const devices = require('puppeteer/DeviceDescriptors');
const iPhone = devices['iPhone 6'];
puppeteer.launch().then(async browser => {
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: DeviceDescriptors.js.
mediaType
<string> Changes the CSS media type of the page. The only allowed values are'screen'
,'print'
andnull
. Passingnull
disables media emulation.- returns: <Promise>
pageFunction
<function|string> Function to be evaluated in the page context...args
<...Serializable|ElementHandle> Arguments to pass topageFunction
- returns: <Promise<Serializable>> 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 into page.evaluate
returns a non-Serializable value, then page.evaluate
resolves to undefined
.
const result = await page.evaluate(() => {
return Promise.resolve(8 * 7);
});
console.log(result); // prints "56"
A string can also be passed in instead of a function.
console.log(await page.evaluate('1 + 2')); // prints "3"
ElementHandle instances can be passed as arguments to the page.evaluate
:
const bodyHandle = await page.$('body');
const html = await page.evaluate(body => body.innerHTML, bodyHandle);
await bodyHandle.dispose();
Shortcut for page.mainFrame().evaluate(pageFunction, ...args).
pageFunction
<function|string> Function to be evaluated in the page context...args
<...Serializable|JSHandle> Arguments to pass topageFunction
- returns: <Promise<JSHandle>> Resolves to the return value of
pageFunction
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.
const aWindowHandle = await page.evaluateHandle(() => Promise.resolve(window));
aWindowHandle; // Handle for the window object.
A string can also be passed in instead of a function.
const aHandle = await page.evaluateHandle('document'); // Handle for the 'document'.
JSHandle instances can be passed as arguments to the page.evaluateHandle
:
const aHandle = await page.evaluateHandle(() => document.body);
const resultHandle = await page.evaluateHandle(body => body.innerHTML, aHandle);
console.log(await resultHandle.jsonValue());
await resultHandle.dispose();
Shortcut for page.mainFrame().executionContext().evaluateHandle(pageFunction, ...args).
pageFunction
<function|string> Function to be evaluated in browser context...args
<...Serializable> Arguments to pass topageFunction
- 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 JavaScript environment, e.g. to seed Math.random
.
name
<string> Name of the function on the window objectpuppeteerFunction
<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:
const puppeteer = require('puppeteer');
const crypto = require('crypto');
puppeteer.launch().then(async browser => {
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:
const puppeteer = require('puppeteer');
const fs = require('fs');
puppeteer.launch().then(async browser => {
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();
});
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 matchingselector
.
This method fetches an element with selector
and focuses it.
If there's no element matching selector
, the method throws an error.
- returns: <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.
options
<Object> Navigation parameters which might have the following properties:timeout
<number> Maximum navigation time in milliseconds, defaults to 30 seconds, pass0
to disable timeout.waitUntil
<string> When to consider a navigation finished, defaults toload
. Can be either:load
- consider navigation to be finished when theload
event is fired.domcontentloaded
- consider navigation to be finished when theDOMContentLoaded
event is fired.networkidle0
- consider navigation to be finished when there are no more then 0 network connections for at least500
ms.networkidle2
- consider navigation to be finished when there are no more then 2 network connections for at least500
ms.
- returns: <Promise<Response>> 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.
options
<Object> Navigation parameters which might have the following properties:timeout
<number> Maximum navigation time in milliseconds, defaults to 30 seconds, pass0
to disable timeout.waitUntil
<string> When to consider navigation succeeded, defaults toload
. Can be either:load
- consider navigation to be finished when theload
event is fired.domcontentloaded
- consider navigation to be finished when theDOMContentLoaded
event is fired.networkidle0
- consider navigation to be finished when there are no more then 0 network connections for at least500
ms.networkidle2
- consider navigation to be finished when there are no more then 2 network connections for at least500
ms.
- returns: <Promise<Response>> 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 next page in history.
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, pass0
to disable timeout.waitUntil
<string> When to consider navigation succeeded, defaults toload
. Can be either:load
- consider navigation to be finished when theload
event is fired.domcontentloaded
- consider navigation to be finished when theDOMContentLoaded
event is fired.networkidle0
- consider navigation to be finished when there are no more then 0 network connections for at least500
ms.networkidle2
- consider navigation to be finished when there are no more then 2 network connections for at least500
ms.
- returns: <Promise<Response>> Promise which resolves to the main resource response. In case of multiple redirects, the navigation will resolve with the response of the last redirect.
The 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 main resource failed to load.
NOTE
page.goto
either throw or return a main resource response. The only exception is navigation toabout:blank
, which would succeed and returnnull
.
NOTE Headless mode doesn't support navigating to a PDF document. See the upstream issue.
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 matchingselector
.
This method fetches an element with selector
, scrolls it into view if needed, and then uses page.mouse to hover over the center of the element.
If there's no element matching selector
, the method throws an error.
- returns: <Keyboard>
- returns: <Frame> returns page's main frame.
Page is guaranteed to have a main frame which persists during navigations.
- returns: <Mouse>
options
<Object> Options object which might have the following properties:path
<string> The file path to save the PDF to. Ifpath
is a relative path, then it is resolved relative to current working directory. If no path is provided, the PDF won't be saved to the disk.scale
<number> Scale of the webpage rendering. Defaults to1
.displayHeaderFooter
<boolean> Display header and footer. Defaults tofalse
.printBackground
<boolean> Print background graphics. Defaults tofalse
.landscape
<boolean> Paper orientation. Defaults tofalse
.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 overwidth
orheight
options. Defaults to 'Letter'.width
<string> Paper width, accepts values labeled with units.height
<string> Paper height, accepts values labeled with units.margin
<Object> Paper margins, defaults to none.
- 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.emulateMedia('screen') before calling page.pdf()
:
// Generates a PDF with 'screen' media type.
await page.emulateMedia('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 pixelspage.pdf({width: '100px'})
- prints with width set to 100 pixelspage.pdf({width: '10cm'})
- prints with width set to 10 centimeters.
All possible units are:
px
- pixelin
- inchcm
- centimetermm
- millimeter
The format
options are:
Letter
: 8.5in x 11inLegal
: 8.5in x 14inTabloid
: 11in x 17inLedger
: 17in x 11inA0
: 33.1in x 46.8inA1
: 23.4in x 33.1inA2
: 16.5in x 23.4inA3
: 11.7in x 16.5inA4
: 8.27in x 11.7inA5
: 5.83in x 8.27inA6
: 4.13in x 5.83in
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 javascript heap and finds all the objects with the given prototype.
// 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).
options
<Object> Navigation parameters which might have the following properties:timeout
<number> Maximum navigation time in milliseconds, defaults to 30 seconds, pass0
to disable timeout.waitUntil
<string> When to consider navigation succeeded, defaults toload
. Can be either:load
- consider navigation to be finished when theload
event is fired.domcontentloaded
- consider navigation to be finished when theDOMContentLoaded
event is fired.networkidle0
- consider navigation to be finished when there are no more then 0 network connections for at least500
ms.networkidle2
- consider navigation to be finished when there are no more then 2 network connections for at least500
ms.
- returns: <Promise<Response>> Promise which resolves to the main resource response. In case of multiple redirects, the navigation will resolve with the response of the last redirect.
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. Ifpath
is a relative path, then it is resolved relative to current working directory. If no path is provided, the image won't be saved to the disk.type
<string> Specify screenshot type, can be eitherjpeg
orpng
. Defaults to 'png'.quality
<number> The quality of the image, between 0-100. Not applicable topng
images.fullPage
<boolean> When true, takes a screenshot of the full scrollable page. Defaults tofalse
.clip
<Object> An object which specifies clipping region of the page. Should have the following fields:omitBackground
<boolean> Hides default white background and allows capturing screenshots with transparency. Defaults tofalse
.
- returns: <Promise<Buffer>> Promise which resolves to buffer with captured screenshot
selector
<string> A selector to query page for...values
<...string> Values of options to select. If the<select>
has themultiple
attribute, all values are considered, otherwise only the first one is taken into account.- returns: <Promise>
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.
page.select('select#colors', 'blue'); // single selection
page.select('select#colors', 'red', 'green', 'blue'); // multiple selections
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 page.setExtraHTTPHeaders does not guarantee the order of headers in the outgoing requests.
NOTE changing this value won't affect scripts that have already been run. It will take full effect on the next navigation.
Activating request interception enables request.abort
, request.continue
and
request.respond
methods.
An example of a naïve request interceptor that aborts all image requests:
const puppeteer = require('puppeteer');
puppeteer.launch().then(async browser => {
const page = await browser.newPage();
await page.setRequestInterceptionEnabled(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();
});
NOTE Request interception doesn't work with data URLs. Calling
abort
,continue
orrespond
on requests for data URLs is a noop.
userAgent
<string> Specific user agent to use in this page- returns: <Promise> Promise which resolves when the user agent is set.
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 to1
.isMobile
<boolean> Whether themeta viewport
tag is taken into account. Defaults tofalse
.hasTouch
<boolean> Specifies if viewport supports touch events. Defaults tofalse
isLandscape
<boolean> Specifies if viewport is in landscape mode. Defaults tofalse
.
- returns: <Promise>
NOTE in certain cases, setting viewport will reload the page in order to set the
isMobile
orhasTouch
properties.
In the case of multiple pages in a single browser, each page can have its own viewport size.
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 to tap in the center of the element.
If there's no element matching selector
, the method throws an error.
Shortcut for page.mainFrame().title().
- returns: <Touchscreen>
- returns: <Tracing>
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
.
page.type('#mytextarea', 'Hello'); // Types instantly
page.type('#mytextarea', 'World', {delay: 100}); // Types slower, like a user
- returns: <string>
This is a shortcut for page.mainFrame().url()
- 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 to1
.isMobile
<boolean> Whether themeta viewport
tag is taken into account. Defaults tofalse
.hasTouch
<boolean> Specifies if viewport supports touch events. Defaults tofalse
isLandscape
<boolean> Specifies if viewport is in landscape mode. Defaults tofalse
.
selectorOrFunctionOrTimeout
<string|number|function> A selector, predicate or timeout to wait foroptions
<Object> Optional waiting parameters...args
<...Serializable> Arguments to pass topageFunction
- returns: <Promise>
This method behaves differently with respect to the type of the first parameter:
- if
selectorOrFunctionOrTimeout
is astring
, then the first argument is treated as a selector to wait for and the method is a shortcut for page.waitForSelector - if
selectorOrFunctionOrTimeout
is afunction
, then the first argument is treated as a predicate to wait for and the method is a shortcut for page.waitForFunction(). - if
selectorOrFunctionOrTimeout
is anumber
, 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
Shortcut for page.mainFrame().waitFor(selectorOrFunctionOrTimeout[, options[, ...args]]).
pageFunction
<function|string> Function to be evaluated in browser contextoptions
<Object> Optional waiting parameterspolling
<string|number> An interval at which thepageFunction
is executed, defaults toraf
. Ifpolling
is a number, then it is treated as an interval in milliseconds at which the function would be executed. Ifpolling
is a string, then it can be one of the following values:raf
- to constantly executepageFunction
inrequestAnimationFrame
callback. This is the tightest polling mode which is suitable to observe styling changes.mutation
- to executepageFunction
on every DOM mutation.
timeout
<number> maximum time to wait for in milliseconds. Defaults to30000
(30 seconds).
...args
<...Serializable> Arguments to pass topageFunction
- returns: <Promise> Promise which resolves when the
pageFunction
returns a truthy value.
The waitForFunction
can be used to observe viewport size change:
const puppeteer = require('puppeteer');
puppeteer.launch().then(async browser => {
const page = await browser.newPage();
const watchDog = page.waitForFunction('window.innerWidth < 100');
page.setViewport({width: 50, height: 50});
await watchDog;
await browser.close();
});
Shortcut for page.mainFrame().waitForFunction(pageFunction[, options[, ...args]]).
options
<Object> Navigation parameters which might have the following properties:timeout
<number> Maximum navigation time in milliseconds, defaults to 30 seconds, pass0
to disable timeout.waitUntil
<string> When to consider navigation succeeded, defaults toload
. Can be either:load
- consider navigation to be finished when theload
event is fired.domcontentloaded
- consider navigation to be finished when theDOMContentLoaded
event is fired.networkidle0
- consider navigation to be finished when there are no more then 0 network connections for at least500
ms.networkidle2
- consider navigation to be finished when there are no more then 2 network connections for at least500
ms.
- returns: <Promise<Response>> Promise which resolves to the main resource response. In case of multiple redirects, the navigation will resolve with the response of the last redirect.
selector
<string> A selector of an element to wait for,options
<Object> Optional waiting parametersvisible
<boolean> wait for element to be present in DOM and to be visible, i.e. to not havedisplay: none
orvisibility: hidden
CSS properties. Defaults tofalse
.hidden
<boolean> wait for element to not be found in the DOM or to be hidden, i.e. havedisplay: none
orvisibility: hidden
CSS properties. Defaults tofalse
.timeout
<number> maximum time to wait for in milliseconds. Defaults to30000
(30 seconds).
- returns: <Promise> Promise which resolves when element specified by selector string is added to 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:
const puppeteer = require('puppeteer');
puppeteer.launch().then(async browser => {
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]).
Keyboard provides an api for managing a virtual keyboard. The high level api is keyboard.type
, which takes raw characters and generates proper keydown, keypress/input, and keyup events on your page.
For finer control, you can use keyboard.down
, keyboard.up
, and keyboard.sendCharacter
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:
page.keyboard.type('Hello World!');
page.keyboard.press('ArrowLeft');
page.keyboard.down('Shift');
for (let i = 0; i < ' World'.length; i++)
page.keyboard.press('ArrowLeft');
page.keyboard.up('Shift');
page.keyboard.press('Backspace');
// Result text will end up saying 'Hello!'
key
<string> Name of key to press, such asArrowLeft
. 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 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
.
After the key is pressed once, subsequent calls to keyboard.down
will have repeat set to true. To release the key, use keyboard.up
.
key
<string> Name of key to press, such asArrowLeft
. See USKeyboardLayout for a list of all key names.options
<Object>- returns: <Promise>
Shortcut for keyboard.down
and keyboard.up
.
Dispatches a keypress
and input
event. This does not send a keydown
or keyup
event.
page.keyboard.sendCharacter('嗨');
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
.
page.keyboard.type('Hello'); // Types instantly
page.keyboard.type('World', {delay: 100}); // Types slower, like a user
key
<string> Name of key to release, such asArrowLeft
. See USKeyboardLayout for a list of all key names.- returns: <Promise>
Dispatches a keyup
event.
x
<number>y
<number>options
<Object>button
<string>left
,right
, ormiddle
, defaults toleft
.clickCount
<number> defaults to 1. See UIEvent.detail.delay
<number> Time to wait betweenmousedown
andmouseup
in milliseconds. Defaults to 0.
- returns: <Promise>
Shortcut for mouse.move
, mouse.down
and mouse.up
.
options
<Object>button
<string>left
,right
, ormiddle
, defaults toleft
.clickCount
<number> defaults to 1. See UIEvent.detail.
- returns: <Promise>
Dispatches a mousedown
event.
x
<number>y
<number>options
<Object>steps
<number> defaults to 1. Sends intermediatemousemove
events.
- returns: <Promise>
Dispatches a mousemove
event.
options
<Object>button
<string>left
,right
, ormiddle
, defaults toleft
.clickCount
<number> defaults to 1. See UIEvent.detail.
- returns: <Promise>
Dispatches a mouseup
event.
Dispatches a touchstart
and touchend
event.
You can use tracing.start
and tracing.stop
to create a trace file which can be opened in Chrome DevTools or timeline viewer.
await page.tracing.start({path: 'trace.json'});
await page.goto('https://www.google.com');
await page.tracing.stop();
Only one trace can be active at a time per browser.
- returns: <Promise>
Dialog objects are dispatched by page via the 'dialog' event.
An example of using Dialog
class:
const puppeteer = require('puppeteer');
puppeteer.launch().then(async browser => {
const page = await browser.newPage();
page.on('dialog', async dialog => {
console.log(dialog.message());
await dialog.dismiss();
await browser.close();
});
page.evaluate(() => alert('1'));
});
promptText
<string> A text to enter in prompt. Does not cause any effects if the dialog'stype
is not prompt.- returns: <Promise> Promise which resolves when the dialog has been accepted.
- returns: <string> If dialog is prompt, returns default prompt value. Otherwise, returns empty string.
- returns: <Promise> Promise which resolves when the dialog has been dismissed.
- returns: <string> A message displayed in the dialog.
- <string>
Dialog's type, can be one of alert
, beforeunload
, confirm
or prompt
.
ConsoleMessage objects are dispatched by page via the 'console' event.
- <string>
- <string>
One of the following values: 'log'
, 'debug'
, 'info'
, 'error'
, 'warning'
, 'dir'
, 'dirxml'
, 'table'
, 'trace'
, 'clear'
, 'startGroup'
, 'startGroupCollapsed'
, 'endGroup'
, 'assert'
, 'profile'
, 'profileEnd'
, 'count'
, 'timeEnd'
.
At every point of time, page exposes its current frame tree via the page.mainFrame() and frame.childFrames() methods.
Frame object's lifecycle is controlled by three events, dispatched on the page object:
- 'frameattached' - fired when the frame gets attached to the page. A Frame can be attached to the page only once.
- 'framenavigated' - fired when the frame commits navigation to a different URL.
- '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:
const puppeteer = require('puppeteer');
puppeteer.launch().then(async browser => {
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 (let child of frame.childFrames())
dumpFrameTree(child, indent + ' ');
}
});
selector
<string> Selector to query page 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 will resolve to null
.
selector
<string> Selector to query page 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 resolve to []
.
selector
<string> A selector to query frame forpageFunction
<function> Function to be evaluated in browser context...args
<...Serializable|ElementHandle> Arguments to pass topageFunction
- returns: <Promise<Serializable>> Promise which resolves to the return value of
pageFunction
This method runs document.querySelectorAll
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:
const divsCounts = await frame.$$eval('div', divs => divs.length);
selector
<string> A selector to query frame forpageFunction
<function> Function to be evaluated in browser context...args
<...Serializable|ElementHandle> Arguments to pass topageFunction
- 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:
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);
options
<Object>url
<string> Url of a script to be added.path
<string> Path to the JavaScript file to be injected into frame. Ifpath
is a relative path, then it is resolved relative to current working directory.content
<string> Raw JavaScript content to be injected into frame.
- returns: <Promise> which resolves 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.
options
<Object>url
<string> Url of the<link>
tag.path
<string> Path to the CSS file to be injected into frame. Ifpath
is a relative path, then it is resolved relative to current working directory.content
<string> Raw CSS content to be injected into frame.
- returns: <Promise> which resolves 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.
pageFunction
<function|string> Function to be evaluated in browser context...args
<...Serializable|ElementHandle> Arguments to pass topageFunction
- returns: <Promise<Serializable>> Promise which resolves to function return value
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 into frame.evaluate
returns a non-Serializable value, then frame.evaluate
resolves to undefined
.
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.
console.log(await frame.evaluate('1 + 2')); // prints "3"
ElementHandle instances can be passed as arguments to the frame.evaluate
:
const bodyHandle = await frame.$('body');
const html = await frame.evaluate(body => body.innerHTML, bodyHandle);
await bodyHandle.dispose();
- returns: <ExecutionContext> Execution context associated with this frame.
- returns: <boolean>
Returns true
if the frame has been detached, or false
otherwise.
- 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.
- returns: <Frame> Returns parent frame, if any. Detached frames and main frames return
null
.
- returns: <string>
Returns frame's url.
selectorOrFunctionOrTimeout
<string|number|function> A selector, predicate or timeout to wait foroptions
<Object> Optional waiting parameters...args
<...Serializable> Arguments to pass topageFunction
- returns: <Promise>
This method behaves differently with respect to the type of the first parameter:
- if
selectorOrFunctionOrTimeout
is astring
, then the first argument is treated as a selector to wait for and the method is a shortcut for frame.waitForSelector - if
selectorOrFunctionOrTimeout
is afunction
, then the first argument is treated as a predicate to wait for and the method is a shortcut for frame.waitForFunction(). - if
selectorOrFunctionOrTimeout
is anumber
, 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
pageFunction
<function|string> Function to be evaluated in browser contextoptions
<Object> Optional waiting parameterspolling
<string|number> An interval at which thepageFunction
is executed, defaults toraf
. Ifpolling
is a number, then it is treated as an interval in milliseconds at which the function would be executed. Ifpolling
is a string, then it can be one of the following values:raf
- to constantly executepageFunction
inrequestAnimationFrame
callback. This is the tightest polling mode which is suitable to observe styling changes.mutation
- to executepageFunction
on every DOM mutation.
timeout
<number> maximum time to wait for in milliseconds. Defaults to30000
(30 seconds).
...args
<...Serializable> Arguments to pass topageFunction
- returns: <Promise> Promise which resolves when the
pageFunction
returns a truthy value.
The waitForFunction
can be used to observe viewport size change:
const puppeteer = require('puppeteer');
puppeteer.launch().then(async browser => {
const page = await browser.newPage();
const watchDog = page.mainFrame().waitForFunction('window.innerWidth < 100');
page.setViewport({width: 50, height: 50});
await watchDog;
await browser.close();
});
selector
<string> A selector of an element to wait for,options
<Object> Optional waiting parametersvisible
<boolean> wait for element to be present in DOM and to be visible, i.e. to not havedisplay: none
orvisibility: hidden
CSS properties. Defaults tofalse
.hidden
<boolean> wait for element to not be found in the DOM or to be hidden, i.e. havedisplay: none
orvisibility: hidden
CSS properties. Defaults tofalse
.timeout
<number> maximum time to wait for in milliseconds. Defaults to30000
(30 seconds).
- returns: <Promise> Promise which resolves when element specified by selector string is added to 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:
const puppeteer = require('puppeteer');
puppeteer.launch().then(async browser => {
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();
});
The class represents a context for JavaScript execution. Examples of JavaScript contexts are:
pageFunction
<function|string> Function to be evaluated inexecutionContext
...args
<...Serializable|ElementHandle> Arguments to pass topageFunction
- returns: <Promise<Serializable>> Promise which resolves to function return value
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.
const executionContext = 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.
console.log(await executionContext.evaluate('1 + 2')); // prints "3"
JSHandle instances can be passed as arguments to the executionContext.evaluate
:
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'.
pageFunction
<function|string> Function to be evaluated in theexecutionContext
...args
<...Serializable|JSHandle> Arguments to pass topageFunction
- returns: <Promise<JSHandle>> Resolves to the return value of
pageFunction
If the function, passed to the executionContext.evaluateHandle
, returns a Promise, then executionContext.evaluteHandle
would wait for the promise to resolve and return its value.
const context = 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.
const aHandle = await context.evaluateHandle('1 + 2'); // Handle for the '3' object.
JSHandle instances can be passed as arguments to the executionContext.evaluateHandle
:
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();
prototypeHandle
<JSHandle> A handle to the object prototype.- returns: <JSHandle> A handle to an array of objects with this prototype
The method iterates javascript heap and finds all the objects with the given prototype.
// 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();
JSHandle represents an in-page javascript object. JSHandles can be created with the page.evaluateHandle method.
const windowHandle = await page.evaluateHandle(() => window);
// ...
JSHandle prevents references JavaScript objects from garbage collection unless the handle is disposed. 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()
, page.evaluate()
and page.evaluateHandle
methods.
- returns: <ElementHandle>
Returns either null
or the object handle itself, if the object handle is an instance of ElementHandle.
- returns: <Promise> Promise which resolves when the object handle is successfully disposed.
The jsHandle.dispose
method stops referencing the element handle.
- returns: ExecutionContext
Returns execution context the handle belongs to.
The method returns a map with property names as keys and JSHandle instances for the property values.
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();
Fetches a single property from the referenced object.
Returns a JSON representation of the object. If the object has a
toJSON
function, it will not be called.
NOTE The method will return an empty JSON if the referenced object is not stringifiable. It will throw an error if the object has circular references.
NOTE Class ElementHandle extends JSHandle.
ElementHandle represents an in-page DOM element. ElementHandles can be created with the page.$ method.
const puppeteer = require('puppeteer');
puppeteer.launch().then(async browser => {
const page = await browser.newPage();
await page.goto('https://google.com');
const inputElement = await page.$('input[type=submit]');
await inputElement.click();
// ...
});
ElementHandle prevents DOM element from garbage collection unless the handle is disposed. ElementHandles are auto-disposed when their origin frame gets navigated.
ElementHandle instances can be used as arguments in page.$eval()
and page.evaluate()
methods.
- returns: <ElementHandle>
- returns: <Object>
This method returns the bounding box of the element (relative to the main frame), or null
if element is detached from dom.
options
<Object>button
<string>left
,right
, ormiddle
, defaults toleft
.clickCount
<number> defaults to 1. See UIEvent.detail.delay
<number> Time to wait betweenmousedown
andmouseup
in milliseconds. Defaults to 0.
- 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 to click in the center of the element. If the element is detached from DOM, the method throws an error.
- returns: <Promise> Promise which resolves when the element handle is successfully disposed.
The elementHandle.dispose
method stops referencing the element handle.
- returns: ExecutionContext
- returns: <Promise>
Calls focus on the element.
The method returns a map with property names as keys and JSHandle instances for the property values.
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
Fetches a single property from the objectHandle.
- returns: <Promise> Promise which resolves when the element is successfully hovered.
This method scrolls element into view if needed, and then uses page.mouse to hover over the center of the element. If the element is detached from DOM, the method throws an error.
Returns a JSON representation of the object. The JSON is generated by running JSON.stringify
on the object in page and consequent JSON.parse
in puppeteer.
NOTE The method will throw if the referenced object is not stringifiable.
key
<string> Name of key to press, such asArrowLeft
. See USKeyboardLayout for a list of all key names.options
<Object>- returns: <Promise>
Focuses the element, and then uses keyboard.down
and keyboard.up
.
options
<Object> Same options as in page.screenshot.- returns: <Promise<Buffer>> Promise which resolves to buffer with captured screenshot.
This method scrolls element into view if needed, and then uses page.screenshot to take a screenshot of the element. If the element is detached from DOM, the method throws an error.
- 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 to tap in the center of the element. If the element is detached from DOM, the method throws an error.
- returns: <string>
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
.
elementHandle.type('Hello'); // Types instantly
elementHandle.type('World', {delay: 100}); // Types slower, like a user
...filePaths
<...string> Sets the value of the file input these paths. If some of thefilePaths
are relative paths, then they are resolved relative to current working directory.- returns: <Promise>
This method expects elementHandle
to point to an input element.
Whenever the page sends a request, the following events are emitted by puppeteer's page:
- 'request' emitted when the request is issued by the page.
- 'response' emitted when/if the response is received for the request.
- '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 is emitted.
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.
errorCode
<string> Optional error code. Defaults tofailed
, 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 deniedaddressunreachable
- The IP address is unreachable. This usually means that there is no route to the specified host or network.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.
- returns: <Promise>
Aborts request. To use this, request interception should be enabled with page.setRequestInterceptionEnabled
.
Exception is immediately thrown if the request interception is not enabled.
overrides
<Object> Optional request overwrites, which can be one of the following:- returns: <Promise>
Continues request with optional request overrides. To use this, request interception should be enabled with page.setRequestInterceptionEnabled
.
Exception is immediately thrown if the request interception is not enabled.
- 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:
page.on('requestfailed', request => {
console.log(request.url + ' ' + request.failure().errorText);
});
- <Object> An object with HTTP headers associated with the request. All header names are lower-case.
- <string>
Contains the request's method (GET, POST, etc.)
- <string>
Contains the request's post body, if any.
- <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
.
Fulfills request with given response. To use this, request interception should
be enabled with page.setRequestInterceptionEnabled
. Exception is thrown if
request interception is not enabled.
An example of fulfilling all requests with 404 responses:
await page.setRequestInterceptionEnabled(true);
page.on('request', request => {
request.respond({
status: 404,
contentType: 'text/plain',
body: 'Not Found!'
});
});
- <string>
Contains the URL of the request.
Response class represents responses which are received by page.
- returns: <Promise<Buffer>> Promise which resolves to a buffer with response body.
- <Object> An object with HTTP headers associated with the response. All header names are lower-case.
- 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
.
- <boolean>
Contains a boolean stating whether the response was successful (status in the range 200-299) or not.
- <number>
Contains the status code of the response (e.g., 200 for a success).
- <string>
Contains the URL of the response.
If the target is not of type "page"
, returns null
.
- returns: <string>
Identifies what kind of target this is. Can be "page"
, "service_worker"
, or "other"
.
- returns: <string>