其他

ActionOptions

ActionResult

AdapterState

模拟的蓝牙适配器状态。

AddScreenParams

asyncDisposeSymbol

AutofillAddressField

支持的自动填充地址字段名称。 <table><thead><tr><th> 成员 </th><th> 值 </th><th> 说明 </th></tr></thead>

AutofillData

引用： AutofillAddressField

Awaitable

AwaitableIterable

AwaitablePredicate

引用： Awaitable

AwaitedLocator

引用： Locator

BluetoothEmulation

暴露蓝牙模拟能力。 Web Bluetooth 规范要求模拟适配器应在每个顶层可导航单元中相互隔离。然而，目前 Chromium 的蓝牙模拟实现与浏览器上下文绑定，而非页面。这意味着来自同一浏览器上下文的不同页面所暴露的蓝牙模拟会互相干扰彼此的状态。

BluetoothManufacturerData

表示模拟蓝牙外设的制造商数据。 <table><thead><tr><th> 属性 </th><th> 修饰符 </th><th> 类型 </th><th> 说明

BoundingBox

继承自： Point <table><thead><tr><th> 属性 </th><th> 修饰符 </th><th> 类型 </th><th> 说明 </th><th>

BoxModel

BrowserContextEvent

BrowserContextEvents

继承自： Record<EventType, unknown> <table><thead><tr><th> 属性 </th><th> 修饰符 </th><th>

BrowserContextOptions

BrowserEvent

浏览器实例可能触发的所有事件。 <table><thead><tr><th> 成员 </th><th> 值 </th><th> 说明 </th></tr></thead>

BrowserEvents

继承自： Record<EventType, unknown> <table><thead><tr><th> 属性 </th><th> 修饰符 </th><th>

BrowserLauncher

描述一个启动器——一个能够创建并启动浏览器实例的类。此类的构造函数被标记为内部方法。第三方代码不应直接调用构造函数，也不应创建继承 BrowserLauncher 类的子类。

CDPEvents

CDPSessionEvent

CDPSession 类发出的事件。 <table><thead><tr><th> 变量 </th><th> 说明 </th></tr></thead> <tbody><tr><td>

CDPSessionEvents

继承自： CDPEvents, Record<EventType, unknown> <table><thead><tr><th> 属性 </th><th>

ChromeHeadlessShellSettings

ChromeReleaseChannel

ChromeSettings

ClickOptions

继承自： MouseClickOptions <table><thead><tr><th> 属性 </th><th> 修饰符 </th><th> 类型 </th><th>

CommandOptions

CommonEventEmitter

<table><thead><tr><th> 方法 </th><th> 说明 </th></tr></thead> <tbody><tr><td> <span id="emit">emit(type, event)</span>

Configuration

定义用于在安装和运行时配置 Puppeteer 行为的选项。更多信息请参见各个属性。 <table><thead><tr><th> 属性 </th><th> 修饰符

connect

Connection

继承自： EventEmitter<CDPSessionEvents> 此类的构造函数被标记为内部（internal）。第三方代码不应直接调用构造函数，也不应创建继承 Connection 类的子类。

ConnectionClosedError

如果底层协议连接已被关闭，则抛出此错误。继承自： ProtocolError

ConnectionTransport

ConnectOptions

启动任何浏览器或连接到现有浏览器实例时可传入的通用浏览器选项。 <table><thead><tr><th> 属性 </th><th> 修饰符 </th><th>

ConsoleMessageLocation

ConsoleMessageType

控制台消息支持的类型。

ContinueRequestOverrides

Cookie

表示一个 Cookie 对象。继承自： CookieData <table><thead><tr><th> 属性 </th><th> 修饰符 </th><th>

CookieData

用于在浏览器级 Cookie API 中设置 Cookie 的 Cookie 参数对象。 <table><thead><tr><th> 属性 </th><th>

CookieParam

用于在页面级 Cookie API 中设置 Cookie 的 Cookie 参数对象。 <table><thead><tr><th> 属性 </th><th> 修饰符

CookiePartitionKey

表示 Chrome 中的一个 Cookie 分区键。 <table><thead><tr><th> 属性 </th><th> 修饰符 </th><th> 类型 </th><th>

CookiePriority

表示 Cookie 的 'Priority' 状态：https://tools.ietf.org/html/draft-west-cookie-priority-00

CookieSameSite_2

表示 Cookie 的 'SameSite' 状态：https://tools.ietf.org/html/draft-west-first-party-cookies

CookieSourceScheme

表示最初设置 Cookie 的来源的源方案。值 "Unset" 允许协议客户端模拟该方案的旧版 Cookie 作用域。这是一种临时能力，将来会被移除。

CoverageEntry

CoverageEntry 类表示覆盖报告中的一个条目。 <table><thead><tr><th> 属性 </th><th> 修饰符 </th><th> 类型

CreatePageOptions

引用： WindowBounds

Credentials

CSSCoverage

CSSCoverageOptions

用于 CSS 覆盖率的一组可配置选项。 <table><thead><tr><th> 属性 </th><th> 修饰符 </th><th> 类型 </th><th>

CustomQueryHandler

DEBUG_PREFIXES

DebugInfo

DebugPrefix

引用： DEBUG\PREFIXES

DEFAULT_INTERCEPT_RESOLUTION_PRIORITY

默认的协作式请求拦截解析优先级

defaultArgs

DeleteCookiesRequest

Device

DeviceRequestPrompt

设备请求提示让你可以响应页面通过 WebBluetooth 等 API 发起的设备请求。 DeviceRequestPrompt 实例通过 Page.waitForDevicePrompt() 方法返回。

DeviceRequestPromptDevice

请求提示中的设备。 <table><thead><tr><th> 属性 </th><th> 修饰符 </th><th> 类型 </th><th> 说明 </th><th>

disposeSymbol

DownloadBehavior

DownloadPolicy

ElementFor

ElementScreenshotOptions

继承自： ScreenshotOptions <table><thead><tr><th> 属性 </th><th> 修饰符 </th><th> 类型 </th><th>

ErrorCode

EvaluateFunc

引用： InnerParams、Awaitable

EvaluateFuncWith

引用： InnerParams、Awaitable

EventsWithWildcard

引用： EventType

EventType

executablePath

ExperimentsConfiguration

为 Puppeteer 定义实验选项。更多信息请参阅各个属性。

Extension

Extension 表示安装在浏览器中的浏览器扩展。它可以访问扩展的 ID、名称和版本，并提供用于与扩展的后台 service worker 和页面进行交互的方法。

ExtensionInstallOptions

ExtensionTransport

实验性的 ExtensionTransport 允许在 Puppeteer 运行于扩展中时，通过 chrome.debugger API 建立连接。由于 Chrome DevTools 协议对扩展有限制，该 transport 实现了缺失的命令和事件。

FirefoxSettings

FlattenHandle

引用： HandleOr

FrameAddScriptTagOptions

FrameAddStyleTagOptions

FrameEvents

继承自： Record<EventType, unknown>

FrameWaitForFunctionOptions

GeolocationOptions

GetPWAStateOptions

Browser.getPWAState() 的选项。 <table><thead><tr><th> 属性 </th><th> 修饰符 </th><th> 类型 </th><th>

GoToOptions

继承自： WaitForOptions <table><thead><tr><th> 属性 </th><th> 修饰符 </th><th> 类型 </th><th>

HandleFor

引用： ElementHandle、JSHandle

HandleOr

引用： HandleFor、JSHandle

Handler

HeapSnapshotOptions

Page.captureHeapSnapshot() 的选项。 <table><thead><tr><th> 属性 </th><th> 修饰符 </th><th>

ImageFormat

InnerParams

引用： FlattenHandle

InstallPWAOptions

用于 Browser.installPWA() 的选项。 <table><thead><tr><th> 属性 </th><th> 修饰符 </th><th> 类型

InterceptResolutionAction

InterceptResolutionState

InternalNetworkConditions

继承自： NetworkConditions <table><thead><tr><th> 属性 </th><th> 修饰符 </th><th> 类型 </th><th>

Issue

Issue 接口表示一个 DevTools 问题。 <table><thead><tr><th> 属性 </th><th> 修饰符 </th><th> 类型 </th><th>

JSCoverage

此类的构造函数被标记为内部方法。第三方代码不应直接调用构造函数，也不应创建继承 JSCoverage 类的子类。 <table><thead><tr><th> 方法

JSCoverageEntry

用于 JavaScript 的 CoverageEntry 类。继承自： CoverageEntry <table><thead><tr><th> 属性 </th><th>

JSCoverageOptions

用于 JS 覆盖率的一组可配置选项。 <table><thead><tr><th> 属性 </th><th> 修饰符 </th><th> 类型 </th><th>

KeyboardTypeOptions

KeyDownOptions

KeyInput

所有可以传递给接受用户输入的函数（例如 keyboard.press）的有效按键

KeyPressOptions

引用： KeyDownOptions、KeyboardTypeOptions

KnownDevices

与 Page.emulate() 一起使用的设备列表。

launch

LaunchOptions

启动任何浏览器时可以传递的通用启动选项。继承自： ConnectOptions <table><thead><tr><th> 属性 </th><th> 修饰符

LaunchPWAOptions

Browser.launchPWA() 的选项。 <table><thead><tr><th> 属性 </th><th> 修饰符 </th><th> 类型 </th><th>

LocatorClickOptions

引用： ClickOptions、ActionOptions

LocatorEvent

定位器实例可能发出的所有事件。 <table><thead><tr><th> 成员 </th><th> 值 </th><th> 说明 </th></tr></thead>

LocatorEvents

继承自： Record<EventType, unknown> <table><thead><tr><th> 属性 </th><th> 修饰符 </th><th>

LocatorFillOptions

继承自： ActionOptions <table><thead><tr><th> 属性 </th><th> 修饰符 </th><th> 类型 </th><th>

LocatorScrollOptions

继承自： ActionOptions <table><thead><tr><th> 属性 </th><th> 修饰符 </th><th> 类型 </th><th>

Logger

一个日志记录器工厂函数，接收一个调试通道前缀，并返回一个用于向该通道输出日志的 LoggerFunction；如果该通道的日志记录被禁用，则返回 undefined。

LoggerFunction

由 Puppeteer 调用以输出调试消息的函数。

LowerCasePaperFormat

Mapper

引用： Awaitable

MediaFeature

要模拟的媒体特性。 <table><thead><tr><th> 属性 </th><th> 修饰符 </th><th> 类型 </th><th> 说明 </th><th>

Metrics

MouseButton

有效鼠标按键的枚举。

MouseClickOptions

继承自： MouseOptions <table><thead><tr><th> 属性 </th><th> 修饰符 </th><th> 类型 </th><th>

MouseMoveOptions

MouseOptions

MouseWheelOptions

Moveable

NetworkConditions

NewDocumentScriptEvaluation

NodeFor

Offset

PageEvent

页面实例可能触发的所有事件。 <table><thead><tr><th> 成员 </th><th> 值 </th><th> 说明 </th></tr></thead>

PageEvents

表示页面事件回调函数接收的对象。有关事件及其触发时机的更多详细信息，请参阅 PageEvent。继承自： Record<EventType, unknown>

PaperFormat

打印 PDF 时所有有效的纸张格式类型。引用： LowerCasePaperFormat 每种格式的尺寸如下： - Letter: 8.5in x 11in / 21.59cm x 27.94cm

PDFMargin

PDFOptions

通过 Page.pdf() 配置 PDF 生成的有效选项。 <table><thead><tr><th> 属性 </th><th> 修饰符 </th><th> 类型

Permission

警告：此 API 现已废弃。取而代之的是。

PermissionDescriptor_2

PermissionState_2

Point

PreconnectedPeripheral

要模拟的蓝牙外围设备。 <table><thead><tr><th> 属性 </th><th> 修饰符 </th><th> 类型 </th><th> 说明 </th><th>

PredefinedNetworkConditions

要与 Page.emulateNetworkConditions() 一起使用的预定义网络条件列表。

Predicate

引用： Awaitable

ProtocolError

每当协议出现错误时，就会抛出 ProtocolError。继承自： PuppeteerError <table><thead><tr><th> 属性 </th><th>

ProtocolLifeCycleEvent

ProtocolType

puppeteer

PuppeteerError

所有 Puppeteer 特定错误的基类继承自： Error 此类的构造函数被标记为内部使用。第三方代码不应直接调用构造函数，也不应创建继承 PuppeteerError 类的子类。

PuppeteerLifeCycleEvent

PWADisplayMode

用户是否更倾向于在独立窗口或浏览器标签页中打开已安装的 Web 应用。

PWAState

已安装 Web 应用的 OS 集成状态，由 Browser.getPWAState() 返回。 <table><thead><tr><th> 属性 </th><th>

Quad

引用： Point

QueryOptions

Realm

此类的构造函数被标记为内部方法。第三方代码不应直接调用构造函数，也不应创建继承 Realm 类的子类。 <table><thead><tr><th> 属性 </th><th>

ReloadOptions

继承自： WaitForOptions <table><thead><tr><th> 属性 </th><th> 修饰符 </th><th> 类型 </th><th>

RemoteAddress

ResourceType

渲染引擎所感知到的 HTTPRequest 的资源类型。

ResponseForRequest

用于完成请求所需的响应数据。 <table><thead><tr><th> 属性 </th><th> 修饰符 </th><th> 类型 </th><th> 说明

ScreencastOptions

ScreenInfo

ScreenOrientation_2

ScreenRecorder

继承自： PassThrough 此类的构造函数被标记为内部方法。第三方代码不应直接调用构造函数，也不应创建继承 ScreenRecorder 类的子类。 <table><thead><tr><th>

ScreenshotClip

继承自： BoundingBox <table><thead><tr><th> 属性 </th><th> 修饰符 </th><th> 类型 </th><th> 说明

ScreenshotOptions

SerializedAXNode

表示一个 Node 及其与无障碍（Accessibility）相关的属性。 <table><thead><tr><th> 属性 </th><th> 修饰符 </th><th>

SetContentWaitForOptions

继承自： WaitForOptions <table><thead><tr><th> 属性 </th><th> 修饰符 </th><th> 类型 </th><th>

SnapshotOptions

SupportedBrowser

Puppeteer 支持的浏览器。

SupportedWebDriverCapabilities

不由 Puppeteer 自身设置的 WebDriver BiDi 能力。 <table><thead><tr><th> 属性 </th><th> 修饰符 </th><th>

SupportedWebDriverCapability

TargetFilterCallback

引用： Target

TargetType

TouchError

当尝试移动或结束一个不存在的触摸时，会抛出 TouchError。继承自： PuppeteerError

TouchHandle

TouchHandle 接口提供了用于操作已开始触摸的方法。 <table><thead><tr><th> 方法 </th><th> 说明 </th></tr></thead>

TracingOptions

trimCache

返回值： Promise<void>

UninstallPWAOptions

Browser.uninstallPWA() 的选项。 <table><thead><tr><th> 属性 </th><th> 修饰符 </th><th> 类型

UnsupportedOperation

如果当前使用的协议不支持某个方法，Puppeteer 将抛出此错误。继承自： PuppeteerError

VideoFormat

Viewport

VisibilityOption

是否等待元素可见或隐藏。传入 null 以禁用可见性检查。

WaitForNetworkIdleOptions

继承自： WaitTimeoutOptions <table><thead><tr><th> 属性 </th><th> 修饰符 </th><th> 类型 </th><th>

WaitForOptions

WaitForSelectorOptions

WaitForTargetOptions

WaitTimeoutOptions

WebMCP

实验性 WebMCP 类为 WebMCP API 提供 API。更多详情请参阅 WebMCP 指南。继承自： EventEmitter<{ toolsadded: WebMCPToolsAddedEvent; toolsremoved: WebMCPToolsRemovedEvent; toolinvoked: WebMCPTool...

WebMCPTool

表示页面上一个已注册的 WebMCP 工具。继承自： EventEmitter<{ toolinvoked: WebMCPToolCall; }>

WebMCPToolCall

此类的构造函数被标记为内部使用。第三方代码不应直接调用构造函数，也不应创建继承 WebMCPToolCall 类的子类。 <table><thead><tr><th>

WebMCPToolCallResult

WebMCPToolsAddedEvent

WebMCPToolsRemovedEvent

WebWorkerEvent

WebWorkerEvents

继承自： Record<EventType, unknown> <table><thead><tr><th> 属性 </th><th> 修饰符 </th><th>

WindowBounds

WindowId

WindowState

WorkAreaInsets