MessagePort

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

The MessagePort interface of the Channel Messaging API 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

onmessage

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

MDN Reference

onmessageerror

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

MDN Reference

Functions

fun close()

The close() method of the MessagePort interface disconnects the port, so it is no longer active.

dispatchEvent

fun dispatchEvent(event: Event): Boolean

postMessage

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

The postMessage() method of the MessagePort interface sends a message from the port, and optionally, transfers ownership of objects to other browsing contexts.

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

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

fun postMessage(message: String, options: StructuredSerializeOptions = definedExternally)

start

fun start()

The start() method of the MessagePort interface starts the sending of messages queued on the port.

when

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