WebSocket: событие message

Базовая поддержка Широко доступно

Эта функция хорошо зарекомендовала себя и работает на многих устройствах и версиях браузеров. Она доступна в браузерах с июля 2015 года.

Примечание: Эта функция доступна в Web Workers.

Событие message срабатывает при получении данных через WebSocket.

Синтаксис

Используйте имя события в методах, таких как addEventListener(), или установите свойство обработчика события.

addEventListener("message", (event) => {});

onmessage = (event) => {};

Тип события

Объект MessageEvent. Наследуется от Event.

Свойства события

В дополнение к свойствам, перечисленным ниже, доступны свойства из родительского интерфейса Event.

data Только для чтения

Данные, отправленные источником сообщения. Тип этого свойства зависит от типа WebSocket-сообщения и значения WebSocket.binaryType.

Если тип сообщения — "текст", то это поле — строка.
Если тип сообщения — "бинарный", то тип этого свойства может быть определён из binaryType этого сокета:
- ArrayBuffer, если binaryType равно "arraybuffer",
- Blob, если binaryType равно "blob". У этого типа нет ассоциированного медиа типа (Blob.type равно "").

origin Только для чтения

Строка, представляющая происхождение отправителя сообщения.

Другие свойства из интерфейса MessageEvent присутствуют, но не относятся к API WebSocket и остаются со значениями по умолчанию:

lastEventId Только для чтения
source Только для чтения
ports Только для чтения

Примеры

// Create WebSocket connection.
const socket = new WebSocket("ws://localhost:8080");

// Listen for messages
socket.addEventListener("message", (event) => {
  console.log("Message from server ", event.data);
});

Спецификации

Спецификация
WebSocket # dom-websocket-onmessage

Совместимость с браузерами

	Рабочий стол					Мобильные устройства
	Chrome	Edge	Firefox	Opera	Safari	Chrome Android	Firefox для Android	Opera Android	Safari на IOS	Samsung Internet	WebView Android
`message_event`	5	12	7	12.1	5	18	7	12.1	4.2	1.0	≤37

См. также

© 2005–2024 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/message_event