@@ -189,6 +189,9 @@ myEmitter.emit('error', new Error('whoops!'));
189
189
```
190
190
191
191
## Class: EventEmitter
192
+ <!-- YAML
193
+ added: v0.1.26
194
+ -->
192
195
193
196
The ` EventEmitter ` class is defined and exposed by the ` events ` module:
194
197
@@ -200,6 +203,9 @@ All EventEmitters emit the event `'newListener'` when new listeners are
200
203
added and ` 'removeListener' ` when a listener is removed.
201
204
202
205
### Event: 'newListener'
206
+ <!-- YAML
207
+ added: v0.1.26
208
+ -->
203
209
204
210
* ` eventName ` {String|Symbol} The name of the event being listened for
205
211
* ` listener ` {Function} The event handler function
@@ -236,13 +242,20 @@ myEmitter.emit('event');
236
242
```
237
243
238
244
### Event: 'removeListener'
245
+ <!-- YAML
246
+ added: v0.9.3
247
+ -->
239
248
240
249
* ` eventName ` {String|Symbol} The event name
241
250
* ` listener ` {Function} The event handler function
242
251
243
252
The ` 'removeListener' ` event is emitted * after* a listener is removed.
244
253
245
254
### EventEmitter.listenerCount(emitter, eventName)
255
+ <!-- YAML
256
+ added: v0.9.12
257
+ deprecated: v4.0.0
258
+ -->
246
259
247
260
> Stability: 0 - Deprecated: Use [ ` emitter.listenerCount() ` ] [ ] instead.
248
261
@@ -258,6 +271,9 @@ console.log(EventEmitter.listenerCount(myEmitter, 'event'));
258
271
```
259
272
260
273
### EventEmitter.defaultMaxListeners
274
+ <!-- YAML
275
+ added: v0.11.2
276
+ -->
261
277
262
278
By default, a maximum of ` 10 ` listeners can be registered for any single
263
279
event. This limit can be changed for individual ` EventEmitter ` instances
@@ -285,10 +301,16 @@ emitter.once('event', () => {
285
301
```
286
302
287
303
### emitter.addListener(eventName, listener)
304
+ <!-- YAML
305
+ added: v0.1.26
306
+ -->
288
307
289
308
Alias for ` emitter.on(eventName, listener) ` .
290
309
291
310
### emitter.emit(eventName[ , arg1] [ , arg2 ] [ , ...] )
311
+ <!-- YAML
312
+ added: v0.1.26
313
+ -->
292
314
293
315
Synchronously calls each of the listeners registered for the event named
294
316
` eventName ` , in the order they were registered, passing the supplied arguments
@@ -297,18 +319,27 @@ to each.
297
319
Returns ` true ` if the event had listeners, ` false ` otherwise.
298
320
299
321
### emitter.getMaxListeners()
322
+ <!-- YAML
323
+ added: v1.0.0
324
+ -->
300
325
301
326
Returns the current max listener value for the ` EventEmitter ` which is either
302
327
set by [ ` emitter.setMaxListeners(n) ` ] [ ] or defaults to
303
328
[ ` EventEmitter.defaultMaxListeners ` ] [ ] .
304
329
305
330
### emitter.listenerCount(eventName)
331
+ <!-- YAML
332
+ added: v3.2.0
333
+ -->
306
334
307
335
* ` eventName ` {Value} The name of the event being listened for
308
336
309
337
Returns the number of listeners listening to the event named ` eventName ` .
310
338
311
339
### emitter.listeners(eventName)
340
+ <!-- YAML
341
+ added: v0.1.26
342
+ -->
312
343
313
344
Returns a copy of the array of listeners for the event named ` eventName ` .
314
345
@@ -321,6 +352,9 @@ console.log(util.inspect(server.listeners('connection')));
321
352
```
322
353
323
354
### emitter.on(eventName, listener)
355
+ <!-- YAML
356
+ added: v0.1.101
357
+ -->
324
358
325
359
Adds the ` listener ` function to the end of the listeners array for the
326
360
event named ` eventName ` . No checks are made to see if the ` listener ` has
@@ -337,6 +371,9 @@ server.on('connection', (stream) => {
337
371
Returns a reference to the ` EventEmitter ` so calls can be chained.
338
372
339
373
### emitter.once(eventName, listener)
374
+ <!-- YAML
375
+ added: v0.3.0
376
+ -->
340
377
341
378
Adds a ** one time** ` listener ` function for the event named ` eventName ` . The
342
379
next time ` eventName ` is triggered, this listener is removed and then invoked.
@@ -350,6 +387,9 @@ server.once('connection', (stream) => {
350
387
Returns a reference to the ` EventEmitter ` so calls can be chained.
351
388
352
389
### emitter.removeAllListeners([ eventName] )
390
+ <!-- YAML
391
+ added: v0.1.26
392
+ -->
353
393
354
394
Removes all listeners, or those of the specified ` eventName ` .
355
395
@@ -360,6 +400,9 @@ component or module (e.g. sockets or file streams).
360
400
Returns a reference to the ` EventEmitter ` so calls can be chained.
361
401
362
402
### emitter.removeListener(eventName, listener)
403
+ <!-- YAML
404
+ added: v0.1.26
405
+ -->
363
406
364
407
Removes the specified ` listener ` from the listener array for the event named
365
408
` eventName ` .
@@ -424,6 +467,9 @@ the `emitter.listeners()` method will need to be recreated.
424
467
Returns a reference to the ` EventEmitter ` so calls can be chained.
425
468
426
469
### emitter.setMaxListeners(n)
470
+ <!-- YAML
471
+ added: v0.3.5
472
+ -->
427
473
428
474
By default EventEmitters will print a warning if more than ` 10 ` listeners are
429
475
added for a particular event. This is a useful default that helps finding
0 commit comments