MessagePort

open class MessagePort : EventTarget, MessageEventTarget, MessageEventSource, Transferable, JsCloseable(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

addEventListener

fun <E : Event> EventTargetLike.addEventListener(type: EventType<E>, handler: (E) -> Unit, options: AddEventListenerOptions? = undefined)

The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

open override fun close()

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

dispatchEvent

open fun dispatchEvent(event: Event): Boolean

The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.

postMessage

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

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

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

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.

removeEventListener

fun <E : Event> EventTargetLike.removeEventListener(type: EventType<E>, handler: (E) -> Unit, options: EventListenerOptions? = undefined)

The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.

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>

MDN Reference