WebSocket

Класс WebSocket представляет подключения WebSocket на странице. Он позволяет проверять и изменять передаваемые и получаемые данные.

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

Методы​

isClosed​

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

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

webSocket.isClosed();

Возвращает

• boolean

url​

Содержит URL веб-сокета.

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

webSocket.url();

Возвращает

• string

waitForEvent​

Ожидает наступления события и передаёт его значение функции-предикату. Возвращает результат, когда предикат возвращает истинное значение. Вызывает ошибку, если веб-сокет закрывается до наступления события. Возвращает значение данных события.

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

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 (необязательно)

    Получает данные события и возвращает истинное значение, когда ожидание должно завершиться.

  • signal AbortSignal (необязательно)

    Позволяет отменить ожидание с помощью AbortSignal. Если сигнал отменён, ожидание будет прервано, а операция вызовет ошибку. Обратите внимание: передача сигнала не отключает тайм-аут по умолчанию, который можно изменить с помощью browserContext.setDefaultTimeout(); передайте timeout: 0, чтобы полностью отключить тайм-аут.

Возвращает

• Promise<Object>

События​

on('close')​

Вызывается при закрытии веб-сокета.

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

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

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

• WebSocket

on('framereceived')​

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

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

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

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

• Object

  • payload string | Buffer

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

on('framesent')​

Вызывается при отправке кадра веб-сокетом.

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

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

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

• Object

  • payload string | Buffer

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

on('socketerror')​

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

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

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

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

• string