EventSource

interface

interface EventSource extends EventTarget

Represents a connection to a server that sends server-sent events, receiving updates pushed by the server as a stream of message events over a persistent HTTP connection that automatically reconnects when interrupted.

variable

var EventSource: { … }

The EventSource interface is a web content's interface to server-sent events. An EventSource instance opens a persistent connection to an HTTP server, which sends events in text/event-stream format. The connection remains open until closed by calling EventSource.close.

See also

https://developer.mozilla.org/docs/Web/API/EventSource

Constructors

`constructor`

new EventSource(url: string | URL, eventSourceInitDict?: EventSourceInit): EventSource

Properties

`onerror`

onerror: ((this: EventSource, ev: Event) => any) | null

`onmessage`

onmessage: ((this: EventSource, ev: MessageEvent) => any) | null

`onopen`

onopen: ((this: EventSource, ev: Event) => any) | null

`readyState`

readonly readyState: number

Returns the state of this EventSource object's connection. It can have the values described below.

`url`

readonly url: string

Returns the URL providing the event stream.

`withCredentials`

readonly withCredentials: boolean

Returns true if the credentials mode for connection requests to the URL providing the event stream is set to "include", and false otherwise.

`CONNECTING`

readonly CONNECTING: 0

readonly CONNECTING: 0

`OPEN`

readonly OPEN: 1

readonly OPEN: 1

`CLOSED`

readonly CLOSED: 2

readonly CLOSED: 2

`prototype`

prototype: EventSource

Methods

`close`

close(): void

Aborts any instances of the fetch algorithm started for this EventSource object, and sets the readyState attribute to CLOSED.

`addEventListener`

addEventListener<K extends keyof EventSourceEventMap>(type: K, listener: (this: EventSource, ev: EventSourceEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void

addEventListener(type: string, listener: (this: EventSource, event: MessageEvent) => any, options?: boolean | AddEventListenerOptions): void

addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void

`removeEventListener`

removeEventListener<K extends keyof EventSourceEventMap>(type: K, listener: (this: EventSource, ev: EventSourceEventMap[K]) => any, options?: boolean | EventListenerOptions): void

removeEventListener(type: string, listener: (this: EventSource, event: MessageEvent) => any, options?: boolean | EventListenerOptions): void

removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void