Interface MessagePort

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.

Hierarchy

Properties

onmessage onmessageerror

Methods

addEventListener close dispatchEvent postMessage removeEventListener start

Properties

onmessage

onmessage: null | ((this: MessagePort, ev: MessageEvent<any>) => any)

onmessageerror

onmessageerror: null | ((this: MessagePort, ev: MessageEvent<any>) => any)

Methods

addEventListener

close

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

    Returns void

dispatchEvent

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    Parameters

    Returns boolean

postMessage

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

    Parameters

    Returns void

  • Parameters

    Returns void

removeEventListener

start

  • Begins dispatching messages received on the port.

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc