Skip to main content

WebSocket

Класс [WebSocket] представляет собой WebSocket-соединения внутри страницы. Он предоставляет возможность инспектировать и изменять данные, которые передаются и принимаются.

Если вы хотите перехватывать или изменять кадры WebSocket, рассмотрите возможность использования [WebSocketRoute].

Методы​

isClosed​

Добавлено до v1.9 webSocket.isClosed

Указывает, что веб-сокет был закрыт.

Использование

webSocket.isClosed();

Возвращает

  • [boolean]#

url​

Добавлено до v1.9 webSocket.url

Содержит URL WebSocket.

Использование

webSocket.url();

Возвращает

  • [string]#

waitForEvent​

Добавлено до v1.9 webSocket.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')​

Добавлено до v1.9 webSocket.on('close')

Вызывается, когда веб-сокет закрывается.

Использование

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

Данные события

  • [WebSocket]

on('framereceived')​

Добавлено в: v1.9 webSocket.on('framereceived')

Вызывается, когда веб-сокет получает кадр.

Использование

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

Данные события

  • [Object]

    • payload [string] | [Buffer]

      полезная нагрузка кадра

on('framesent')​

Добавлено в: v1.9 webSocket.on('framesent')

Вызывается, когда веб-сокет отправляет кадр.

Использование

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

Данные события

  • [Object]

    • payload [string] | [Buffer]

      полезная нагрузка кадра

on('socketerror')​

Добавлено в: v1.9 webSocket.on('socketerror')

Вызывается, когда в веб-сокете происходит ошибка.

Использование

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

Данные события

  • [string]