doc: fix mismatched arguments of NodeEventTarget

Arguments of some APIs are mismatched and 2 APIs are not as described. PR-URL: #45678 Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: James M Snell <[email protected]>
nodejs · Jan 26, 2023 · 2537d33 · 2537d33
1 parent f217492
commit 2537d33
Show file tree

Hide file tree

Showing 2 changed files with 36 additions and 17 deletions.
diff --git a/doc/api/events.md b/doc/api/events.md
@@ -1911,9 +1911,8 @@ and cannot be used in place of an `EventEmitter` in most cases.
    ignored.
 2. The `NodeEventTarget` does not emulate the full `EventEmitter` API.
    Specifically the `prependListener()`, `prependOnceListener()`,
-   `rawListeners()`, `setMaxListeners()`, `getMaxListeners()`, and
-   `errorMonitor` APIs are not emulated. The `'newListener'` and
-   `'removeListener'` events will also not be emitted.
+   `rawListeners()`, and `errorMonitor` APIs are not emulated.
+   The `'newListener'` and `'removeListener'` events will also not be emitted.
 3. The `NodeEventTarget` does not implement any special default behavior
    for events with type `'error'`.
 4. The `NodeEventTarget` supports `EventListener` objects as well as
@@ -2298,7 +2297,7 @@ added: v14.5.0
 The `NodeEventTarget` is a Node.js-specific extension to `EventTarget`
 that emulates a subset of the `EventEmitter` API.
 
-#### `nodeEventTarget.addListener(type, listener[, options])`
+#### `nodeEventTarget.addListener(type, listener)`
 
 <!-- YAML
 added: v14.5.0
@@ -2308,9 +2307,6 @@ added: v14.5.0
 
 * `listener` {Function|EventListener}
 
-* `options` {Object}
-  * `once` {boolean}
-
 * Returns: {EventTarget} this
 
 Node.js-specific extension to the `EventTarget` class that emulates the
@@ -2342,7 +2338,29 @@ added: v14.5.0
 Node.js-specific extension to the `EventTarget` class that returns the number
 of event listeners registered for the `type`.
 
-#### `nodeEventTarget.off(type, listener)`
+#### `nodeEventTarget.setMaxListeners(n)`
+
+<!-- YAML
+added: v14.5.0
+-->
+
+* `n` {number}
+
+Node.js-specific extension to the `EventTarget` class that sets the number
+of max event listeners as `n`.
+
+#### `nodeEventTarget.getMaxListeners()`
+
+<!-- YAML
+added: v14.5.0
+-->
+
+* Returns: {number}
+
+Node.js-specific extension to the `EventTarget` class that returns the number
+of max event listeners.
+
+#### `nodeEventTarget.off(type, listener[, options])`
 
 <!-- YAML
 added: v14.5.0
@@ -2352,11 +2370,14 @@ added: v14.5.0
 
 * `listener` {Function|EventListener}
 
+* `options` {Object}
+  * `capture` {boolean}
+
 * Returns: {EventTarget} this
 
 Node.js-specific alias for `eventTarget.removeListener()`.
 
-#### `nodeEventTarget.on(type, listener[, options])`
+#### `nodeEventTarget.on(type, listener)`
 
 <!-- YAML
 added: v14.5.0
@@ -2366,14 +2387,11 @@ added: v14.5.0
 
 * `listener` {Function|EventListener}
 
-* `options` {Object}
-  * `once` {boolean}
-
 * Returns: {EventTarget} this
 
 Node.js-specific alias for `eventTarget.addListener()`.
 
-#### `nodeEventTarget.once(type, listener[, options])`
+#### `nodeEventTarget.once(type, listener)`
 
 <!-- YAML
 added: v14.5.0
@@ -2383,8 +2401,6 @@ added: v14.5.0
 
 * `listener` {Function|EventListener}
 
-* `options` {Object}
-
 * Returns: {EventTarget} this
 
 Node.js-specific extension to the `EventTarget` class that adds a `once`
@@ -2405,7 +2421,7 @@ Node.js-specific extension to the `EventTarget` class. If `type` is specified,
 removes all registered listeners for `type`, otherwise removes all registered
 listeners.
 
-#### `nodeEventTarget.removeListener(type, listener)`
+#### `nodeEventTarget.removeListener(type, listener[, options])`
 
 <!-- YAML
 added: v14.5.0
@@ -2415,6 +2431,9 @@ added: v14.5.0
 
 * `listener` {Function|EventListener}
 
+* `options` {Object}
+  * `capture` {boolean}
+
 * Returns: {EventTarget} this
 
 Node.js-specific extension to the `EventTarget` class that removes the

diff --git a/lib/internal/event_target.js b/lib/internal/event_target.js
@@ -822,7 +822,7 @@ class NodeEventTarget extends EventTarget {
   }
 
   /**
-   * @param {string} [type]
+   * @param {string} type
    * @returns {number}
    */
   listenerCount(type) {