Class SubscribableEvent<T>

An event that can have subscribers and can be waited on.

Type Parameters

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

Hierarchy (View Summary)

Subscribable<T>
- SubscribableEvent

Implements

ISubscribable<T>
IWaitable<never[], T>

Index

Constructors

Methods

isSubscribed publish subscribe trigger unsubscribe wait

Constructors

constructor

new SubscribableEvent<T extends unknown[] = []>(): SubscribableEvent<T>
Type Parameters
- T extends unknown[] = []
Returns SubscribableEvent<T>
Inherited from Subscribable.constructor

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
Inherited from Subscribable.isSubscribed
- Defined in packages/misc-util/src/async/subscribable.ts:38

`Protected`publish

publish(...args: T): void
Parameters
- ...args: T
Returns void
Inherited from Subscribable.publish
- 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
Inherited from Subscribable.subscribe
- Defined in packages/misc-util/src/async/subscribable.ts:13

trigger

trigger(...args: T): void
Trigger an event, calling all registered subscribers.
Parameters
- ...args: T
Returns void
- Defined in packages/misc-util/src/async/subscribable-event.ts:18

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
Inherited from Subscribable.unsubscribe
- Defined in packages/misc-util/src/async/subscribable.ts:34

wait

wait(signal?: null | AbortSignal): Promise<T>
Wait for the next event to be triggered.
Parameters
- Optionalsignal: null | AbortSignal
  Optional abort signal to cancel the wait.
Returns Promise<T>
A promise that resolves when the event is triggered.
Implementation of IWaitable.wait
- Defined in packages/misc-util/src/async/subscribable-event.ts:28