aes70/src/events.d.ts

A controller library for the AES70 protocol.

/**
 * Basic event handling class.
 */
export class Events {
  constructor();

  /**
   * Emit an event.
   */
  emit(name: string, ...args: unknown[]): void;

  /**
   * Subscribe to an event.
   */
  on(name: string, cb: (...args: unknown[]) => void): void;

  /**
   * Subscribe to an event.
   */
  addEventListener(name: string, cb: (...args: unknown[]) => void): void;

  /**
   * Unsubscribe from an event.
   */
  removeEventListener(name: string, cb: (...args: unknown[]) => void): void;

  /**
   * Unsubscribe from an event.
   */
  off(name: string, cb: (...args: unknown[]) => void): void;

  /**
   * Removes all event listeners.
   */
  removeAllEventListeners(): void;

  /**
   * Subscribe to an event. Returns a cleanup function which can be called to
   * unsubscribe.
   */
  subscribe(name: string, cb: (...args: unknown[]) => void): () => void;
}