EventSource: close() method

{{APIRef("Server Sent Events")}}{{AvailableInWorkers}}

The close() method of the {{domxref("EventSource")}} interface closes the connection, if one is made, and sets the {{domxref("EventSource.readyState")}} attribute to 2 (closed).

[!NOTE] If the connection is already closed, the method does nothing.

Syntax

close()

Parameters

None.

Return value

None ({{jsxref("undefined")}}).

Examples

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

button.onclick = () => {
  console.log("Connection closed");
  evtSource.close();
};

[!NOTE] You can find a full example on GitHub — see Simple SSE demo using PHP.

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also

• {{domxref("EventSource")}}