File Explorer

1/// <reference types="node" />2/**3 * Module for base types related to event emission4 *5 * @packageDocumentation6 * @module event7 */8import { EventEmitter } from 'events';9/**10 * Events are named via string or symbol11 *12 * @category Events13 */14export type EventKey = string | symbol;15export type EventEmissionCallback = () => void;16/**17 * Provides buffered event emitting semantics, similar to many Node-style streams.18 * Subclasses will override EventEmitter.on() and trigger uncorking.19 * NOTE: It is HIGHLY recommended that uncorking should always be done via20 * ```process.nextTick()```, not during the EventEmitter.on() call.21 *22 * See also: [Node writable streams](https://nodejs.org/api/stream.html#stream_writable_cork)23 *24 * @category Events25 */26export declare class BufferedEventEmitter extends EventEmitter {27    private corked;28    private eventQueue?;29    private lastQueuedEvent?;30    constructor();31    /**32     * Forces all written events to be buffered in memory. The buffered data will be33     * flushed when {@link BufferedEventEmitter.uncork} is called.34     */35    cork(): void;36    /**37     * Flushes all data buffered since {@link BufferedEventEmitter.cork} was called.38     *39     * NOTE: It is HIGHLY recommended that uncorking should always be done via40     * ``` process.nextTick```, not during the ```EventEmitter.on()``` call.41     */42    uncork(): void;43    /**44     * Synchronously calls each of the listeners registered for the event key supplied45     * in registration order. If the {@link BufferedEventEmitter} is currently corked,46     * the event will be buffered until {@link BufferedEventEmitter.uncork} is called.47     * @param event The name of the event48     * @param args Event payload49     */50    emit(event: EventKey, ...args: any[]): boolean;51    emitWithCallback(event: EventKey, emissionCallback: EventEmissionCallback, ...args: any[]): boolean;52}53