Interface IBroadcastSubscriber<T>

A subscriber to a Broadcast channel.

interface IBroadcastSubscriber<T> {
    closed: boolean;
    close(): void;
    receive(signal?: AbortSignal | null): Promise<T>;
}

Type Parameters

T

Index

Properties

Methods

Properties

`Readonly`closed

closed: boolean

Indicates whether the subscriber is closed.

Returns

true if the subscriber is closed, false otherwise.

Methods

close

close(): void
Closes the subscriber.

This will prevent further messages from being received. Any pending receive operations will be aborted.

Returns void
- Defined in packages/misc-util/src/async/synchro/broadcast.ts:46

receive

receive(signal?: AbortSignal | null): Promise<T>
Wait to receive a message from the broadcast channel.
Parameters
- Optionalsignal: AbortSignal | null
  An optional AbortSignal to cancel the receive operation.
Returns Promise<T>
Throws
If the subscriber has lagged behind and missed messages.
- Defined in packages/misc-util/src/async/synchro/broadcast.ts:54