W3cubDocs

/Web APIs

EventSource: EventSource() constructor

The EventSource() constructor returns a newly-created EventSource, which represents a remote resource.

Syntax

js

new EventSource(url)
new EventSource(url, options)

Parameters

url

A string that represents the location of the remote resource serving the events/messages.

options Optional

Provides options to configure the new connection. The possible entries are:

withCredentials Optional

A boolean value, defaulting to false, indicating if CORS should be set to include credentials.

Examples

js

const evtSource = new EventSource("sse.php");
const eventList = document.querySelector("ul");

evtSource.onmessage = (e) => {
  const newElement = document.createElement("li");

  newElement.textContent = `message: ${e.data}`;
  eventList.appendChild(newElement);
};

Note: You can find a full example on GitHub — see Simple SSE demo using PHP.

Specifications

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
EventSource 6 79 6 No 11 5 4.4 18 45 12 5 1.0
cors_support 26 79 11 No 12 7 4.4 26 45 12 7 2.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/EventSource/EventSource