WebSocket

该 WebSocket 类表示页面中的 WebSocket 连接。

---

方法

isClosed

在 v1.9 之前添加 webSocket.isClosed

指示 WebSocket 已关闭。

用法

webSocket.isClosed();

返回值

• 布尔值#

---

url

在 v1.9 之前添加 webSocket.url

包含 WebSocket 的 URL。

用法

webSocket.url();

返回值

• 字符串#

---

waitForEvent

在 v1.9 之前添加 webSocket.waitForEvent

等待事件触发并将它的值传递到谓词函数中。当谓词返回真值时返回。如果在事件触发之前 WebSocket 关闭，则会抛出错误。返回事件数据值。

用法

await webSocket.waitForEvent(event);
await webSocket.waitForEvent(event, optionsOrPredicate, options);

参数

• event 字符串#

  事件名称，与传递到 webSocket.on(event) 中的名称相同。

• optionsOrPredicate 函数 | 对象 （可选）#

  • predicate 函数

    接收事件数据，并在等待应解析时解析为真值。

  • timeout 数字 （可选）

    以毫秒为单位的最大等待时间。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项更改，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法更改。

  接收事件的谓词或选项对象。可选。

• options 对象 （可选）

  • predicate 函数 （可选）#

    接收事件数据，并在等待应解析时解析为真值。

返回值

• Promise<对象>#

---

事件

on('close')

在 v1.9 之前添加 webSocket.on('close')

当 WebSocket 关闭时触发。

用法

webSocket.on('close', data => {});

事件数据

• WebSocket

---

on('framereceived')

添加于：v1.9 webSocket.on('framereceived')

当 WebSocket 接收帧时触发。

用法

webSocket.on('framereceived', data => {});

事件数据

• 对象

  • payload 字符串 | 缓冲区

    帧有效负载

---

on('framesent')

添加于：v1.9 webSocket.on('framesent')

当 WebSocket 发送帧时触发。

用法

webSocket.on('framesent', data => {});

事件数据

• 对象

  • payload 字符串 | 缓冲区

    帧有效负载

---

on('socketerror')

添加于：v1.9 webSocket.on('socketerror')

当 WebSocket 发生错误时触发。

用法

webSocket.on('socketerror', data => {});

事件数据

• 字符串