| | |
| | | * }); |
| | | * myEmitter.emit('event'); |
| | | * ``` |
| | | * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/events.js) |
| | | * @see [source](https://github.com/nodejs/node/blob/v17.0.0/lib/events.js) |
| | | */ |
| | | declare module 'events' { |
| | | interface EventEmitterOptions { |
| | |
| | | listener: (...args: any[]) => void, |
| | | opts?: { |
| | | once: boolean; |
| | | } |
| | | }, |
| | | ): any; |
| | | } |
| | | interface StaticEventEmitterOptions { |
| | |
| | | * ``` |
| | | * @since v11.13.0, v10.16.0 |
| | | */ |
| | | static once(emitter: NodeEventTarget, eventName: string | symbol, options?: StaticEventEmitterOptions): Promise<any[]>; |
| | | static once( |
| | | emitter: NodeEventTarget, |
| | | eventName: string | symbol, |
| | | options?: StaticEventEmitterOptions, |
| | | ): Promise<any[]>; |
| | | static once(emitter: DOMEventTarget, eventName: string, options?: StaticEventEmitterOptions): Promise<any[]>; |
| | | /** |
| | | * ```js |
| | |
| | | * @param eventName The name of the event being listened for |
| | | * @return that iterates `eventName` events emitted by the `emitter` |
| | | */ |
| | | static on(emitter: NodeJS.EventEmitter, eventName: string, options?: StaticEventEmitterOptions): AsyncIterableIterator<any>; |
| | | static on( |
| | | emitter: NodeJS.EventEmitter, |
| | | eventName: string, |
| | | options?: StaticEventEmitterOptions, |
| | | ): AsyncIterableIterator<any>; |
| | | /** |
| | | * A class method that returns the number of listeners for the given `eventName`registered on the given `emitter`. |
| | | * |
| | |
| | | * getEventListeners(et, 'foo'); // [listener] |
| | | * } |
| | | * ``` |
| | | * @since v15.2.0 |
| | | * @since v15.2.0, v14.17.0 |
| | | */ |
| | | static getEventListeners(emitter: DOMEventTarget | NodeJS.EventEmitter, name: string | symbol): Function[]; |
| | | /** |
| | | * By default `EventEmitter`s will print a warning if more than `10` listeners are |
| | | * added for a particular event. This is a useful default that helps finding |
| | | * memory leaks. The `EventEmitter.setMaxListeners()` method allows the default limit to be |
| | | * modified (if eventTargets is empty) or modify the limit specified in every `EventTarget` | `EventEmitter` passed as arguments. |
| | | * The value can be set to`Infinity` (or `0`) to indicate an unlimited number of listeners. |
| | | * |
| | | * ```js |
| | | * EventEmitter.setMaxListeners(20); |
| | | * // Equivalent to |
| | | * EventEmitter.defaultMaxListeners = 20; |
| | | * |
| | | * const eventTarget = new EventTarget(); |
| | | * // Only way to increase limit for `EventTarget` instances |
| | | * // as these doesn't expose its own `setMaxListeners` method |
| | | * EventEmitter.setMaxListeners(20, eventTarget); |
| | | * ``` |
| | | * @since v15.3.0, v14.17.0 |
| | | */ |
| | | static setMaxListeners(n?: number, ...eventTargets: Array<DOMEventTarget | NodeJS.EventEmitter>): void; |
| | | /** |
| | | * This symbol shall be used to install a listener for only monitoring `'error'` |
| | | * events. Listeners installed using this symbol are called before the regular |
| | | * `'error'` listeners are called. |