Skip to content

Commit

Permalink
doc: change eventName type annotations
Browse files Browse the repository at this point in the history
Change type annotations for eventName in events API doc
from {any} to {string|symbol}.

PR-URL: #17666
Fixes: #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>
  • Loading branch information
aprilwebster authored and MylesBorins committed Jan 9, 2018
1 parent c24b4dd commit 712848b
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions doc/api/events.md
Expand Up @@ -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*
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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)`.
Expand All @@ -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
Expand Down Expand Up @@ -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`.

Expand All @@ -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`.

Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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`.

Expand All @@ -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
Expand Down Expand Up @@ -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`).
Expand Down

0 comments on commit 712848b

Please sign in to comment.