WebSocket

WebSocketクラスは、ページ内のWebSocket接続を表します。送受信されるデータを検査および操作する機能を提供します。

WebSocketフレームをインターセプトまたは変更したい場合は、WebSocketRouteの使用を検討してください。

---

メソッド

isClosed

v1.9より前に追加 webSocket.isClosed

ウェブソケットが閉じられたことを示します。

使用法

webSocket.isClosed();

戻り値

• boolean#

---

url

v1.9より前に追加 webSocket.url

WebSocketのURLが含まれます。

使用法

webSocket.url();

戻り値

• string#

---

waitForEvent

v1.9より前に追加 webSocket.waitForEvent

イベントが発生するのを待ち、その値を述語関数に渡します。述語が真値を返すと戻ります。イベントが発生する前にウェブソケットが閉じられた場合、エラーをスローします。イベントデータ値を返します。

使用法

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

引数

• event string#

  イベント名。webSocket.on(event)に渡すものと同じです。

• optionsOrPredicate function | Object (optional)#

  • predicate function

    イベントデータを受け取り、待機が解決されるべきときに真値に解決されます。

  • timeout number (optional)

    待機する最大時間（ミリ秒単位）。デフォルトは0（タイムアウトなし）です。デフォルト値は、設定のactionTimeoutオプション、またはbrowserContext.setDefaultTimeout()やpage.setDefaultTimeout()メソッドを使用して変更できます。

  イベントを受け取る述語、またはオプションオブジェクトのいずれか。オプション。

• options Object (optional)

  • predicate function (optional)#

    イベントデータを受け取り、待機が解決されるべきときに真値に解決されます。

戻り値

• Promise<Object>#

---

イベント

on('close')

v1.9より前に追加 webSocket.on('close')

ウェブソケットが閉じられたときに発生します。

使用法

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

イベントデータ

• WebSocket

---

on('framereceived')

追加日: v1.9 webSocket.on('framereceived')

ウェブソケットがフレームを受信したときに発生します。

使用法

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

イベントデータ

• オブジェクト

  • payload string | Buffer

    フレームペイロード

---

on('framesent')

追加日: v1.9 webSocket.on('framesent')

ウェブソケットがフレームを送信したときに発生します。

使用法

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

イベントデータ

• オブジェクト

  • payload string | Buffer

    フレームペイロード

---

on('socketerror')

追加日: v1.9 webSocket.on('socketerror')

ウェブソケットでエラーが発生したときに発生します。

使用法

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

イベントデータ

• string