The message event is fired when data is received through a WebSocket.
On this page
WebSocket: message event
Syntax
Use the event name in methods like addEventListener(), or set an event handler property.
js
addEventListener("message", (event) => {});
onmessage = (event) => {};
Event type
A MessageEvent. Inherits from Event.
Event properties
In addition to the properties listed below, properties from the parent interface, Event, are available.
dataRead only-
The data sent by the message emitter. The type of this property depends on the type of the WebSocket message and the value of
WebSocket.binaryType.- If the message type is "text", then this field is a string.
- If the message type is "binary" type, then the type of this property can be inferred from the
binaryTypeof this socket:ArrayBufferifbinaryTypeis"arraybuffer",BlobifbinaryTypeis"blob". This does not have an associated media type (Blob.typeis"").
originRead only-
A string representing the origin of the message emitter.
Other properties from the MessageEvent interface are present, but do not pertain to the WebSocket API and are left at their default values:
lastEventIdRead onlysourceRead onlyportsRead only
Examples
js
// Create WebSocket connection.
const socket = new WebSocket("ws://localhost:8080");
// Listen for messages
socket.addEventListener("message", (event) => {
console.log("Message from server ", event.data);
});
Specifications
| Specification |
|---|
| WebSockets Standard # dom-websocket-onmessage |
Browser compatibility
| Desktop | Mobile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
message_event |
5 | 12 | 7 | 10 | 12.1 | 5 | ≤37 | 18 | 7 | 12.1 | 4.2 | 1.0 |
See also
© 2005–2023 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