API 参考
类
| 类 | 描述 |
|---|---|
| 辅助功能 | Accessibility 类提供用于检查浏览器辅助功能树的方法。辅助功能树由辅助技术使用，例如 屏幕阅读器 或 开关。 |
| 浏览器 | Browser 代表一个浏览器实例，它要么 - 通过 Puppeteer.connect() 连接，要么 - 由 PuppeteerNode.launch() 启动。 Browser 发出 各种事件，这些事件在 BrowserEvent 枚举中进行了记录。 |
| 浏览器上下文 | BrowserContext 代表 浏览器 中的单个用户上下文。 当启动 浏览器 时，默认情况下它只有一个 浏览器上下文。可以使用 Browser.createBrowserContext() 创建其他上下文。每个上下文都有隔离的存储（cookie/localStorage/等）。 BrowserContext 发出 各种事件，这些事件在 BrowserContextEvent 枚举中进行了记录。 |
| CDPSession | CDPSession 实例用于与原始 Chrome Devtools 协议进行通信。 |
| 连接 | |
| ConsoleMessage | ConsoleMessage 对象由页面通过 'console' 事件派发。 |
| 覆盖率 | Coverage 类提供方法来收集有关页面使用的 JavaScript 和 CSS 部分的信息。 |
| CSSCoverage | |
| DeviceRequestPrompt | 设备请求提示允许您响应页面通过 WebBluetooth 等 API 请求设备。 |
| DeviceRequestPromptDevice | 设备请求提示中的设备。 |
| 对话框 | 对话框实例由 页面 通过 dialog 事件派发。 |
| ElementHandle | ElementHandle 代表页面内的 DOM 元素。 |
| EventEmitter | 许多 Puppeteer 类扩展的 EventEmitter 类。 |
| FileChooser | 文件选择器允许您对页面请求文件做出反应。 |
| 框架 | 代表 DOM 框架。 要理解框架，您可以将框架视为 |
| HTTPRequest | 代表页面发送的 HTTP 请求。 |
| HTTPResponse | HTTPResponse 类表示由 页面 类接收的响应。 |
| JSCoverage | |
| JSHandle | 代表对 JavaScript 对象的引用。可以使用 Page.evaluateHandle() 创建实例。 句柄防止引用的 JavaScript 对象被垃圾回收，除非句柄被故意 处置。当关联的框架被导航离开或父上下文被销毁时，JSHandle 会自动处置。 句柄可以用作任何评估函数的参数，例如 Page.$eval()、Page.evaluate() 和 Page.evaluateHandle()。它们被解析为其引用的对象。 |
| 键盘 | Keyboard 提供了一个用于管理虚拟键盘的 api。高级 api 是 Keyboard.type()，它接受原始字符并在您的页面上生成适当的 keydown、keypress/input 和 keyup 事件。 |
| 定位器 | 定位器描述了定位对象并在其上执行操作的策略。如果操作失败，因为对象未准备好执行操作，则整个操作将被重试。各种成功操作的先决条件会自动检查。 |
| 鼠标 | Mouse 类在相对于视窗左上角的主框架 CSS 像素中运行。 |
| 页面 | Page 提供方法与浏览器中的单个选项卡或 扩展程序后台页面 进行交互。 :::注意 一个浏览器实例可能包含多个页面实例。 ::: |
| 产品启动器 | 描述一个启动器 - 一个能够创建和启动浏览器实例的类。 |
| 协议错误 | 只要协议出现错误，就会发出 ProtocolError。 |
| 木偶 | 主要的 Puppeteer 类。 重要：如果您在 Node 环境中使用 Puppeteer，当您导入或需要 |
| 木偶错误 | 所有特定于 Puppeteer 的错误的基类 |
| 木偶节点 | 使用 Node 特定的行为扩展了主要的 Puppeteer 类，用于获取和下载浏览器。 如果您在 Node 环境中使用 Puppeteer，那么当您运行 |
| 屏幕录制器 | |
| 安全细节 | SecurityDetails 类表示通过安全连接接收到的响应的安全详细信息。 |
| 目标 | Target 代表一个 CDP 目标。在 CDP 中，目标是可以调试的任何东西，例如框架、页面或工作程序。 |
| 超时错误 | 只要某些操作因超时而终止，就会发出 TimeoutError。 |
| 触摸屏 | Touchscreen 类公开触摸屏事件。 |
| 跟踪 | Tracing 类公开跟踪审计接口。 |
| 不支持的操作 | 如果当前使用的协议不支持某个方法，Puppeteer 将抛出此错误 |
| Web 工作者 | 此类代表一个 Web 工作者。 |
枚举
| 枚举 | 描述 |
|---|---|
| 浏览器上下文事件 | |
| 浏览器事件 | 一个 浏览器实例 可能发出的所有事件。 |
| 拦截解析操作 | |
| LocatorEvent | 定位器实例可能发出的所有事件。 |
| PageEvent | 页面实例可能发出的所有事件。 |
| TargetType |
函数
接口
命名空间
| 命名空间 | 描述 |
|---|---|
| CDPSessionEvent | CDPSession 类发出的事件。 |
变量
| 变量 | 描述 |
|---|---|
| DEFAULT_INTERCEPT_RESOLUTION_PRIORITY | 默认的协作请求拦截解析优先级 |
| KnownDevices | 要与 Page.emulate() 一起使用的设备列表。 |
| MouseButton | 有效鼠标按钮的枚举。 |
| PredefinedNetworkConditions | 要与 Page.emulateNetworkConditions() 一起使用的网络条件列表。 |
| puppeteer |
类型别名
| 类型别名 | 描述 |
|---|---|
| ActionResult | |
| Awaitable | |
| 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 的来源方案。值为“Unset”允许协议客户端模拟方案的传统 cookie 范围。这是一种临时功能，将在未来移除。 |
| ElementFor | |
| ErrorCode | |
| EvaluateFunc | |
| EvaluateFuncWith | |
| EventsWithWildcard | |
| EventType | |
| ExperimentsConfiguration | 定义 Puppeteer 的实验选项。 有关更多信息，请参阅各个属性。 |
| FlattenHandle | |
| HandleFor | |
| HandleOr | |
| Handler | |
| InnerParams | |
| KeyInput | 所有可以传递给接受用户输入的函数的有效键，例如 keyboard.press |
| KeyPressOptions | |
| LocatorClickOptions | |
| LowerCasePaperFormat | |
| Mapper | |
| MouseButton | |
| NodeFor | |
| PaperFormat | 打印 PDF 时所有有效的纸张格式类型。 |
| Permission | |
| Predicate | |
| Product | 支持的产品。 |
| ProtocolLifeCycleEvent | |
| ProtocolType | |
| PuppeteerLifeCycleEvent | |
| PuppeteerNodeLaunchOptions | 公用类型，用于允许用户定义可以传递给 puppeteer.launch 的选项，而无需列出所有类型的集合。 |
| Quad | |
| ResourceType | 渲染引擎感知的 HTTP 请求的资源类型。 |
| TargetFilterCallback | |
| VisibilityOption |