Puppeteer 中文文档v25.8.0

Locator 类

定位器描述了一种定位对象并对其执行操作的策略。如果操作因对象尚未准备好而失败,则整个操作会被重试。成功操作所需的各种前置条件会被自动检查。

详细信息参见 https://pptr.dev/guides/page-interactions#locators

签名

export declare abstract class Locator<T> extends EventEmitter<LocatorEvents>

继承自: EventEmitter<LocatorEvents>

备注

此类的构造函数被标记为内部使用。第三方代码不应直接调用构造函数,也不应创建继承 Locator 类的子类。

属性

属性

修饰符

类型

说明

_

optional

T

用于对 Locator 进行名义类型化。

timeout

readonly

number

方法

方法

修饰符

说明

click(this, options)

点击定位到的元素。

clone()

克隆定位器。

fill(this, value, options)

使用提供的值填充定位器标识的输入。输入的类型在运行时确定,并根据类型选择合适的填充方法。支持 contenteditable、select、textarea 和 input 元素。对于复选框、单选按钮和开关,指定布尔值。

filter(predicate)

创建一个将针对定位到的值进行求值的期望。

如果期望不匹配,则定位器将重试。

hover(this, options)

将鼠标悬停在定位到的元素上。

map(mapper)

使用提供的 mapper 映射定位器。

race(locators)

static

在多个并行尝试定位元素的定位器之间创建竞态,但确保只有一个元素接收操作。

scroll(this, options)

滚动定位到的元素。

setEnsureElementIsInTheViewport(this, value)

通过克隆当前定位器创建一个新的定位器实例,并指定当元素尚未在视口中时,定位器是否应将元素滚动到视口中。

setTimeout(timeout)

通过克隆当前定位器创建一个新的定位器实例,并为定位器操作设置总超时。

传入 0 可禁用超时。

setVisibility(this, visibility)

通过克隆当前定位器创建一个新的定位器实例,并将 visibility 属性更改为指定值。

setWaitForEnabled(this, value)

通过克隆当前定位器创建一个新的定位器实例,并指定是否在操作前等待输入元素变为可用。适用于 clickfill 操作。

setWaitForStableBoundingBox(this, value)

通过克隆当前定位器创建一个新的定位器实例,并指定定位器是否必须等待元素的边界框在两个连续的动画帧之间保持一致。

wait(options)

等待定位器从页面获取序列化值。

注意这要求该值可被 JSON 序列化。

waitHandle(options)

等待定位器从页面获取句柄。