doc: add `added:` information for events

PR-URL: https://github.com/nodejs/node/pull/7822
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Brian White <mscdex@mscdex.net>

1 files changed, 55 insertions, 0 deletions

diff --git a/doc/api/events.md b/doc/api/events.md
index 32198fa519..eab0bef17e 100644
--- a/doc/api/events.md
+++ b/doc/api/events.md
@@ -167,6 +167,9 @@ myEmitter.emit('error', new Error('whoops!'));
 ```
 
 ## Class: EventEmitter
+<!-- YAML
+added: v0.1.26
+-->
 
 The `EventEmitter` class is defined and exposed by the `events` module:
 
@@ -178,6 +181,9 @@ All EventEmitters emit the event `'newListener'` when new listeners are
 added and `'removeListener'` when existing listeners are removed.
 
 ### Event: 'newListener'
+<!-- YAML
+added: v0.1.26
+-->
 
 * `eventName` {String|Symbol} The name of the event being listened for
 * `listener` {Function} The event handler function
@@ -214,6 +220,9 @@ myEmitter.emit('event');
 ```
 
 ### Event: 'removeListener'
+<!-- YAML
+added: v0.9.3
+-->
 
 * `eventName` {String|Symbol} The event name
 * `listener` {Function} The event handler function
@@ -221,6 +230,10 @@ myEmitter.emit('event');
 The `'removeListener'` event is emitted *after* the `listener` is removed.
 
 ### EventEmitter.listenerCount(emitter, eventName)
+<!-- YAML
+added: v0.9.12
+deprecated: v4.0.0
+-->
 
 > Stability: 0 - Deprecated: Use [`emitter.listenerCount()`][] instead.
 
@@ -236,6 +249,9 @@ console.log(EventEmitter.listenerCount(myEmitter, 'event'));
 ```
 
 ### EventEmitter.defaultMaxListeners
+<!-- YAML
+added: v0.11.2
+-->
 
 By default, a maximum of `10` listeners can be registered for any single
 event. This limit can be changed for individual `EventEmitter` instances
@@ -263,10 +279,16 @@ emitter.once('event', () => {
 ```
 
 ### emitter.addListener(eventName, listener)
+<!-- YAML
+added: v0.1.26
+-->
 
 Alias for `emitter.on(eventName, listener)`.
 
 ### emitter.emit(eventName[, arg1][, arg2][, ...])
+<!-- YAML
+added: v0.1.26
+-->
 
 Synchronously calls each of the listeners registered for the event named
 `eventName`, in the order they were registered, passing the supplied arguments
@@ -275,6 +297,9 @@ to each.
 Returns `true` if the event had listeners, `false` otherwise.
 
 ### emitter.eventNames()
+<!-- YAML
+added: v6.0.0
+-->
 
 Returns an array listing the events for which the emitter has registered
 listeners. The values in the array will be strings or Symbols.
@@ -293,18 +318,27 @@ console.log(myEE.eventNames());
 ```
 
 ### emitter.getMaxListeners()
+<!-- YAML
+added: v1.0.0
+-->
 
 Returns the current max listener value for the `EventEmitter` which is either
 set by [`emitter.setMaxListeners(n)`][] or defaults to
 [`EventEmitter.defaultMaxListeners`][].
 
 ### emitter.listenerCount(eventName)
+<!-- YAML
+added: v3.2.0
+-->
 
 * `eventName` {String|Symbol} The name of the event being listened for
 
 Returns the number of listeners listening to the event named `eventName`.
 
 ### emitter.listeners(eventName)
+<!-- YAML
+added: v0.1.26
+-->
 
 Returns a copy of the array of listeners for the event named `eventName`.
 
@@ -317,6 +351,9 @@ console.log(util.inspect(server.listeners('connection')));
 ```
 
 ### emitter.on(eventName, listener)
+<!-- YAML
+added: v0.1.101
+-->
 
 * `eventName` {String|Symbol} The name of the event.
 * `listener` {Function} The callback function
@@ -350,6 +387,9 @@ myEE.emit('foo');
 ```
 
 ### emitter.once(eventName, listener)
+<!-- YAML
+added: v0.3.0
+-->
 
 * `eventName` {String|Symbol} The name of the event.
 * `listener` {Function} The callback function
@@ -380,6 +420,9 @@ myEE.emit('foo');
 ```
 
 ### emitter.prependListener(eventName, listener)
+<!-- YAML
+added: v6.0.0
+-->
 
 * `eventName` {String|Symbol} The name of the event.
 * `listener` {Function} The callback function
@@ -399,6 +442,9 @@ server.prependListener('connection', (stream) => {
 Returns a reference to the `EventEmitter`, so that calls can be chained.
 
 ### emitter.prependOnceListener(eventName, listener)
+<!-- YAML
+added: v6.0.0
+-->
 
 * `eventName` {String|Symbol} The name of the event.
 * `listener` {Function} The callback function
@@ -416,6 +462,9 @@ server.prependOnceListener('connection', (stream) => {
 Returns a reference to the `EventEmitter`, so that calls can be chained.
 
 ### emitter.removeAllListeners([eventName])
+<!-- YAML
+added: v0.1.26
+-->
 
 Removes all listeners, or those of the specified `eventName`.
 
@@ -426,6 +475,9 @@ component or module (e.g. sockets or file streams).
 Returns a reference to the `EventEmitter`, so that calls can be chained.
 
 ### emitter.removeListener(eventName, listener)
+<!-- YAML
+added: v0.1.26
+-->
 
 Removes the specified `listener` from the listener array for the event named
 `eventName`.
@@ -490,6 +542,9 @@ the `emitter.listeners()` method will need to be recreated.
 Returns a reference to the `EventEmitter`, so that calls can be chained.
 
 ### emitter.setMaxListeners(n)
+<!-- YAML
+added: v0.3.5
+-->
 
 By default EventEmitters will print a warning if more than `10` listeners are
 added for a particular event. This is a useful default that helps finding