Skip to main content

MessagePort

interface MessagePort
extends EventTarget

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.

Properties Jump to heading

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

Jump to headingpostMessage(
message: any,
transfer: Transferable[],
): void

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.

Throws a "DataCloneError" DOMException if transfer contains duplicate objects or port, or if message could not be cloned.

Begins dispatching messages received on the port. This is implicitly called when assigning a value to this.onmessage.

Jump to headingaddEventListener<K extends keyof MessagePortEventMap>(
type: K,
listener: () => any,
options?: boolean | AddEventListenerOptions,
): void
Jump to headingremoveEventListener<K extends keyof MessagePortEventMap>(
type: K,
listener: () => any,
options?: boolean | EventListenerOptions,
): void
variable MessagePort

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.

Properties Jump to heading

Back to top