Skip to content

Commit 578bf51

Browse files
lpincaMylesBorins
authored andcommitted
doc: add added: information for events
Ref: #8879 PR-URL: #7822 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Brian White <[email protected]>
1 parent 6ef58e7 commit 578bf51

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

doc/api/events.md

+46
Original file line numberDiff line numberDiff line change
@@ -189,6 +189,9 @@ myEmitter.emit('error', new Error('whoops!'));
189189
```
190190

191191
## Class: EventEmitter
192+
<!-- YAML
193+
added: v0.1.26
194+
-->
192195

193196
The `EventEmitter` class is defined and exposed by the `events` module:
194197

@@ -200,6 +203,9 @@ All EventEmitters emit the event `'newListener'` when new listeners are
200203
added and `'removeListener'` when a listener is removed.
201204

202205
### Event: 'newListener'
206+
<!-- YAML
207+
added: v0.1.26
208+
-->
203209

204210
* `eventName` {String|Symbol} The name of the event being listened for
205211
* `listener` {Function} The event handler function
@@ -236,13 +242,20 @@ myEmitter.emit('event');
236242
```
237243

238244
### Event: 'removeListener'
245+
<!-- YAML
246+
added: v0.9.3
247+
-->
239248

240249
* `eventName` {String|Symbol} The event name
241250
* `listener` {Function} The event handler function
242251

243252
The `'removeListener'` event is emitted *after* a listener is removed.
244253

245254
### EventEmitter.listenerCount(emitter, eventName)
255+
<!-- YAML
256+
added: v0.9.12
257+
deprecated: v4.0.0
258+
-->
246259

247260
> Stability: 0 - Deprecated: Use [`emitter.listenerCount()`][] instead.
248261
@@ -258,6 +271,9 @@ console.log(EventEmitter.listenerCount(myEmitter, 'event'));
258271
```
259272

260273
### EventEmitter.defaultMaxListeners
274+
<!-- YAML
275+
added: v0.11.2
276+
-->
261277

262278
By default, a maximum of `10` listeners can be registered for any single
263279
event. This limit can be changed for individual `EventEmitter` instances
@@ -285,10 +301,16 @@ emitter.once('event', () => {
285301
```
286302

287303
### emitter.addListener(eventName, listener)
304+
<!-- YAML
305+
added: v0.1.26
306+
-->
288307

289308
Alias for `emitter.on(eventName, listener)`.
290309

291310
### emitter.emit(eventName[, arg1][, arg2][, ...])
311+
<!-- YAML
312+
added: v0.1.26
313+
-->
292314

293315
Synchronously calls each of the listeners registered for the event named
294316
`eventName`, in the order they were registered, passing the supplied arguments
@@ -297,18 +319,27 @@ to each.
297319
Returns `true` if the event had listeners, `false` otherwise.
298320

299321
### emitter.getMaxListeners()
322+
<!-- YAML
323+
added: v1.0.0
324+
-->
300325

301326
Returns the current max listener value for the `EventEmitter` which is either
302327
set by [`emitter.setMaxListeners(n)`][] or defaults to
303328
[`EventEmitter.defaultMaxListeners`][].
304329

305330
### emitter.listenerCount(eventName)
331+
<!-- YAML
332+
added: v3.2.0
333+
-->
306334

307335
* `eventName` {Value} The name of the event being listened for
308336

309337
Returns the number of listeners listening to the event named `eventName`.
310338

311339
### emitter.listeners(eventName)
340+
<!-- YAML
341+
added: v0.1.26
342+
-->
312343

313344
Returns a copy of the array of listeners for the event named `eventName`.
314345

@@ -321,6 +352,9 @@ console.log(util.inspect(server.listeners('connection')));
321352
```
322353

323354
### emitter.on(eventName, listener)
355+
<!-- YAML
356+
added: v0.1.101
357+
-->
324358

325359
Adds the `listener` function to the end of the listeners array for the
326360
event named `eventName`. No checks are made to see if the `listener` has
@@ -337,6 +371,9 @@ server.on('connection', (stream) => {
337371
Returns a reference to the `EventEmitter` so calls can be chained.
338372

339373
### emitter.once(eventName, listener)
374+
<!-- YAML
375+
added: v0.3.0
376+
-->
340377

341378
Adds a **one time** `listener` function for the event named `eventName`. The
342379
next time `eventName` is triggered, this listener is removed and then invoked.
@@ -350,6 +387,9 @@ server.once('connection', (stream) => {
350387
Returns a reference to the `EventEmitter` so calls can be chained.
351388

352389
### emitter.removeAllListeners([eventName])
390+
<!-- YAML
391+
added: v0.1.26
392+
-->
353393

354394
Removes all listeners, or those of the specified `eventName`.
355395

@@ -360,6 +400,9 @@ component or module (e.g. sockets or file streams).
360400
Returns a reference to the `EventEmitter` so calls can be chained.
361401

362402
### emitter.removeListener(eventName, listener)
403+
<!-- YAML
404+
added: v0.1.26
405+
-->
363406

364407
Removes the specified `listener` from the listener array for the event named
365408
`eventName`.
@@ -424,6 +467,9 @@ the `emitter.listeners()` method will need to be recreated.
424467
Returns a reference to the `EventEmitter` so calls can be chained.
425468

426469
### emitter.setMaxListeners(n)
470+
<!-- YAML
471+
added: v0.3.5
472+
-->
427473

428474
By default EventEmitters will print a warning if more than `10` listeners are
429475
added for a particular event. This is a useful default that helps finding

0 commit comments

Comments
 (0)