WebSocket

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

如果你想拦截或修改WebSocket帧，可以考虑使用WebSocketRoute。

方法​

isClosed​

表示WebSocket连接已关闭。

用法

webSocket.isClosed();

返回

• boolean#

网址​

包含WebSocket的URL。

用法

webSocket.url();

返回

• string#

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')​

当websocket关闭时触发。

用法

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

事件数据

• WebSocket

on('framereceived')​

当websocket接收到帧时触发。

用法

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

事件数据

• Object

  • payload string | Buffer

    帧载荷

on('framesent')​

当WebSocket发送帧时触发。

用法

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

事件数据

• Object

  • payload string | Buffer

    帧负载

on('socketerror')​

当websocket发生错误时触发。

用法

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

事件数据

• string