From b8043998dbd7ec2f5416ae21027e875a89b52f9b Mon Sep 17 00:00:00 2001 From: Deokjin Kim Date: Thu, 19 Jan 2023 18:41:09 +0900 Subject: [PATCH] doc: fix mismatched arguments of `NodeEventTarget` Arguments of some APIs are mismatched and 2 APIs are not as described. PR-URL: https://github.com/nodejs/node/pull/45678 Reviewed-By: Benjamin Gruenbaum Reviewed-By: James M Snell --- doc/api/events.md | 51 +++++++++++++++++++++++++----------- lib/internal/event_target.js | 2 +- 2 files changed, 36 insertions(+), 17 deletions(-) diff --git a/doc/api/events.md b/doc/api/events.md index 6656b2b2dae3de..49f706f5573364 100644 --- 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 @@ -2318,7 +2317,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)` + +* `n` {number} + +Node.js-specific extension to the `EventTarget` class that sets the number +of max event listeners as `n`. + +#### `nodeEventTarget.getMaxListeners()` + + + +* Returns: {number} + +Node.js-specific extension to the `EventTarget` class that returns the number +of max event listeners. + +#### `nodeEventTarget.off(type, listener[, options])`