Interface TypedMessagePort<In, Out>

interface TypedMessagePort<In, Out> {
    onmessage: ((this, ev) => any);
    onmessageerror: ((this, ev) => any);
    addEventListener<K>(type, listener, options?): void;
    addEventListener(type, listener, options?): void;
    close(): void;
    dispatchEvent(event): boolean;
    postMessage(message, transfer): void;
    postMessage(message, options?): void;
    removeEventListener<K>(type, listener, options?): void;
    removeEventListener(type, listener, options?): void;
    start(): void;
}

Type Parameters

  • In = any

  • Out = any

Hierarchy

  • MessagePort
    • TypedMessagePort

Properties

onmessage onmessageerror

Methods

addEventListener close dispatchEvent postMessage removeEventListener start

Properties

onmessage

onmessage: ((this, ev) => any)

Type declaration

onmessageerror

onmessageerror: ((this, ev) => any)

Type declaration

Methods

addEventListener

  • addEventListener<K>(type, listener, options?): void

  • Type Parameters

    Parameters

    • type: K
    • listener: ((this, ev) => any)
    • Optional options: boolean | AddEventListenerOptions

    Returns void

  • addEventListener(type, listener, options?): void

  • Parameters

    • type: string
    • listener: EventListenerOrEventListenerObject
    • Optional options: boolean | AddEventListenerOptions

    Returns void

close

  • close(): void

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

    MDN Reference

    Returns void

dispatchEvent

  • dispatchEvent(event): boolean

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

    MDN Reference

    Parameters

    • event: Event

    Returns boolean

postMessage

  • postMessage(message, transfer): void

  • Parameters

    • message: Out
    • transfer: Transferable[]

    Returns void

  • postMessage(message, options?): void

  • Parameters

    • message: Out
    • Optional options: StructuredSerializeOptions

    Returns void

removeEventListener

  • removeEventListener<K>(type, listener, options?): void

  • Type Parameters

    Parameters

    • type: K
    • listener: ((this, ev) => any)
    • Optional options: boolean | EventListenerOptions

    Returns void

  • removeEventListener(type, listener, options?): void

  • Parameters

    • type: string
    • listener: EventListenerOrEventListenerObject
    • Optional options: boolean | EventListenerOptions

    Returns void

start

  • start(): void

  • Begins dispatching messages received on the port.

    MDN Reference

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc