WebSocket: message event
The message
event is fired when data is received through a WebSocket
.
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.
data
Read only-
The data sent by the message emitter.
origin
Read only-
A string representing the origin of the message emitter.
lastEventId
Read only-
A string representing a unique ID for the event.
source
Read only-
A
MessageEventSource
(which can be aWindow
,MessagePort
, orServiceWorker
object) representing the message emitter. ports
Read only-
An array of
MessagePort
objects representing the ports associated with the channel the message is being sent through (where appropriate, e.g. in channel messaging or when sending a message to a shared worker).
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
BCD tables only load in the browser