kotlin-browser/web.sse/EventSource

EventSource

open class EventSource(val url: String, init: EventSourceInit = definedExternally) : EventTarget(source)

The EventSource interface is web content's interface to server-sent events.

MDN Reference

Constructors

EventSource

constructor(url: URL, init: EventSourceInit = definedExternally)

constructor(url: String, init: EventSourceInit = definedExternally)

Types

Companion

object Companion

ReadyState

sealed interface ReadyState

Properties

CLOSED

val CLOSED: EventSource.ReadyState

CONNECTING

val CONNECTING: EventSource.ReadyState

errorEvent

val errorEvent: EventInstance<Event, EventSource, EventSource>

MDN Reference

messageEvent

val messageEvent: EventInstance<MessageEvent<JsAny?>, EventSource, EventSource>

MDN Reference

onerror

var onerror: EventHandler<Event, EventSource, EventSource>?

MDN Reference

onmessage

var onmessage: EventHandler<MessageEvent<*>, EventSource, EventSource>?

MDN Reference

onopen

var onopen: EventHandler<Event, EventSource, EventSource>?

MDN Reference

OPEN

val OPEN: EventSource.ReadyState

openEvent

val openEvent: EventInstance<Event, EventSource, EventSource>

MDN Reference

readyState

val readyState: EventSource.ReadyState

The readyState read-only property of the connection.

url

val url: String

The url read-only property of the URL of the source.

withCredentials

val withCredentials: Boolean

The withCredentials read-only property of the the EventSource object was instantiated with CORS credentials set.

Functions

fun close()

The close() method of the EventSource interface closes the connection, if one is made, and sets the ``js-nolint close() `` None.

dispatchEvent

fun dispatchEvent(event: Event): Boolean

when

fun <T : Event> when(type: EventType<T>, options: ObservableEventListenerOptions?): Observable<T>