Skip to content

Interface: Channel<T>

Extends

Type Parameters

T

T

Properties

close()

close: () => void

Returns

void


createSubChannel()

createSubChannel: <U>(subId, name?) => Channel<U>

Type Parameters

U

U

Parameters

subId

string

name?

string

Returns

Channel<U>


id

id: string

Methods

addEventListener()

addEventListener(type, listener): void

Adds an event listener for incoming messages

Parameters

type

"message"

The event type ('message')

listener

Listener<T>

The message event listener

Returns

void

Inherited from

PostMessageEndpointBase.addEventListener


postMessage()

postMessage(data): void

Sends a message to the endpoint

Parameters

data

T

The data to send

Returns

void

Inherited from

PostMessageEndpointBase.postMessage


removeEventListener()

removeEventListener(type, listener): void

Removes an event listener for incoming messages

Parameters

type

"message"

The event type ('message')

listener

Listener<T>

The message event listener to remove

Returns

void

Inherited from

PostMessageEndpointBase.removeEventListener

Released under the MIT License.