EventSource()

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

Syntax

eventSource = new EventSource(url, configuration);

Parameters

url
A USVString that represents the location of the remote resource serving the events/messages.
configuration Optional
Provides options to configure the new connection. The possible entries are:
  • withCredentials, defaulting to false, indicating if CORS should be set to include credentials.

Examples

var evtSource = new EventSource('sse.php');
var eventList = document.querySelector('ul');

evtSource.onmessage = function(e) {
  var 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

Specification Status Comment
HTML Living Standard
The definition of 'EventSource()' in that specification.
Living Standard Initial definition

Browser compatibility

BCD tables only load in the browser

See also