Skip to content

Visualize Your Ideas With Code

1.3 KB
Raw Blame
import {EventDispatcherBase, Subscribable} from './EventDispatcherBase';

export interface AsyncEventHandler<T> {
  (value: T): Promise<void>;
}

/**
 * Dispatches an asynchronous {@link SubscribableEvent}.
 *
 * @remarks
 * The {@link dispatch} method returns a promise that resolves when all the
 * handlers resolve.
 *
 * @example
 * ```ts
 * class Example {
 *   // expose the event to external classes
 *   public get onValueChanged {
 *     return this.value.subscribable;
 *   }
 *   // create a private dispatcher
 *   private value = new AsyncEventDispatcher<number>();
 *
 *   private async dispatchExample() {
 *     // dispatching returns a Promise.
 *     await this.value.dispatch(0);
 *   }
 * }
 * ```
 *
 * @typeParam T - The type of the argument passed to subscribers.
 */
export class AsyncEventDispatcher<T> extends EventDispatcherBase<
  T,
  AsyncEventHandler<T>
> {
  public async dispatch(value: T): Promise<void> {
    await Promise.all(this.notifySubscribers(value));
  }
}

/**
 * Provides safe access to the public interface of {@link AsyncEventDispatcher}.
 *
 * @remarks
 * External classes can use it to subscribe to an event without being able to
 * dispatch it.
 *
 * @typeParam T - The type of the argument passed to subscribers.
 */
export type SubscribableAsyncEvent<T> = Subscribable<T, AsyncEventHandler<T>>;