deno.land / std@0.166.0 / node / _events.d.ts

نووسراو ببینە
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
// Copyright 2018-2022 the Deno authors. All rights reserved. MIT license.// deno-lint-ignore-file no-explicit-any
// Forked from https://github.com/DefinitelyTyped/DefinitelyTyped/blob/9b9cd671114a2a5178809798d8e7f4d8ca6c2671/types/node/events.d.ts
export const captureRejectionSymbol: unique symbol;export const defaultMaxListeners: number;export const errorMonitor: unique symbol;
export interface Abortable { /** * When provided the corresponding `AbortController` can be used to cancel an asynchronous action. */ signal?: AbortSignal | undefined;}/** * Returns a copy of the array of listeners for the event named `eventName`. * * For `EventEmitter`s this behaves exactly the same as calling `.listeners` on * the emitter. * * For `EventTarget`s this is the only way to get the event listeners for the * event target. This is useful for debugging and diagnostic purposes. * * ```js * const { getEventListeners, EventEmitter } = require('events'); * * { * const ee = new EventEmitter(); * const listener = () => console.log('Events are fun'); * ee.on('foo', listener); * getEventListeners(ee, 'foo'); // [listener] * } * { * const et = new EventTarget(); * const listener = () => console.log('Events are fun'); * et.addEventListener('foo', listener); * getEventListeners(et, 'foo'); // [listener] * } * ``` * @since v15.2.0 */export function getEventListeners( emitter: EventTarget | EventEmitter, name: string | symbol, // deno-lint-ignore ban-types): Function[];
/** * ```js * const { on, EventEmitter } = require('events'); * * (async () => { * const ee = new EventEmitter(); * * // Emit later on * process.nextTick(() => { * ee.emit('foo', 'bar'); * ee.emit('foo', 42); * }); * * for await (const event of on(ee, 'foo')) { * // The execution of this inner block is synchronous and it * // processes one event at a time (even with await). Do not use * // if concurrent execution is required. * console.log(event); // prints ['bar'] [42] * } * // Unreachable here * })(); * ``` * * Returns an `AsyncIterator` that iterates `eventName` events. It will throw * if the `EventEmitter` emits `'error'`. It removes all listeners when * exiting the loop. The `value` returned by each iteration is an array * composed of the emitted event arguments. * * An `AbortSignal` can be used to cancel waiting on events: * * ```js * const { on, EventEmitter } = require('events'); * const ac = new AbortController(); * * (async () => { * const ee = new EventEmitter(); * * // Emit later on * process.nextTick(() => { * ee.emit('foo', 'bar'); * ee.emit('foo', 42); * }); * * for await (const event of on(ee, 'foo', { signal: ac.signal })) { * // The execution of this inner block is synchronous and it * // processes one event at a time (even with await). Do not use * // if concurrent execution is required. * console.log(event); // prints ['bar'] [42] * } * // Unreachable here * })(); * * process.nextTick(() => ac.abort()); * ``` * @since v13.6.0, v12.16.0 * @param eventName The name of the event being listened for * @return that iterates `eventName` events emitted by the `emitter` */export function on( emitter: EventEmitter, eventName: string, options?: StaticEventEmitterOptions,): AsyncIterableIterator<any>;
/** * Creates a `Promise` that is fulfilled when the `EventEmitter` emits the given * event or that is rejected if the `EventEmitter` emits `'error'` while waiting. * The `Promise` will resolve with an array of all the arguments emitted to the * given event. * * This method is intentionally generic and works with the web platform [EventTarget](https://dom.spec.whatwg.org/#interface-eventtarget) interface, which has no special`'error'` event * semantics and does not listen to the `'error'` event. * * ```js * const { once, EventEmitter } = require('events'); * * async function run() { * const ee = new EventEmitter(); * * process.nextTick(() => { * ee.emit('myevent', 42); * }); * * const [value] = await once(ee, 'myevent'); * console.log(value); * * const err = new Error('kaboom'); * process.nextTick(() => { * ee.emit('error', err); * }); * * try { * await once(ee, 'myevent'); * } catch (err) { * console.log('error happened', err); * } * } * * run(); * ``` * * The special handling of the `'error'` event is only used when `events.once()`is used to wait for another event. If `events.once()` is used to wait for the * '`error'` event itself, then it is treated as any other kind of event without * special handling: * * ```js * const { EventEmitter, once } = require('events'); * * const ee = new EventEmitter(); * * once(ee, 'error') * .then(([err]) => console.log('ok', err.message)) * .catch((err) => console.log('error', err.message)); * * ee.emit('error', new Error('boom')); * * // Prints: ok boom * ``` * * An `AbortSignal` can be used to cancel waiting for the event: * * ```js * const { EventEmitter, once } = require('events'); * * const ee = new EventEmitter(); * const ac = new AbortController(); * * async function foo(emitter, event, signal) { * try { * await once(emitter, event, { signal }); * console.log('event emitted!'); * } catch (error) { * if (error.name === 'AbortError') { * console.error('Waiting for the event was canceled!'); * } else { * console.error('There was an error', error.message); * } * } * } * * foo(ee, 'foo', ac.signal); * ac.abort(); // Abort waiting for the event * ee.emit('foo'); // Prints: Waiting for the event was canceled! * ``` * @since v11.13.0, v10.16.0 */export function once( emitter: NodeEventTarget, eventName: string | symbol, options?: StaticEventEmitterOptions,): Promise<any[]>;export function once( emitter: EventTarget, eventName: string, options?: StaticEventEmitterOptions,): Promise<any[]>;
/** * `n` {number} A non-negative number. The maximum number of listeners per `EventTarget` event. * `...eventsTargets` {EventTarget\[]|EventEmitter\[]} Zero or more {EventTarget} * or {EventEmitter} instances. If none are specified, `n` is set as the default * max for all newly created {EventTarget} and {EventEmitter} objects. * * ```mjs * import { setMaxListeners, EventEmitter } from 'node:events'; * * const target = new EventTarget(); * const emitter = new EventEmitter(); * * setMaxListeners(5, target, emitter); * ``` * * ```cjs * const { * setMaxListeners, * EventEmitter * } = require('node:events'); * * const target = new EventTarget(); * const emitter = new EventEmitter(); * * setMaxListeners(5, target, emitter); * ``` * @since v15.4.0 */export function setMaxListeners(n: number): EventEmitter;
/** * A class method that returns the number of listeners for the given `eventName`registered on the given `emitter`. * * ```js * const { EventEmitter, listenerCount } = require('events'); * const myEmitter = new EventEmitter(); * myEmitter.on('event', () => {}); * myEmitter.on('event', () => {}); * console.log(listenerCount(myEmitter, 'event')); * // Prints: 2 * ``` * @since v0.9.12 * @deprecated Since v3.2.0 - Use `listenerCount` instead. * @param emitter The emitter to query * @param eventName The event name */export function listenerCount( emitter: EventEmitter, eventName: string | symbol,): number;
interface EventEmitterOptions { /** * Enables automatic capturing of promise rejection. */ captureRejections?: boolean | undefined;}interface NodeEventTarget { once(eventName: string | symbol, listener: (...args: any[]) => void): this;}interface EventTarget { addEventListener( eventName: string, listener: (...args: any[]) => void, opts?: { once: boolean; }, ): any;}interface StaticEventEmitterOptions { signal?: AbortSignal | undefined;}/** * The `EventEmitter` class is defined and exposed by the `events` module: * * ```js * const EventEmitter = require('events'); * ``` * * All `EventEmitter`s emit the event `'newListener'` when new listeners are * added and `'removeListener'` when existing listeners are removed. * * It supports the following option: * @since v0.1.26 */export class EventEmitter { /** * Alias for `emitter.on(eventName, listener)`. * @since v0.1.26 */ addListener( eventName: string | symbol, listener: (...args: any[]) => void, ): 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. * * ```js * server.on('connection', (stream) => { * console.log('someone connected!'); * }); * ``` * * Returns a reference to the `EventEmitter`, so that calls can be chained. * * By default, event listeners are invoked in the order they are added. The`emitter.prependListener()` method can be used as an alternative to add the * event listener to the beginning of the listeners array. * * ```js * const myEE = new EventEmitter(); * myEE.on('foo', () => console.log('a')); * myEE.prependListener('foo', () => console.log('b')); * myEE.emit('foo'); * // Prints: * // b * // a * ``` * @since v0.1.101 * @param eventName The name of the event. * @param listener The callback function */ on(eventName: string | symbol, listener: (...args: any[]) => void): this; /** * Adds a **one-time**`listener` function for the event named `eventName`. The * next time `eventName` is triggered, this listener is removed and then invoked. * * ```js * server.once('connection', (stream) => { * console.log('Ah, we have our first user!'); * }); * ``` * * Returns a reference to the `EventEmitter`, so that calls can be chained. * * By default, event listeners are invoked in the order they are added. The`emitter.prependOnceListener()` method can be used as an alternative to add the * event listener to the beginning of the listeners array. * * ```js * const myEE = new EventEmitter(); * myEE.once('foo', () => console.log('a')); * myEE.prependOnceListener('foo', () => console.log('b')); * myEE.emit('foo'); * // Prints: * // b * // a * ``` * @since v0.3.0 * @param eventName The name of the event. * @param listener The callback function */ once(eventName: string | symbol, listener: (...args: any[]) => void): this; /** * Removes the specified `listener` from the listener array for the event named`eventName`. * * ```js * const callback = (stream) => { * console.log('someone connected!'); * }; * server.on('connection', callback); * // ... * server.removeListener('connection', callback); * ``` * * `removeListener()` will remove, at most, one instance of a listener from the * listener array. If any single listener has been added multiple times to the * listener array for the specified `eventName`, then `removeListener()` must be * called multiple times to remove each instance. * * Once an event is emitted, all listeners attached to it at the * time of emitting are called in order. This implies that any`removeListener()` or `removeAllListeners()` calls _after_ emitting and_before_ the last listener finishes execution will * not remove them from`emit()` in progress. Subsequent events behave as expected. * * ```js * const myEmitter = new MyEmitter(); * * const callbackA = () => { * console.log('A'); * myEmitter.removeListener('event', callbackB); * }; * * const callbackB = () => { * console.log('B'); * }; * * myEmitter.on('event', callbackA); * * myEmitter.on('event', callbackB); * * // callbackA removes listener callbackB but it will still be called. * // Internal listener array at time of emit [callbackA, callbackB] * myEmitter.emit('event'); * // Prints: * // A * // B * * // callbackB is now removed. * // Internal listener array [callbackA] * myEmitter.emit('event'); * // Prints: * // A * ``` * * Because listeners are managed using an internal array, calling this will * change the position indices of any listener registered _after_ the listener * being removed. This will not impact the order in which listeners are called, * but it means that any copies of the listener array as returned by * the `emitter.listeners()` method will need to be recreated. * * When a single function has been added as a handler multiple times for a single * event (as in the example below), `removeListener()` will remove the most * recently added instance. In the example the `once('ping')`listener is removed: * * ```js * const ee = new EventEmitter(); * * function pong() { * console.log('pong'); * } * * ee.on('ping', pong); * ee.once('ping', pong); * ee.removeListener('ping', pong); * * ee.emit('ping'); * ee.emit('ping'); * ``` * * Returns a reference to the `EventEmitter`, so that calls can be chained. * @since v0.1.26 */ removeListener( eventName: string | symbol, listener: (...args: any[]) => void, ): this; /** * Alias for `emitter.removeListener()`. * @since v10.0.0 */ off(eventName: string | symbol, listener: (...args: any[]) => void): this; /** * Removes all listeners, or those of the specified `eventName`. * * It is bad practice to remove listeners added elsewhere in the code, * particularly when the `EventEmitter` instance was created by some other * component or module (e.g. sockets or file streams). * * Returns a reference to the `EventEmitter`, so that calls can be chained. * @since v0.1.26 */ removeAllListeners(event?: string | symbol): this; /** * 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 `emitter.setMaxListeners()` method allows the limit to be * modified for this specific `EventEmitter` instance. The value can be set to`Infinity` (or `0`) to indicate an unlimited number of listeners. * * Returns a reference to the `EventEmitter`, so that calls can be chained. * @since v0.3.5 */ setMaxListeners(n: number): this; /** * Returns the current max listener value for the `EventEmitter` which is either * set by `emitter.setMaxListeners(n)` or defaults to {@link defaultMaxListeners}. * @since v1.0.0 */ getMaxListeners(): number; /** * Returns a copy of the array of listeners for the event named `eventName`. * * ```js * server.on('connection', (stream) => { * console.log('someone connected!'); * }); * console.log(util.inspect(server.listeners('connection'))); * // Prints: [ [Function] ] * ``` * @since v0.1.26 */ // deno-lint-ignore ban-types listeners(eventName: string | symbol): Function[]; /** * Returns a copy of the array of listeners for the event named `eventName`, * including any wrappers (such as those created by `.once()`). * * ```js * const emitter = new EventEmitter(); * emitter.once('log', () => console.log('log once')); * * // Returns a new Array with a function `onceWrapper` which has a property * // `listener` which contains the original listener bound above * const listeners = emitter.rawListeners('log'); * const logFnWrapper = listeners[0]; * * // Logs "log once" to the console and does not unbind the `once` event * logFnWrapper.listener(); * * // Logs "log once" to the console and removes the listener * logFnWrapper(); * * emitter.on('log', () => console.log('log persistently')); * // Will return a new Array with a single function bound by `.on()` above * const newListeners = emitter.rawListeners('log'); * * // Logs "log persistently" twice * newListeners[0](); * emitter.emit('log'); * ``` * @since v9.4.0 */ // deno-lint-ignore ban-types rawListeners(eventName: string | symbol): Function[]; /** * 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. * * ```js * const EventEmitter = require('events'); * const myEmitter = new EventEmitter(); * * // First listener * myEmitter.on('event', function firstListener() { * console.log('Helloooo! first listener'); * }); * // Second listener * myEmitter.on('event', function secondListener(arg1, arg2) { * console.log(`event with parameters ${arg1}, ${arg2} in second listener`); * }); * // Third listener * myEmitter.on('event', function thirdListener(...args) { * const parameters = args.join(', '); * console.log(`event with parameters ${parameters} in third listener`); * }); * * console.log(myEmitter.listeners('event')); * * myEmitter.emit('event', 1, 2, 3, 4, 5); * * // Prints: * // [ * // [Function: firstListener], * // [Function: secondListener], * // [Function: thirdListener] * // ] * // Helloooo! first listener * // event with parameters 1, 2 in second listener * // event with parameters 1, 2, 3, 4, 5 in third listener * ``` * @since v0.1.26 */ emit(eventName: string | symbol, ...args: any[]): boolean; /** * Returns the number of listeners listening to the event named `eventName`. * @since v3.2.0 * @param eventName The name of the event being listened for */ listenerCount(eventName: string | symbol): number; /** * Adds the `listener` function to the _beginning_ 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. * * ```js * server.prependListener('connection', (stream) => { * console.log('someone connected!'); * }); * ``` * * Returns a reference to the `EventEmitter`, so that calls can be chained. * @since v6.0.0 * @param eventName The name of the event. * @param listener The callback function */ prependListener( eventName: string | symbol, listener: (...args: any[]) => void, ): this; /** * Adds a **one-time**`listener` function for the event named `eventName` to the_beginning_ of the listeners array. The next time `eventName` is triggered, this * listener is removed, and then invoked. * * ```js * server.prependOnceListener('connection', (stream) => { * console.log('Ah, we have our first user!'); * }); * ``` * * Returns a reference to the `EventEmitter`, so that calls can be chained. * @since v6.0.0 * @param eventName The name of the event. * @param listener The callback function */ prependOnceListener( eventName: string | symbol, listener: (...args: any[]) => void, ): this; /** * Returns an array listing the events for which the emitter has registered * listeners. The values in the array are strings or `Symbol`s. * * ```js * const EventEmitter = require('events'); * const myEE = new EventEmitter(); * myEE.on('foo', () => {}); * myEE.on('bar', () => {}); * * const sym = Symbol('symbol'); * myEE.on(sym, () => {}); * * console.log(myEE.eventNames()); * // Prints: [ 'foo', 'bar', Symbol(symbol) ] * ``` * @since v6.0.0 */ eventNames(): Array<string | symbol>;
constructor(options?: EventEmitterOptions); /** * Creates a `Promise` that is fulfilled when the `EventEmitter` emits the given * event or that is rejected if the `EventEmitter` emits `'error'` while waiting. * The `Promise` will resolve with an array of all the arguments emitted to the * given event. * * This method is intentionally generic and works with the web platform [EventTarget](https://dom.spec.whatwg.org/#interface-eventtarget) interface, which has no special`'error'` event * semantics and does not listen to the `'error'` event. * * ```js * const { once, EventEmitter } = require('events'); * * async function run() { * const ee = new EventEmitter(); * * process.nextTick(() => { * ee.emit('myevent', 42); * }); * * const [value] = await once(ee, 'myevent'); * console.log(value); * * const err = new Error('kaboom'); * process.nextTick(() => { * ee.emit('error', err); * }); * * try { * await once(ee, 'myevent'); * } catch (err) { * console.log('error happened', err); * } * } * * run(); * ``` * * The special handling of the `'error'` event is only used when `events.once()`is used to wait for another event. If `events.once()` is used to wait for the * '`error'` event itself, then it is treated as any other kind of event without * special handling: * * ```js * const { EventEmitter, once } = require('events'); * * const ee = new EventEmitter(); * * once(ee, 'error') * .then(([err]) => console.log('ok', err.message)) * .catch((err) => console.log('error', err.message)); * * ee.emit('error', new Error('boom')); * * // Prints: ok boom * ``` * * An `AbortSignal` can be used to cancel waiting for the event: * * ```js * const { EventEmitter, once } = require('events'); * * const ee = new EventEmitter(); * const ac = new AbortController(); * * async function foo(emitter, event, signal) { * try { * await once(emitter, event, { signal }); * console.log('event emitted!'); * } catch (error) { * if (error.name === 'AbortError') { * console.error('Waiting for the event was canceled!'); * } else { * console.error('There was an error', error.message); * } * } * } * * foo(ee, 'foo', ac.signal); * ac.abort(); // Abort waiting for the event * ee.emit('foo'); // Prints: Waiting for the event was canceled! * ``` * @since v11.13.0, v10.16.0 */ static once( emitter: NodeEventTarget, eventName: string | symbol, options?: StaticEventEmitterOptions, ): Promise<any[]>; static once( emitter: EventTarget, eventName: string, options?: StaticEventEmitterOptions, ): Promise<any[]>; /** * ```js * const { on, EventEmitter } = require('events'); * * (async () => { * const ee = new EventEmitter(); * * // Emit later on * process.nextTick(() => { * ee.emit('foo', 'bar'); * ee.emit('foo', 42); * }); * * for await (const event of on(ee, 'foo')) { * // The execution of this inner block is synchronous and it * // processes one event at a time (even with await). Do not use * // if concurrent execution is required. * console.log(event); // prints ['bar'] [42] * } * // Unreachable here * })(); * ``` * * Returns an `AsyncIterator` that iterates `eventName` events. It will throw * if the `EventEmitter` emits `'error'`. It removes all listeners when * exiting the loop. The `value` returned by each iteration is an array * composed of the emitted event arguments. * * An `AbortSignal` can be used to cancel waiting on events: * * ```js * const { on, EventEmitter } = require('events'); * const ac = new AbortController(); * * (async () => { * const ee = new EventEmitter(); * * // Emit later on * process.nextTick(() => { * ee.emit('foo', 'bar'); * ee.emit('foo', 42); * }); * * for await (const event of on(ee, 'foo', { signal: ac.signal })) { * // The execution of this inner block is synchronous and it * // processes one event at a time (even with await). Do not use * // if concurrent execution is required. * console.log(event); // prints ['bar'] [42] * } * // Unreachable here * })(); * * process.nextTick(() => ac.abort()); * ``` * @since v13.6.0, v12.16.0 * @param eventName The name of the event being listened for * @return that iterates `eventName` events emitted by the `emitter` */ static on: typeof on; /** * A class method that returns the number of listeners for the given `eventName`registered on the given `emitter`. * * ```js * const { EventEmitter, listenerCount } = require('events'); * const myEmitter = new EventEmitter(); * myEmitter.on('event', () => {}); * myEmitter.on('event', () => {}); * console.log(listenerCount(myEmitter, 'event')); * // Prints: 2 * ``` * @since v0.9.12 * @deprecated Since v3.2.0 - Use `listenerCount` instead. * @param emitter The emitter to query * @param eventName The event name */ static listenerCount( emitter: EventEmitter, eventName: string | symbol, ): number;
/** * Returns a copy of the array of listeners for the event named `eventName`. * * For `EventEmitter`s this behaves exactly the same as calling `.listeners` on * the emitter. * * For `EventTarget`s this is the only way to get the event listeners for the * event target. This is useful for debugging and diagnostic purposes. * * ```js * const { getEventListeners, EventEmitter } = require('events'); * * { * const ee = new EventEmitter(); * const listener = () => console.log('Events are fun'); * ee.on('foo', listener); * getEventListeners(ee, 'foo'); // [listener] * } * { * const et = new EventTarget(); * const listener = () => console.log('Events are fun'); * et.addEventListener('foo', listener); * getEventListeners(et, 'foo'); // [listener] * } * ``` * @since v15.2.0 */ static getEventListeners: typeof getEventListeners;
/** * 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. * * Installing a listener using this symbol does not change the behavior once an * `'error'` event is emitted, therefore the process will still crash if no * regular `'error'` listener is installed. */ static readonly errorMonitor: unique symbol; static readonly captureRejectionSymbol: unique symbol; /** * Sets or gets the default captureRejection value for all emitters. */ // TODO: These should be described using static getter/setter pairs: static captureRejections: boolean; static defaultMaxListeners: number;}
export default EventEmitter;
std
Deno standard library
GitHub Repositorydenoland/deno_std
GitHub Stars
2447

Version Info

Tagged at
2 months ago