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

等待事件触发并将其值传递给谓词函数。当谓词返回真值时返回。如果在事件触发前 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() 方法更改。

  可以是接收事件的谓词，也可以是选项对象。可选。

• 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

    帧载荷 (payload)

---

on('framesent')

新增于: v1.9 webSocket.on('framesent')

websocket 发送帧时触发。

用法

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

事件数据

• Object

  • payload string | Buffer

    帧载荷 (payload)

---

on('socketerror')

新增于: v1.9 webSocket.on('socketerror')

websocket 发生错误时触发。

用法

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

事件数据

• string