@jokio/ts-events
Version:
Various EventEmitter event replacements with synchronous, a-synchronous, and queued events. Made in TypeScript so usable with JavaScript and TypeScript.
26 lines (25 loc) • 1.08 kB
TypeScript
export * from './base-event';
export * from './sync-event';
export * from './queued-event';
export * from './async-event';
export * from './any-event';
import { default as EventQueue } from './EventQueue';
export { default as EventQueue } from './EventQueue';
/**
* The global event queue for QueuedEvents
*/
export declare function queue(): EventQueue;
/**
* Convenience function, same as EventQueue.global().flushOnce().
* Flushes the QueuedEvents, calling all events currently in the queue but not
* any events put into the queue as a result of the flush.
*/
export declare function flushOnce(): void;
/**
* Convenience function, same as EventQueue.global().flush().
* Flushes the QueuedEvents, calling all handlers currently in the queue and those
* put into the queue as a result of the flush.
* @param maxRounds Optional, default 10. Number of iterations after which to throw an error because
* the queue keeps filling up. Set to undefined or null to disable this.
*/
export declare function flush(maxRounds?: number): void;