API 参考

¥API Reference

类

¥Classes

类	描述
无障碍	Accessibility 类提供了检查浏览器的辅助功能树的方法。可访问性树由 屏幕阅读器 或 switches 等辅助技术使用。
Browser	Browser 代表一个浏览器实例，它是： 通过 Puppeteer.connect() 连接到或 - 由 PuppeteerNode.launch() 推出。 Browser emits 各种事件记录在 BrowserEvent 枚举中。
BrowserContext	BrowserContext 代表 browser 中的各个用户上下文。 当 browser 启动时，默认有一个 浏览器上下文。其他可以使用 Browser.createBrowserContext() 创建。每个上下文都有独立的存储（cookies/localStorage/等） BrowserContext emits 各种事件记录在 BrowserContextEvent 枚举中。 如果 page 打开另一个 page，例如 使用 window.open，弹出窗口将属于父 页面的浏览器上下文。
CDPSession	CDPSession 实例用于讨论原始 Chrome Devtools 协议。
联系
ConsoleMessage	ConsoleMessage 对象通过 'console' 事件按页面调度。
覆盖范围	Coverage 类提供了收集有关页面所使用的 JavaScript 和 CSS 部分的信息的方法。
CSSCoverage
DeviceRequestPrompt	设备请求提示可让你通过 WebBluetooth 等 API 响应请求设备的页面。
DeviceRequestPromptDevice	设备处于请求提示状态。
对话	对话框实例由 页 通过 dialog 事件调度。
ElementHandle	ElementHandle 表示页内 DOM 元素。
EventEmitter	许多 Puppeteer 类扩展的 EventEmitter 类。
FileChooser	文件选择器可让你对请求文件的页面做出反应。
框架	代表一个 DOM 框架。 要理解框架，你可以将框架视为 <iframe> 元素。就像 iframe 一样，框架可以嵌套，并且当 JavaScript 在框架中执行时，JavaScript 不会影响 JavaScript 执行所在的环境框架内的框架。
HTTPRequest	表示页面发送的 HTTP 请求。
HTTPResponse	HTTPResponse 类表示 页 类接收到的响应。
JSCoverage
JSHandle	表示对 JavaScript 对象的引用。可以使用 Page.evaluateHandle() 创建实例。 句柄可防止引用的 JavaScript 对象被垃圾回收，除非句柄特意为 disposed。当 JSHandles 关联的框架被导航离开或父上下文被破坏时，JSHandles 会被自动处置。 句柄可用作任何评估函数（例如 Page.$eval()、Page.evaluate() 和 Page.evaluateHandle()）的参数。它们被解析为其引用的对象。
键盘	Keyboard 提供了用于管理虚拟键盘的 api。高级 API 是 Keyboard.type()，它采用原始字符并在页面上生成正确的 keydown、keypress/input 和 keyup 事件。
定位器	定位器描述了定位对象并对其执行操作的策略。如果由于对象尚未准备好执行操作而导致操作失败，则会重试整个操作。自动检查成功操作的各种先决条件。
Mouse	Mouse 类在相对于视口左上角的主框架 CSS 像素中运行。
页	Page 提供了与浏览器中的单个选项卡或 扩展背景页 进行交互的方法。 注意 一个浏览器实例可能有多个页面实例。
ProductLauncher	描述启动器 - 能够创建和启动浏览器实例的类。
ProtocolError	每当协议出现错误时就会触发 ProtocolError。
Puppeteer	主要的 Puppeteer 职业。 重要：如果你在 Node 环境中使用 Puppeteer，当你导入或 require puppeteer 时，你将获得 PuppeteerNode 的实例。该类扩展了 Puppeteer，因此具有下面记录的所有方法以及 PuppeteerNode 上定义的所有方法。
PuppeteerError	所有 Puppeteer 特定错误的基类
PuppeteerNode	使用用于获取和下载浏览器的 Node 特定行为扩展主 Puppeteer 类。 如果你在 Node 环境中使用 Puppeteer，则这是你在运行 require('puppeteer')（或等效的 ES import）时获得的类。
ScreenRecorder
SecurityDetails	SecurityDetails 类表示通过安全连接接收到的响应的安全详细信息。
目标	目标代表 CDP 目标。在 CDP 中，目标是可以调试的东西，例如框架、页面或工作线程。
TimeoutError	每当某些操作由于超时而终止时，就会触发 TimeoutError。
触摸屏	Touchscreen 类公开触摸屏事件。
追踪	Tracing 类公开跟踪审计接口。
UnsupportedOperation	如果当前使用的协议不支持某个方法，Puppeteer 将抛出此错误
WebWorker	该类代表 WebWorker。

枚举

¥Enumerations

枚举	描述
BrowserContextEvent
BrowserEvent	浏览器实例 可能触发的所有事件。
InterceptResolutionAction
LocatorEvent	定位器实例可能触发的所有事件。
PageEvent	页面实例可能触发的所有事件。
TargetType

函数

¥Functions

函数	描述
clearCustomQueryHandlers()
connect(options)
customQueryHandlerNames()
defaultArgs(options)
executablePath(channel)
launch(options)
registerCustomQueryHandler(name, handler)
trimCache()
unregisterCustomQueryHandler(name)

接口

¥Interfaces

界面	描述
ActionOptions
AutofillData
BoundingBox
BoxModel
BrowserConnectOptions	启动任何浏览器或连接到现有浏览器实例时可以传递的通用浏览器选项。
BrowserContextEvents
BrowserContextOptions
BrowserEvents
BrowserLaunchArgumentOptions	仅适用于 Chrome 的启动器选项。
CDPSessionEvents
ClickOptions
CommandOptions
CommonEventEmitter
配置	定义在安装和运行时配置 Puppeteer 行为的选项。 有关详细信息，请参阅各个属性。
ConnectionTransport
ConnectOptions
ConsoleMessageLocation
ContinueRequestOverrides
Cookie	代表一个 cookie 对象。
CookieParam	Cookie 参数对象
CoverageEntry	CoverageEntry 类代表覆盖率报告的一项。
证书
CSSCoverageOptions	CSS 覆盖范围的一组可配置选项。
CustomQueryHandler
DebugInfo
DeleteCookiesRequest
设备
ElementScreenshotOptions
FrameAddScriptTagOptions
FrameAddStyleTagOptions
FrameEvents
FrameWaitForFunctionOptions
GeolocationOptions
GoToOptions
InterceptResolutionState
InternalNetworkConditions
JSCoverageEntry	JavaScript 的 CoverageEntry 类
JSCoverageOptions	JS 覆盖率的一组可配置选项。
KeyboardTypeOptions
KeyDownOptions
LaunchOptions	启动任何浏览器时可以传递的通用启动选项。
LocatorEvents
LocatorOptions
LocatorScrollOptions
MediaFeature
指标
MouseClickOptions
MouseMoveOptions
MouseOptions
MouseWheelOptions
Moveable
NetworkConditions
NewDocumentScriptEvaluation
抵消
PageEvents	表示页面事件回调函数接收到的对象。 有关事件及其触发时间的更多详细信息，请参阅 PageEvent。
PDFMargin
PDFOptions	通过 Page.pdf() 配置 PDF 生成的有效选项。
Point
PuppeteerLaunchOptions
RemoteAddress
ResponseForRequest	满足请求所需的响应数据。
ScreencastOptions
ScreenshotClip
ScreenshotOptions
SerializedAXNode	表示一个节点及其与可访问性相关的属性。
SnapshotOptions
TracingOptions
视口
WaitForNetworkIdleOptions
WaitForOptions
WaitForSelectorOptions
WaitForTargetOptions
WaitTimeoutOptions

命名空间

¥Namespaces

命名空间	描述
CDPSessionEvent	CDPSession 类触发的事件。

变量

¥Variables

多变的	描述
DEFAULT_INTERCEPT_RESOLUTION_PRIORITY	默认协同请求拦截解析优先级
KnownDevices	与 Page.emulate() 一起使用的设备列表。
MouseButton	有效鼠标按钮的枚举。
PredefinedNetworkConditions	与 Page.emulateNetworkConditions() 一起使用的网络条件列表。
puppeteer

类型别名

¥Type Aliases

类型别名	描述
ActionResult
等待的
AwaitableIterable
AwaitablePredicate
AwaitedLocator
CDPEvents
ChromeReleaseChannel
ConsoleMessageType	控制台消息支持的类型。
CookiePriority	代表 cookie 的 '优先事项' 状态：https://tools.ietf.org/html/draft-west-cookie-priority-00
CookieSameSite	代表 cookie 的 'SameSite' 状态：https://tools.ietf.org/html/draft-west-first-party-cookies
CookieSourceScheme	表示最初设置 cookie 的源的源方案。值 "取消设置" 允许协议客户端模拟该方案的旧 cookie 范围。这是暂时的能力，将来会被删除。
ElementFor
ErrorCode
EvaluateFunc
EvaluateFuncWith
EventsWithWildcard
EventType
ExperimentsConfiguration	定义 Puppeteer 的实验选项。 有关详细信息，请参阅各个属性。
FlattenHandle
HandleFor
HandleOr
处理程序
InnerParams
KeyInput	可以传递给接受用户输入的函数的所有有效键，例如 keyboard.press
KeyPressOptions
LocatorClickOptions
LowerCasePaperFormat
Mapper
MouseButton
NodeFor
PaperFormat	打印 PDF 时的所有有效纸张格式类型。
Permission
Predicate
Product	支持的产品。
ProtocolLifeCycleEvent
ProtocolType
PuppeteerLifeCycleEvent
PuppeteerNodeLaunchOptions	公开工具类型，使用户能够定义可传递给 puppeteer.launch 的选项，而无需列出所有类型的集合。
Quad
ResourceType	渲染引擎感知到的 HTTPRequest 的资源类型。
TargetFilterCallback
VisibilityOption