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

WebSocket

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

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

メソッド​

isClosed​

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

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

使用法

webSocket.isClosed();

戻り値

url​

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

WebSocket の URL が含まれます。

使用法

webSocket.url();

戻り値

waitForEvent​

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

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

使用法

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

引数

  • event string#

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

  • optionsOrPredicate function | Object (オプション)#

    • predicate function

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

    • timeout number (optional)

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

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

  • options Object (optional)

    • predicate function (オプション)#

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

戻り値

イベント​

on('close')​

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

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

使用法

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

イベントデータ

on('framereceived')​

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

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

使用法

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

イベントデータ

on('framesent')​

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

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

使用法

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

イベントデータ

on('socketerror')​

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

Web ソケットにエラーが発生したときに発生します。

使用法

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

イベントデータ