WebSocket

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

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

---

方法

isClosed

Added before v1.9 webSocket.isClosed

指示 WebSocket 是否已关闭。

用法

webSocket.isClosed();

返回值

• boolean#

---

url

Added before 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

    数据帧的有效载荷

---

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