Class Subscribable<T>

Interface representing an object that allows subscribers to register for notifications.

Type Parameters

T extends unknown[] = never[]
Tuple type representing the arguments that will be passed to subscriber functions.

Hierarchy (View Summary)

Subscribable

Implements

ISubscribable<T>

Index

Constructors

Methods

isSubscribed publish subscribe unsubscribe

Constructors

constructor

new Subscribable<T extends unknown[] = never[]>(): Subscribable<T>
Type Parameters
- T extends unknown[] = never[]
Returns Subscribable<T>

Methods

isSubscribed

isSubscribed(subscriber: Callback<T>): boolean
Tests whether a subscriber is registered.
Parameters
- subscriber: Callback<T>
  The subscriber function to check.
Returns boolean
true if the subscriber is registered, false otherwise.
Implementation of ISubscribable.isSubscribed
- Defined in packages/misc-util/src/async/subscribable.ts:38

`Protected`publish

publish(...args: T): void
Parameters
- ...args: T
Returns void
- Defined in packages/misc-util/src/async/subscribable.ts:42

subscribe(
subscriber: Callback<T>,
options?: SubscribableSubscribeOptions,
): null | Callback
Registers a subscriber function to be called when the event is emitted.

If the subscriber is already registered, this method has no effect.
Parameters
- subscriber: Callback<T>
  The subscriber function to call when the event is emitted.
- Optionaloptions: SubscribableSubscribeOptions
  Optional settings for the subscription.
Returns null | Callback
A function that can be called to unsubscribe the subscriber, or null if the subscriber was already registered.
Implementation of ISubscribable.subscribe
- Defined in packages/misc-util/src/async/subscribable.ts:13

unsubscribe

unsubscribe(subscriber: Callback<T>): void
Unregisters a previously registered subscriber function.

If the subscriber is not registered, this method has no effect.
Parameters
- subscriber: Callback<T>
  The subscriber function to remove.
Returns void
Implementation of ISubscribable.unsubscribe
- Defined in packages/misc-util/src/async/subscribable.ts:34