Channel

Type Parameters

Type Parameter	Default type
M extends MessageMap	-
R extends ReplyMap<M>	Record<never, never>

Properties

clientId

readonly clientId: string;

---

name

readonly name: string;

Methods

answer()

answer<K>(type, responder): () => void;

Answer asks of this type. Returns an unsubscribe.

Type Parameters

Type Parameter
K extends string

Parameters

Parameter	Type
type	K
responder	(payload, meta) => R[K]

Returns

() => void

---

ask()

ask<K>(
   type,
   payload,
options?): Promise<R[K]>;

Ask the origin a question and wait for the first answer.

Rejects if nobody answers before the timeout — an unanswered question is a fact worth having rather than a promise that hangs. If several clients registered an answer for this type, the first reply to arrive wins and the rest are dropped; gate the responder on leadership when you need the answer to come from a particular tab.

Type Parameters

Type Parameter
K extends string

Parameters

Parameter	Type
type	K
payload	M[K]
options?	AskOptions

Returns

Promise<R[K]>

---

close()

close(): void;

Returns

void

---

on()

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

Type Parameters

Type Parameter
K extends string

Parameters

Parameter	Type
type	K
handler	(payload, meta) => void
options?	OnOptions

Returns

() => void

---

post()

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

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

Type Parameters

Type Parameter
K extends string

Parameters

Parameter	Type
type	K
payload	M[K]
options?	PostOptions

Returns

void