WebSocket

WebSocket 類別代表頁面中的 websocket 連線。

---

方法

isClosed

v1.9 之前版本新增 webSocket.isClosed

表示 websocket 連線是否已關閉。

用法

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 - 無超時。預設值可以透過 config 中的 actionTimeout 選項更改，或使用 browserContext.setDefaultTimeout() 或 page.setDefaultTimeout() 方法。

  接收事件的 predicate 或選項物件。可選。

• 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 接收到 frame 時觸發。

用法

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

事件資料

• Object

  • payload string | Buffer

    frame payload

---

on('framesent')

v1.9 版本新增 webSocket.on('framesent')

當 websocket 發送 frame 時觸發。

用法

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

事件資料

• Object

  • payload string | Buffer

    frame payload

---

on('socketerror')

v1.9 版本新增 webSocket.on('socketerror')

當 websocket 發生錯誤時觸發。

用法

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

事件資料

• string