Skip to main content

Interface: Channel<M>

Type Parameters

Type Parameter
M extends MessageMap

Properties

clientId

readonly clientId: string;

name

readonly name: string;

Methods

close()

close(): void;

Returns

void


on()

on<K>(type, handler): () => void;

Type Parameters

Type Parameter
K extends string

Parameters

ParameterType
typeK
handler(payload, meta) => void

Returns

() => void


post()

post<K>(type, payload): void;

Fire-and-forget to every other tab/window/worker on this origin. Not echoed to self.

Type Parameters

Type Parameter
K extends string

Parameters

ParameterType
typeK
payloadM[K]

Returns

void