From a739871cf23af2754257b465320a2e3606aa34c4 Mon Sep 17 00:00:00 2001 From: Luigi Pinca Date: Thu, 21 Jul 2016 15:58:56 +0200 Subject: [PATCH] doc: add `added:` information for events PR-URL: https://github.com/nodejs/node/pull/7822 Reviewed-By: James M Snell Reviewed-By: Brian White --- doc/api/events.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) diff --git a/doc/api/events.md b/doc/api/events.md index f9b7d64e358b50..6f9efde1a51bf9 100644 --- a/doc/api/events.md +++ b/doc/api/events.md @@ -189,6 +189,9 @@ myEmitter.emit('error', new Error('whoops!')); ``` ## Class: EventEmitter + The `EventEmitter` class is defined and exposed by the `events` module: @@ -200,6 +203,9 @@ All EventEmitters emit the event `'newListener'` when new listeners are added and `'removeListener'` when a listener is removed. ### Event: 'newListener' + * `eventName` {String|Symbol} The name of the event being listened for * `listener` {Function} The event handler function @@ -236,6 +242,9 @@ myEmitter.emit('event'); ``` ### Event: 'removeListener' + * `eventName` {String|Symbol} The event name * `listener` {Function} The event handler function @@ -243,6 +252,10 @@ myEmitter.emit('event'); The `'removeListener'` event is emitted *after* a listener is removed. ### EventEmitter.listenerCount(emitter, eventName) + > Stability: 0 - Deprecated: Use [`emitter.listenerCount()`][] instead. @@ -258,6 +271,9 @@ console.log(EventEmitter.listenerCount(myEmitter, 'event')); ``` ### EventEmitter.defaultMaxListeners + By default, a maximum of `10` listeners can be registered for any single event. This limit can be changed for individual `EventEmitter` instances @@ -285,10 +301,16 @@ emitter.once('event', () => { ``` ### emitter.addListener(eventName, listener) + Alias for `emitter.on(eventName, listener)`. ### emitter.emit(eventName[, arg1][, arg2][, ...]) + Synchronously calls each of the listeners registered for the event named `eventName`, in the order they were registered, passing the supplied arguments @@ -297,18 +319,27 @@ to each. Returns `true` if the event had listeners, `false` otherwise. ### emitter.getMaxListeners() + 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) + * `eventName` {Value} The name of the event being listened for Returns the number of listeners listening to the event named `eventName`. ### emitter.listeners(eventName) + Returns a copy of the array of listeners for the event named `eventName`. @@ -321,6 +352,9 @@ console.log(util.inspect(server.listeners('connection'))); ``` ### emitter.on(eventName, listener) + 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 @@ -337,6 +371,9 @@ server.on('connection', (stream) => { Returns a reference to the `EventEmitter` so calls can be chained. ### emitter.once(eventName, listener) + Adds a **one time** `listener` function for the event named `eventName`. The next time `eventName` is triggered, this listener is removed and then invoked. @@ -350,6 +387,9 @@ server.once('connection', (stream) => { Returns a reference to the `EventEmitter` so calls can be chained. ### emitter.removeAllListeners([eventName]) + Removes all listeners, or those of the specified `eventName`. @@ -360,6 +400,9 @@ component or module (e.g. sockets or file streams). Returns a reference to the `EventEmitter` so calls can be chained. ### emitter.removeListener(eventName, listener) + Removes the specified `listener` from the listener array for the event named `eventName`. @@ -424,6 +467,9 @@ the `emitter.listeners()` method will need to be recreated. Returns a reference to the `EventEmitter` so calls can be chained. ### emitter.setMaxListeners(n) + 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