genshin-manager/dist/utils/PromiseEventEmitter.d.ts

<div align="center"> <p> <a href="https://www.npmjs.com/package/genshin-manager"><img src="https://img.shields.io/npm/v/genshin-manager.svg?maxAge=3600" alt="npm version" /></a> <a href="https://www.npmjs.com/package/genshin-manager"><img src="https:

/**
 * Type for event map.
 */
export type EventMap<T> = Record<keyof T, unknown[]> | DefaultEventMap;
type DefaultEventMap = [never];
type Key<K, E, T> = T extends DefaultEventMap ? string | symbol : (K | E) | keyof T;
type AnyRest = [...args: unknown[]];
type Args<K, T> = T extends DefaultEventMap ? AnyRest : K extends keyof T ? T[K] : never;
type Listener<K, T, R> = T extends DefaultEventMap ? (...args: unknown[]) => R : K extends keyof T ? T[K] extends unknown[] ? (...args: T[K]) => R : never : never;
/**
 * Type for event listener.
 */
export type Listener1<K, T> = Listener<K, T, Awaitable<void>>;
type Awaitable<Value> = PromiseLike<Value> | Value;
/**
 * Class for supporting asynchronous event listeners.
 * @see EventEmitter
 */
export declare abstract class PromiseEventEmitter<T extends EventMap<T>, E extends keyof T> {
    private readonly emitter;
    /**
     * Create a PromiseEventEmitter.
     */
    constructor();
    /**
     * Adds a **one-time**`listener` function for the event named `eventName`. The next time `eventName` is triggered, this listener is removed and then invoked.
     * @param eventName The name of the event.
     * @param listener The callback function. (supports async)
     * @see EventEmitter.once()
     */
    once<K>(eventName: Key<K, E, T>, listener: Listener1<K, T>): this;
    /**
     * Adds the `listener` function to the end of the listeners array for the event named `eventName`.
     * No checks are made to see if the `listener` has already been added.
     * Multiple calls passing the same combination of `eventName`and `listener` will result in the `listener` being added, and called, multiple times.
     * @param eventName The name of the event.
     * @param listener The callback function. (supports async)
     * @see EventEmitter.on()
     */
    on<K>(eventName: Key<K, E, T>, listener: Listener1<K, T>): this;
    /**
     * Alias for `emitter.on(eventName, listener)`.
     * @param eventName The name of the event.
     * @param listener The callback function. (supports async)
     * @see EventEmitter.addListener()
     */
    addListener<K>(eventName: Key<K, E, T>, listener: Listener1<K, T>): this;
    /**
     * Alias for `emitter.removeListener()`.
     * @param eventName The name of the event.
     * @param listener The callback function. (supports async)
     * @see EventEmitter.off()
     */
    off<K>(eventName: Key<K, E, T>, listener: Listener1<K, T>): this;
    /**
     * Removes the specified `listener` from the listener array for the event named`eventName`.
     * @param eventName The name of the event.
     * @param listener The callback function. (supports async)
     * @see EventEmitter.removeListener()
     */
    removeListener<K>(eventName: Key<K, E, T>, listener: Listener1<K, T>): this;
    /**
     * Removes all listeners, or those of the specified `eventName`.
     * @param event The name of the event.
     * @see EventEmitter.removeAllListeners()
     */
    removeAllListeners<K>(event?: Key<K, E, T>): this;
    /**
     * Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments to each.
     * Returns `true` if the event had listeners, `false` otherwise.
     * @param eventName The name of the event.
     * @param args Arguments to pass to the listeners.
     * @see EventEmitter.emit()
     */
    protected emit<K>(eventName: Key<K, E, T>, ...args: Args<K, T>): boolean;
}
export {};