EventSource: message event
Baseline Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since January 2020.
Note: This feature is available inWeb Workers.
Themessage event of theEventSource interface is fired when data is received through an event source.
This event is not cancelable and does not bubble.
In this article
Syntax
Use the event name in methods likeaddEventListener(), or set an event handler property.
addEventListener("message", (event) => { })onmessage = (event) => { }Event type
AMessageEvent. Inherits fromEvent.
Event properties
This interface also inherits properties from its parent,Event.
MessageEvent.dataRead onlyThe data sent by the message emitter.
MessageEvent.originRead onlyA string representing the origin of the message emitter.
MessageEvent.lastEventIdRead onlyA string representing a unique ID for the event.
MessageEvent.sourceRead onlyA
MessageEventSource(which can be aWindowProxy,MessagePort, orServiceWorkerobject) representing the message emitter.MessageEvent.portsRead onlyAn array of
MessagePortobjects 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
In this basic example, anEventSource is created to receive events from the server; a page with the namesse.php is responsible for generating the events.
const evtSource = new EventSource("sse.php");const eventList = document.querySelector("ul");evtSource.addEventListener("message", (e) => { const newElement = document.createElement("li"); newElement.textContent = `message: ${e.data}`; eventList.appendChild(newElement);});onmessage equivalent
evtSource.onmessage = (e) => { const newElement = document.createElement("li"); newElement.textContent = `message: ${e.data}`; eventList.appendChild(newElement);};Specifications
| Specification |
|---|
| HTML> # event-message> |
| HTML> # handler-eventsource-onmessage> |