puppeteer/docs/api.md

Puppeteer API

• class: Browser
  • new Browser([options])
  • browser.newPage()
  • browser.closePage()
  • browser.version()
  • browser.close()
• class: Page
  • page.addScriptTag(url)
  • page.injectFile(filePath)
  • page.setInPageCallback(name, callback)
  • page.setExtraHTTPHeaders(headers)
  • page.extraHTTPHeaders()
  • page.setUserAgentOverride(userAgent)
  • page.userAgentOverride()
  • page.url()
  • page.setContent(html)
  • page.navigate(url)
  • page.setViewportSize(size)
  • page.viewportSize()
  • page.evaluate(fun, args)
  • page.evaluateOnInitialized(fun, args)
  • page.screenshot([options])
  • page.printToPDF(filePath[, options])
  • page.plainText()
  • page.title()
  • page.close()

class: Browser

Browser manages a browser instance, creating it with a predefined settings, opening and closing pages. Instantiating Browser class does not necessarily result in launching browser; the instance will be launched when the need will arise.

new Browser([options])

• options <Object> Set of configurable options to set on the browser. Can have the following fields:
  • headless <boolean> Wether to run chromium in headless mode. Defaults to true.
  • remoteDebuggingPort <number> Specify a remote debugging port to open on chromium instance. Defaults to 9229.
  • executablePath <string> Path to a chromium executable to run instead of bundled chromium.
  • args <Array> Additional arguments to pass to the chromium instance. List of chromium flags could be found here.

browser.newPage()

• returns: <Promise<Page>>

Create a new page in browser and returns a promise which gets resolved with a Page object.

browser.closePage()

• returns: <Promise>

browser.version()

• returns: <Promise<string>>

browser.close()

Closes chromium application with all the pages (if any were opened). The browser object itself is considered to be disposed and could not be used anymore.

class: Page

Page provides interface to interact with a tab in a browser. Pages are created by browser:

var browser = new Browser();
browser.newPage().then(page => {
	...
});

Pages could be closed by page.close() method.

page.addScriptTag(url)

• url <string> Url of a script to be added
• returns: <Promise> Promise which resolves as the script gets added and loads.

page.injectFile(filePath)

• url <string> Path to the javascript file to be injected into page.
• returns: <Promise> Promise which resolves when file gets successfully evaluated in page.

page.setInPageCallback(name, callback)

• url <string> Name of the callback to be assigned on window object
• callback <Function> Callback function which will be called in node.js
• returns: <Promise> Promise which resolves when callback is successfully initialized

page.setExtraHTTPHeaders(headers)

• headers <Object> Key-value set of additional http headers to be sent with every request.
• returns: <Promise> Promise which resolves when additional headers are installed

page.extraHTTPHeaders()

• returns: <Object> Key-value set of additional http headers, which will be sent with every request.

page.setUserAgentOverride(userAgent)

• userAgent <string> Specific user agent to use in this page
• returns: <Promise> Promise which resolves when the user agent is set.

page.userAgentOverride()

• returns: <string> Returns user agent override, if any.

page.url()

• returns: <Promise<string>> Promise which resolves with the current page url.

page.setContent(html)

• html <string> HTML markup to assign to the page.
• returns: <Promise> Promise which resolves when the content is successfully assigned.

page.navigate(url)

• url <string> URL to navigate page to
• returns: <Promise<boolean>> Promise which resolves when the page is navigated. The promise resolves to:
  • true if the navigation succeeds and page's load event is fired.
  • false if the navigation fails due to bad URL or SSL errors.

page.setViewportSize(size)

• size <Object> An object with two fields:
  • width <number> Specify page's width in pixels.
  • height <number> Specify page's height in pixels.
• returns: <Promise> Promise which resolves when the dimensions are updated.

page.viewportSize()

• returns: <Object> An object with two fields:
  • width <number> Page's width in pixels.
  • height <number> Page's height in pixels.

page.evaluate(fun, args)

• fun <Function> Function to be evaluated in browser context
• args <Array> Arguments to pass to fun
• returns: <Promise<Object>> Promise which resolves to function return value

page.evaluateOnInitialized(fun, args)

• fun <Function> Function to be evaluated in browser context
• args <Array> Arguments to pass to fun
• returns: <Promise<Object>> Promise which resolves to function

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.
  • type <string> Specify screenshot type, could be either jpeg or png.
  • quality <number> The quality of the image, between 0-100. Not applicable to .jpg images.
  • fullPage <boolean> When true, takes a screenshot of the full scrollable page.
  • 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
• returns: <Promise<Buffer>> Promise which resolves to buffer with captured screenshot

page.printToPDF(filePath[, options])

• filePath <string> The file path to save the image to. The screenshot type will be inferred from file extension
• options <Object> Options object which might have the following properties:
  • scale <number>
  • displayHeaderFooter <boolean>
  • printBackground <boolean>
  • landscape <boolean>
  • pageRanges <string>
  • format <string>
  • width <number>
  • height <number>
• returns: <Promise> Promise which resolves when the PDF is saved.

page.plainText()

• returns: <Promise<string>> Returns page's inner text.

page.title()

• returns: <Promise<string>> Returns page's title.

page.close()

• returns: <Promise> Returns promise which resolves when page gets closed.