kotlin-browser/web.sse/EventSource

EventSource

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

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

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

url

val url: String

Returns the URL providing the event stream.

withCredentials

val 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.

Functions

fun close()

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

dispatchEvent

fun dispatchEvent(event: Event): Boolean

when

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