Puppeteer APIv1.11 中文版

Released APIs: v1.1.1 | v1.1.0 | v1.0.0 | v0.13.0 | v0.12.0 | v0.11.0 | v0.10.2 | v0.10.1 | v0.10.0 | v0.9.0

Puppeteer API v1.1.1-post **NOT RELEASED**

NOTE 此版本的API 预计将会发布 于2018年3月15日.

Table of Contents

• Overview
• Environment Variables
• class: Puppeteer
  • puppeteer.connect(options)
  • puppeteer.createBrowserFetcher([options])
  • puppeteer.defaultArgs()
  • puppeteer.executablePath()
  • puppeteer.launch([options])
• class: BrowserFetcher
  • browserFetcher.canDownload(revision)
  • browserFetcher.download(revision[, progressCallback])
  • browserFetcher.localRevisions()
  • browserFetcher.platform()
  • browserFetcher.remove(revision)
  • browserFetcher.revisionInfo(revision)
• class: Browser
  • event: 'disconnected'
  • event: 'targetchanged'
  • event: 'targetcreated'
  • event: 'targetdestroyed'
  • browser.close()
  • browser.disconnect()
  • browser.newPage()
  • browser.pages()
  • browser.process()
  • browser.targets()
  • browser.userAgent()
  • browser.version()
  • browser.wsEndpoint()
• class: Page
  • event: 'console'
  • event: 'dialog'
  • event: 'domcontentloaded'
  • 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.$x(expression)
  • page.addScriptTag(options)
  • page.addStyleTag(options)
  • page.authenticate(credentials)
  • page.bringToFront()
  • page.click(selector[, options])
  • page.close()
  • page.content()
  • page.cookies(...urls)
  • page.coverage
  • 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.goBack(options)
  • page.goForward(options)
  • page.goto(url, options)
  • page.hover(selector)
  • page.keyboard
  • page.mainFrame()
  • page.metrics()
  • page.mouse
  • page.pdf(options)
  • page.queryObjects(prototypeHandle)
  • page.reload(options)
  • page.screenshot([options])
  • page.select(selector, ...values)
  • page.setCacheEnabled(enabled)
  • page.setContent(html)
  • page.setCookie(...cookies)
  • page.setDefaultNavigationTimeout(timeout)
  • page.setExtraHTTPHeaders(headers)
  • page.setJavaScriptEnabled(enabled)
  • page.setOfflineMode(enabled)
  • page.setRequestInterception(value)
  • page.setUserAgent(userAgent)
  • page.setViewport(viewport)
  • page.tap(selector)
  • page.target()
  • 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])
  • page.waitForXPath(xpath[, options])
• class: Keyboard
  • keyboard.down(key[, options])
  • keyboard.press(key[, options])
  • keyboard.sendCharacter(char)
  • keyboard.type(text, options)
  • keyboard.up(key)
• class: Mouse
  • mouse.click(x, y, [options])
  • mouse.down([options])
  • mouse.move(x, y, [options])
  • mouse.up([options])
• class: Touchscreen
  • touchscreen.tap(x, y)
• class: Tracing
  • tracing.start(options)
  • tracing.stop()
• class: Dialog
  • dialog.accept([promptText])
  • dialog.defaultValue()
  • dialog.dismiss()
  • dialog.message()
  • dialog.type()
• class: ConsoleMessage
  • consoleMessage.args()
  • consoleMessage.text()
  • consoleMessage.type()
• class: Frame
  • frame.$(selector)
  • frame.$$(selector)
  • frame.$$eval(selector, pageFunction[, ...args])
  • frame.$eval(selector, pageFunction[, ...args])
  • frame.$x(expression)
  • frame.addScriptTag(options)
  • frame.addStyleTag(options)
  • frame.childFrames()
  • frame.click(selector[, options])
  • frame.content()
  • frame.evaluate(pageFunction, ...args)
  • frame.evaluateHandle(pageFunction, ...args)
  • frame.executionContext()
  • frame.focus(selector)
  • frame.hover(selector)
  • frame.isDetached()
  • frame.name()
  • frame.parentFrame()
  • frame.select(selector, ...values)
  • frame.setContent(html)
  • frame.tap(selector)
  • frame.title()
  • frame.type(selector, text[, options])
  • frame.url()
  • frame.waitFor(selectorOrFunctionOrTimeout[, options[, ...args]])
  • frame.waitForFunction(pageFunction[, options[, ...args]])
  • frame.waitForSelector(selector[, options])
  • frame.waitForXPath(xpath[, options])
• class: ExecutionContext
  • executionContext.evaluate(pageFunction, ...args)
  • executionContext.evaluateHandle(pageFunction, ...args)
  • executionContext.frame()
  • executionContext.queryObjects(prototypeHandle)
• class: JSHandle
  • jsHandle.asElement()
  • jsHandle.dispose()
  • jsHandle.executionContext()
  • jsHandle.getProperties()
  • jsHandle.getProperty(propertyName)
  • jsHandle.jsonValue()
• class: ElementHandle
  • elementHandle.$(selector)
  • elementHandle.$$(selector)
  • elementHandle.$x(expression)
  • elementHandle.asElement()
  • elementHandle.boundingBox()
  • elementHandle.click([options])
  • elementHandle.contentFrame()
  • 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
  • request.abort([errorCode])
  • request.continue([overrides])
  • request.failure()
  • request.frame()
  • request.headers()
  • request.method()
  • request.postData()
  • request.resourceType()
  • request.respond(response)
  • request.response()
  • request.url()
• class: Response
  • response.buffer()
  • response.fromCache()
  • response.fromServiceWorker()
  • response.headers()
  • response.json()
  • response.ok()
  • response.request()
  • response.securityDetails()
  • response.status()
  • response.text()
  • response.url()
• class: SecurityDetails
  • securityDetails.issuer()
  • securityDetails.protocol()
  • securityDetails.subjectName()
  • securityDetails.validFrom()
  • securityDetails.validTo()
• class: Target
  • target.createCDPSession()
  • target.page()
  • target.type()
  • target.url()
• class: CDPSession
  • cdpSession.detach()
  • cdpSession.send(method[, params])
• class: Coverage
  • coverage.startCSSCoverage(options)
  • coverage.startJSCoverage(options)
  • coverage.stopCSSCoverage()
  • coverage.stopJSCoverage()

Overview

Puppeteer是一个Node库，它提供了一个高级API来通过DevTools协议控制Chromium或Chrome。

Puppeteer API是分层次的，反映了浏览器结构。

• Puppeteer 使用浏览器进行通信 DevTools Protocol.
• Browser 实例可以拥有多个页面。
• Page 至少有一个框架：主框架。 可能有其他框架由创建 iframe or frame tags.
• Frame 至少有一个执行上下文 - 默认执行上下文 - 执行框架的JavaScript。 一个框架可能有其他与之相关的执行上下文 extensions.

(图源: link)

环境变量

Puppeteer 寻找某些环境变量 以帮助其运作。这些变量既可以在环境中设置，也可以在 npm config.

• HTTP_PROXY, HTTPS_PROXY, NO_PROXY - 定义用于下载和运行Chromium的HTTP代理设置。
• PUPPETEER_SKIP_CHROMIUM_DOWNLOAD - 请勿在安装步骤中下载捆绑的Chromium。
• PUPPETEER_DOWNLOAD_HOST - 覆盖用于下载Chromium的URL的主机部分

class: Puppeteer

Puppeteer模块提供了一种启动Chromium实例的方法。 以下是使用Puppeteer驱动自动化的典型示例：

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();
});

puppeteer.connect(options)

• options