1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: change eventName type annotations

Browse Source 
Change type annotations for eventName in events API doc
from {any} to {string|symbol}.

PR-URL: https://github.com/nodejs/node/pull/17666
Fixes: https://github.com/nodejs/node/issues/17657
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Jon Moss <me@jonathanmoss.me>
Reviewed-By: Timothy Gu <timothygu99@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Evan Lucas <evanlucas@me.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
This commit is contained in:
April Webster 2017-12-13 14:40:12 -08:00 committed by Anatoli Papirovski
parent 1fa59b4c7e
commit b2432a7f00
No known key found for this signature in database
GPG Key ID: 614E2E1ABEB4B2C0
1 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
doc/api/events.md
View File

@ -175,7 +175,7 @@ added and `'removeListener'` when existing listeners are removed.
added: v0.1.26
-->
* `eventName` {any} The name of the event being listened for
* `eventName` {string|symbol} The name of the event being listened for
* `listener` {Function} The event handler function
The `EventEmitter` instance will emit its own `'newListener'` event *before*
@ -219,7 +219,7 @@ changes:
now yields the original listener function.
-->
* `eventName` {any} The event name
* `eventName` {string|symbol} The event name
* `listener` {Function} The event handler function
The `'removeListener'` event is emitted *after* the `listener` is removed.
@ -287,7 +287,7 @@ Its `name` property is set to `'MaxListenersExceededWarning'`.
<!-- YAML
added: v0.1.26
-->
- `eventName` {any}
- `eventName` {string|symbol}
- `listener` {Function}
Alias for `emitter.on(eventName, listener)`.
@ -296,7 +296,7 @@ Alias for `emitter.on(eventName, listener)`.
<!-- YAML
added: v0.1.26
-->
- `eventName` {any}
- `eventName` {string|symbol}
- `...args` {any}
Synchronously calls each of the listeners registered for the event named
@ -340,7 +340,7 @@ set by [`emitter.setMaxListeners(n)`][] or defaults to
added: v3.2.0
-->
* `eventName` {any} The name of the event being listened for
* `eventName` {string|symbol} The name of the event being listened for
Returns the number of listeners listening to the event named `eventName`.
@ -353,7 +353,7 @@ changes:
description: For listeners attached using `.once()` this returns the
original listeners instead of wrapper functions now.
-->
- `eventName` {any}
- `eventName` {string|symbol}
Returns a copy of the array of listeners for the event named `eventName`.
@ -370,7 +370,7 @@ console.log(util.inspect(server.listeners('connection')));
added: v0.1.101
-->
* `eventName` {any} The name of the event.
* `eventName` {string|symbol} The name of the event.
* `listener` {Function} The callback function
Adds the `listener` function to the end of the listeners array for the
@ -406,7 +406,7 @@ myEE.emit('foo');
added: v0.3.0
-->
* `eventName` {any} The name of the event.
* `eventName` {string|symbol} The name of the event.
* `listener` {Function} The callback function
Adds a **one-time** `listener` function for the event named `eventName`. The
@ -439,7 +439,7 @@ myEE.emit('foo');
added: v6.0.0
-->
* `eventName` {any} The name of the event.
* `eventName` {string|symbol} The name of the event.
* `listener` {Function} The callback function
Adds the `listener` function to the *beginning* of the listeners array for the
@ -461,7 +461,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
added: v6.0.0
-->
* `eventName` {any} The name of the event.
* `eventName` {string|symbol} The name of the event.
* `listener` {Function} The callback function
Adds a **one-time** `listener` function for the event named `eventName` to the
@ -480,7 +480,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
<!-- YAML
added: v0.1.26
-->
- `eventName` {any}
- `eventName` {string|symbol}
Removes all listeners, or those of the specified `eventName`.
@ -494,7 +494,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
<!-- YAML
added: v0.1.26
-->
- `eventName` {any}
- `eventName` {string|symbol}
- `listener` {Function}
Removes the specified `listener` from the listener array for the event named
@ -578,7 +578,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
<!-- YAML
added: REPLACEME
-->
- `eventName` {any}
- `eventName` {string|symbol}
Returns a copy of the array of listeners for the event named `eventName`,
including any wrappers (such as those created by `.once`).