Interface ISubscribable<T>

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

interface ISubscribable<T extends unknown[] = never[]> {
    isSubscribed(subscriber: Callback<T>): boolean;
    subscribe(
        subscriber: Callback<T>,
        options?: SubscribableSubscribeOptions,
    ): null | Callback;
    unsubscribe(subscriber: Callback<T>): void;
}

Type Parameters

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

Implemented by

Index

Methods

isSubscribed subscribe unsubscribe

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.
- Defined in packages/misc-util/src/async/isubscribable.ts:47

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.
- Defined in packages/misc-util/src/async/isubscribable.ts:27

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
- Defined in packages/misc-util/src/async/isubscribable.ts:39