Chartbreaker
    Preparing search index...

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

    MDN Reference

    interface MessagePort {
        onmessage: ((this: MessagePort, ev: MessageEvent) => any) | null;
        onmessageerror: ((this: MessagePort, ev: MessageEvent) => any) | null;
        addEventListener<K extends keyof MessagePortEventMap>(
            type: K,
            listener: (this: MessagePort, ev: MessagePortEventMap[K]) => any,
            options?: boolean | AddEventListenerOptions,
        ): void;
        addEventListener(
            type: string,
            listener: EventListenerOrEventListenerObject,
            options?: boolean | AddEventListenerOptions,
        ): void;
        close(): void;
        dispatchEvent(event: Event): boolean;
        postMessage(message: any, transfer: Transferable[]): void;
        postMessage(message: any, options?: StructuredSerializeOptions): void;
        removeEventListener<K extends keyof MessagePortEventMap>(
            type: K,
            listener: (this: MessagePort, ev: MessagePortEventMap[K]) => any,
            options?: boolean | EventListenerOptions,
        ): void;
        removeEventListener(
            type: string,
            listener: EventListenerOrEventListenerObject,
            options?: boolean | EventListenerOptions,
        ): void;
        start(): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

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

    Methods

    • The close() method of the MessagePort interface disconnects the port, so it is no longer active. This stops the flow of messages to that port.

      MDN Reference

      Returns void

    • The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) also apply to events dispatched manually with dispatchEvent().

      MDN Reference

      Parameters

      Returns boolean

    • The start() method of the MessagePort interface starts the sending of messages queued on the port. This method is only needed when using EventTarget.addEventListener; it is implied when using onmessage.

      MDN Reference

      Returns void