Interface: default
core/sse.default
Hierarchy
EventTarget↳
default
Properties
CLOSED
• Readonly CLOSED: number
CONNECTING
• Readonly CONNECTING: number
OPEN
• Readonly OPEN: number
onerror
• onerror: null | (ev: Event) => any
onmessage
• onmessage: null | (ev: MessageEvent<any>) => any
onopen
• onopen: null | (ev: Event) => any
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.
Methods
addEventListener
▸ addEventListener<K>(type, listener, options?): void
Type parameters
| Name | Type |
|---|---|
K | extends keyof EventSourceEventMap |
Parameters
| Name | Type |
|---|---|
type | K |
listener | (ev: EventSourceEventMap[K]) => any |
options? | boolean | AddEventListenerOptions |
Returns
void
Overrides
EventTarget.addEventListener
▸ addEventListener(type, listener, options?): void
Parameters
| Name | Type |
|---|---|
type | string |
listener | EventListenerOrEventListenerObject |
options? | boolean | AddEventListenerOptions |
Returns
void
Overrides
EventTarget.addEventListener
close
▸ close(): void
Aborts any instances of the fetch algorithm started for this EventSource object, and sets the readyState attribute to CLOSED.
Returns
void
dispatchEvent
▸ dispatchEvent(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
| Name | Type |
|---|---|
event | Event |
Returns
boolean
Inherited from
EventTarget.dispatchEvent
removeEventListener
▸ removeEventListener<K>(type, listener, options?): void
Type parameters
| Name | Type |
|---|---|
K | extends keyof EventSourceEventMap |
Parameters
| Name | Type |
|---|---|
type | K |
listener | (ev: EventSourceEventMap[K]) => any |
options? | boolean | EventListenerOptions |
Returns
void
Overrides
EventTarget.removeEventListener
▸ removeEventListener(type, listener, options?): void
Parameters
| Name | Type |
|---|---|
type | string |
listener | EventListenerOrEventListenerObject |
options? | boolean | EventListenerOptions |
Returns
void
Overrides
EventTarget.removeEventListener