MessagePort

class MessagePort : EventTarget, MessageEventTarget, MessageEventSource, Transferable(source)

This Channel Messaging API interface represents one of the two ports of a MessageChannel, allowing messages to be sent from one port and listening out for them arriving at the other.

MDN Reference

Properties

closeEvent

val closeEvent: EventInstance<Event, MessagePort, MessagePort>

MDN Reference

messageErrorEvent

val messageErrorEvent: EventInstance<MessageEvent<JsAny?>, MessagePort, MessagePort>

MDN Reference

messageEvent

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

MDN Reference

onmessage

open var onmessage: EventHandler<MessageEvent<*>, MessageEventTarget, MessageEventTarget>?

MDN Reference

onmessageerror

open var onmessageerror: EventHandler<MessageEvent<*>, MessageEventTarget, MessageEventTarget>?

MDN Reference

Functions

fun close()

Disconnects the port, so that it is no longer active.

dispatchEvent

fun dispatchEvent(event: Event): Boolean

postMessage

fun postMessage(message: JsAny?, transfer: ReadonlyArray<Transferable>)

Posts a message through the channel. Objects listed in transfer are transferred, not just cloned, meaning that they are no longer usable on the sending side.

fun postMessage(message: JsAny?, options: StructuredSerializeOptions = definedExternally)

start

fun start()

Begins dispatching messages received on the port.

when

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