Interface IEventDispatcher<T>

Interface representing an object that allows listeners to register for event dispatching.

interface IEventDispatcher<T extends unknown[] = never[]> {
    isSubscribed(listener: Callable<T>): boolean;
    subscribe(
        listener: Callable<T>,
        options?: EventDispatcherSubscribeOptions,
    ): Callable | null;
    unsubscribe(listener: Callable<T>): void;
    wait(options?: EventDispatcherWaitOptions<T>): Promise<T>;
}

Type Parameters

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

Implemented by

Event

Index

Methods

isSubscribed subscribe unsubscribe wait

Methods

isSubscribed

isSubscribed(listener: Callable<T>): boolean
Tests whether a listener is registered.
Parameters
- listener: Callable<T>
  The listener function to check.
Returns boolean
true if the listener is registered, false otherwise.
- Defined in packages/misc-util/src/async/events/ievent-dispatcher.ts:69

subscribe(
listener: Callable<T>,
options?: EventDispatcherSubscribeOptions,
): Callable | null
Registers a listener function to be called when the event is dispatched.

If the listener is already registered, this method has no effect.
Parameters
- listener: Callable<T>
  The listener function to call when the event is dispatched.
- Optionaloptions: EventDispatcherSubscribeOptions
  Optional settings for the subscription.
Returns Callable | null
A function that can be called to unsubscribe the listener, or null if the listener was already registered.
- Defined in packages/misc-util/src/async/events/ievent-dispatcher.ts:49

unsubscribe

unsubscribe(listener: Callable<T>): void
Unregisters a previously registered listener function.

If the listener is not registered, this method has no effect.
Parameters
- listener: Callable<T>
  The listener function to remove.
Returns void
- Defined in packages/misc-util/src/async/events/ievent-dispatcher.ts:61

wait

wait(options?: EventDispatcherWaitOptions<T>): Promise<T>
Waits for the next occurrence of the event, optionally matching a predicate.

This is a convenience method that subscribes to the dispatcher, waits for the next event that matches the predicate (if provided), and then unsubscribes automatically.
Parameters
- Optionaloptions: EventDispatcherWaitOptions<T>
  Optional settings including predicate and abort signal.
Returns Promise<T>
A promise that resolves with the next event arguments as an array.
- Defined in packages/misc-util/src/async/events/ievent-dispatcher.ts:81