Interface EventSource

MDN Reference

Hierarchy

EventTarget
- EventSource

Index

Properties

CLOSED CONNECTING OPEN onerror onmessage onopen readyState url withCredentials

Methods

addEventListener close dispatchEvent removeEventListener

Properties

`Readonly` CLOSED

CLOSED: 2

`Readonly` CONNECTING

CONNECTING: 0

`Readonly` OPEN

OPEN: 1

onerror

onerror: ((this, ev) => any)

Type declaration

- (this, ev): any
- MDN Reference
  Parameters
  - this: EventSource
  - ev: Event
  Returns any

onmessage

onmessage: ((this, ev) => any)

Type declaration

- (this, ev): any
- MDN Reference
  Parameters
  - this: EventSource
  - ev: MessageEvent<any>
  Returns any

onopen

onopen: ((this, ev) => any)

Type declaration

- (this, ev): any
- MDN Reference
  Parameters
  - this: EventSource
  - ev: Event
  Returns any

`Readonly` readyState

readyState: number

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

MDN Reference

`Readonly` url

url: string

Returns the URL providing the event stream.

MDN Reference

`Readonly` withCredentials

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.

MDN Reference

Methods

addEventListener

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

Overrides EventTarget.addEventListener
addEventListener(type, listener, options?): void
Parameters
- type: string
- listener: ((this, event) => any)
  - - (this, event): any
    - Parameters
      
      this: EventSource
      
      event: MessageEvent<any>
      
      Returns any
- Optional options: boolean | AddEventListenerOptions
Returns void

Overrides EventTarget.addEventListener
addEventListener(type, listener, options?): void
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optional 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.

MDN Reference

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.

MDN Reference
Parameters
- event: Event
Returns boolean

Inherited from EventTarget.dispatchEvent

removeEventListener

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

Overrides EventTarget.removeEventListener
removeEventListener(type, listener, options?): void
Parameters
- type: string
- listener: ((this, event) => any)
  - - (this, event): any
    - Parameters
      
      this: EventSource
      
      event: MessageEvent<any>
      
      Returns any
- Optional options: boolean | EventListenerOptions
Returns void

Overrides EventTarget.removeEventListener
removeEventListener(type, listener, options?): void
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optional options: boolean | EventListenerOptions
Returns void

Overrides EventTarget.removeEventListener

Interface EventSource

Hierarchy

Index

Properties

Methods

Properties

Readonly CLOSED

Readonly CONNECTING

Readonly OPEN

onerror

Type declaration

Parameters

this: EventSource

ev: Event

Returns any

onmessage

Type declaration

Parameters

this: EventSource

ev: MessageEvent<any>

Returns any

onopen

Type declaration

Parameters

this: EventSource

ev: Event

Returns any

Readonly readyState

Readonly url

Readonly withCredentials

Methods

addEventListener

Type Parameters

K extends keyof EventSourceEventMap

Parameters

type: K

listener: ((this, ev) => any)

Parameters

this: EventSource

ev: EventSourceEventMap[K]

Returns any

Optional options: boolean | AddEventListenerOptions

Returns void

Parameters

type: string

listener: ((this, event) => any)

Parameters

this: EventSource

event: MessageEvent<any>

Returns any

Optional options: boolean | AddEventListenerOptions

Returns void

Parameters

type: string

listener: EventListenerOrEventListenerObject

Optional options: boolean | AddEventListenerOptions

Returns void

close

Returns void

dispatchEvent

Parameters

event: Event

Returns boolean

removeEventListener

Type Parameters

K extends keyof EventSourceEventMap

Parameters

type: K

listener: ((this, ev) => any)

Parameters

this: EventSource

ev: EventSourceEventMap[K]

Returns any

Optional options: boolean | EventListenerOptions

Returns void

Parameters

type: string

listener: ((this, event) => any)

Parameters

this: EventSource

`Readonly` CLOSED

`Readonly` CONNECTING

`Readonly` OPEN

`Readonly` readyState

`Readonly` url

`Readonly` withCredentials

`Optional` options: boolean | AddEventListenerOptions

`Optional` options: boolean | AddEventListenerOptions

`Optional` options: boolean | AddEventListenerOptions

`Optional` options: boolean | EventListenerOptions

`Optional` options: boolean | EventListenerOptions

`Optional` options: boolean | EventListenerOptions