WebSocket

Класс WebSocket представляет подключения websocket на странице.

Методы​

isClosed​

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

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

webSocket.isClosed();

Возвращаемое значение

• boolean

url​

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

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

webSocket.url();

Возвращаемое значение

• строка

waitForEvent​

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

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

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

Аргументы

• event строка

  Имя события, такое же, как передается в webSocket.on(event).

• optionsOrPredicate функция | объект *(необязательно)*

  • predicate функция

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

  • timeout число *(необязательно)*

    Максимальное время ожидания в миллисекундах. По умолчанию 0, нет таймаута. Значение по умолчанию можно изменить с помощью параметра actionTimeout в конфигурации или используя методы browserContext.setDefaultTimeout() или page.setDefaultTimeout().

  Либо предикат, получающий событие, либо объект параметров. Необязательно.

• options объект *(необязательно)*

  • predicate функция *(необязательно)*

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

Возвращаемое значение

• Promise<объект>

События​

on('close')​

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

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

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

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

• WebSocket

on('framereceived')​

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

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

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

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

• Объект

  • payload строка | Буфер

    Загрузка кадра

on('framesent')​

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

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

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

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

• Объект

  • payload строка | Буфер

    Загрузка кадра

on('socketerror')​

Срабатывает при ошибке веб-сокета.

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

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

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

• строка