WebSocket

WebSocket 类表示页面内的 WebSocket 连接。它提供了检查和操作正在传输和接收的数据的能力。

如果您想拦截或修改 WebSocket 帧，请考虑使用 WebSocketRoute。

---

方法

isClosed

在 v1.9 版本之前添加。 webSocket.isClosed

指示 web socket 是否已关闭。

用法

webSocket.isClosed();

返回值

• boolean#

---

url

在 v1.9 版本之前添加。 webSocket.url

包含 WebSocket 的 URL。

用法

webSocket.url();

返回值

• string#

---

waitForEvent

在 v1.9 版本之前添加。 webSocket.waitForEvent

等待事件触发并将其值传递到 predicate 函数中。当 predicate 返回真值时返回。如果 webSocket 在事件触发之前关闭，将抛出错误。返回事件数据值。

用法

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

参数

• event string#

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

• optionsOrPredicate function | Object (可选)#

  • predicate function

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

  • timeout number (可选)

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

  可以是接收事件的 predicate 或 options 对象。可选。

• options Object (可选)

  • predicate function (可选)#

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

返回值

• Promise<Object>#

---

事件

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 => {});

事件数据

• Object

  • payload string | Buffer

    帧负载

---

on('framesent')

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

当 websocket 发送帧时触发。

用法

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

事件数据

• Object

  • payload string | Buffer

    帧负载

---

on('socketerror')

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

当 websocket 发生错误时触发。

用法

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

事件数据

• string