メインコンテンツにスキップ

WebSocket

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

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

メソッド​

isClosed​

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

WebSocket が閉じられたことを示します。

使用法

webSocket.isClosed();

戻り値

url​

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

WebSocket の URL が含まれています。

使用法

webSocket.url();

戻り値

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 オブジェクトのいずれか。オプション。

  • options Object (オプション)

    • predicate function (オプション)#

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

戻り値

イベント​

on('close')​

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

WebSocket が閉じられると発火します。

使用法

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

イベントデータ

on('framereceived')​

追加バージョン: v1.9 webSocket.on('framereceived')

WebSocket がフレームを受信すると発火します。

使用法

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

イベントデータ

on('framesent')​

追加バージョン: v1.9 webSocket.on('framesent')

WebSocket がフレームを送信すると発火します。

使用法

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

イベントデータ

on('socketerror')​

追加バージョン: v1.9 webSocket.on('socketerror')

WebSocket でエラーが発生すると発火します。

使用法

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

イベントデータ