Interface EventSource
CLOSED: 2;
CONNECTING: 0;
onerror: ((this: EventSource, ev: Event) => any);
onmessage: ((this: EventSource, ev: MessageEvent<any>) => any);
onopen: ((this: EventSource, ev: Event) => any);
OPEN: 1;
readyState: number;
url: string;
withCredentials: boolean;
addEventListener<K>(type: K, listener: ((this: EventSource, ev: EventSourceEventMap[K]) => any), options?: boolean | AddEventListenerOptions): void;
addEventListener(type: string, listener: ((this: EventSource, event: MessageEvent<any>) => any), options?: boolean | AddEventListenerOptions): void;
addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
close(): void;
dispatchEvent(event: Event): boolean;
removeEventListener<K>(type: K, listener: ((this: EventSource, ev: EventSourceEventMap[K]) => any), options?: boolean | EventListenerOptions): void;
removeEventListener(type: string, listener: ((this: EventSource, event: MessageEvent<any>) => any), options?: boolean | EventListenerOptions): void;
removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
}
Hierarchy
- EventTarget
- EventSource (view full)
Index
Properties
ReadonlyCLOSED
ReadonlyCONNECTING
onerror
onmessage
onopen
ReadonlyOPEN
ReadonlyreadyState
Returns the state of this EventSource object's connection. It can have the values described below.
Readonlyurl
Returns the URL providing the event stream.
ReadonlywithCredentials
Returns true if the credentials mode for connection requests to the URL providing the event stream is set to "include", and false otherwise.
Methods
addEventListener
- add
Event <K>(type, listener, options?): voidListener Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.
The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.
When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.
When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.
When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.
If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.
The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.
Type Parameters
- K extends keyof EventSourceEventMap
Parameters
- type: K
- listener: ((this: EventSource, ev: EventSourceEventMap[K]) => any)
- (this, ev): any
Parameters
- this: EventSource
- ev: EventSourceEventMap[K]
Returns any
Optionaloptions: boolean | AddEventListenerOptions
Returns void
- add
Event (type, listener, options?): voidListener Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.
The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.
When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.
When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.
When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.
If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.
The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.
Parameters
- type: string
- listener: ((this: EventSource, event: MessageEvent<any>) => any)
- (this, event): any
Parameters
- this: EventSource
- event: MessageEvent<any>
Returns any
Optionaloptions: boolean | AddEventListenerOptions
Returns void
- add
Event (type, listener, options?): voidListener Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.
The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.
When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.
When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.
When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.
If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.
The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
Optionaloptions: boolean | AddEventListenerOptions
Returns void
close
dispatchEvent
- dispatch
Event (event): boolean Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.
Parameters
- event: Event
Returns boolean
removeEventListener
- remove
Event <K>(type, listener, options?): voidListener Removes the event listener in target's event listener list with the same type, callback, and options.
Type Parameters
- K extends keyof EventSourceEventMap
Parameters
- type: K
- listener: ((this: EventSource, ev: EventSourceEventMap[K]) => any)
- (this, ev): any
Parameters
- this: EventSource
- ev: EventSourceEventMap[K]
Returns any
Optionaloptions: boolean | EventListenerOptions
Returns void
- remove
Event (type, listener, options?): voidListener Removes the event listener in target's event listener list with the same type, callback, and options.
Parameters
- type: string
- listener: ((this: EventSource, event: MessageEvent<any>) => any)
- (this, event): any
Parameters
- this: EventSource
- event: MessageEvent<any>
Returns any
Optionaloptions: boolean | EventListenerOptions
Returns void
- remove
Event (type, listener, options?): voidListener Removes the event listener in target's event listener list with the same type, callback, and options.
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
Optionaloptions: boolean | EventListenerOptions
Returns void
MDN Reference