Commit dd66c48
doc: add emit to NodeEventTarget
NodeEventTarget.emit() is not described in document. Plus, make
type parameter of removeAllListeners as optional.
Refs: #35851
PR-URL: #46356
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>1 parent e07c9b8 commit dd66c48
2 files changed
Lines changed: 17 additions & 3 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -2334,6 +2334,20 @@ equivalent `EventEmitter` API. The only difference between `addListener()` and | |||
| 2334 | 2334 | `addEventListener()` is that `addListener()` will return a reference to the | |
| 2335 | 2335 | `EventTarget`. | |
| 2336 | 2336 | ||
| 2337 | + #### `nodeEventTarget.emit(type, arg)` | ||
| 2338 | + | ||
| 2339 | + <!-- YAML | ||
| 2340 | + added: v15.2.0 | ||
| 2341 | + --> | ||
| 2342 | + | ||
| 2343 | + * `type` {string} | ||
| 2344 | + * `arg` {any} | ||
| 2345 | + * Returns: {boolean} `true` if event listeners registered for the `type` exist, | ||
| 2346 | + otherwise `false`. | ||
| 2347 | + | ||
| 2348 | + Node.js-specific extension to the `EventTarget` class that dispatches the | ||
| 2349 | + `arg` to the list of handlers for `type`. | ||
| 2350 | + | ||
| 2337 | 2351 | #### `nodeEventTarget.eventNames()` | |
| 2338 | 2352 | ||
| 2339 | 2353 | <!-- YAML | |
@@ -2395,7 +2409,7 @@ added: v14.5.0 | |||
| 2395 | 2409 | ||
| 2396 | 2410 | * Returns: {EventTarget} this | |
| 2397 | 2411 | ||
| 2398 | - Node.js-specific alias for `eventTarget.removeListener()`. | ||
| 2412 | + Node.js-specific alias for `eventTarget.removeEventListener()`. | ||
| 2399 | 2413 | ||
| 2400 | 2414 | #### `nodeEventTarget.on(type, listener)` | |
| 2401 | 2415 | ||
@@ -2409,7 +2423,7 @@ added: v14.5.0 | |||
| 2409 | 2423 | ||
| 2410 | 2424 | * Returns: {EventTarget} this | |
| 2411 | 2425 | ||
| 2412 | - Node.js-specific alias for `eventTarget.addListener()`. | ||
| 2426 | + Node.js-specific alias for `eventTarget.addEventListener()`. | ||
| 2413 | 2427 | ||
| 2414 | 2428 | #### `nodeEventTarget.once(type, listener)` | |
| 2415 | 2429 | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -937,7 +937,7 @@ class NodeEventTarget extends EventTarget { | |||
| 937 | 937 | } | |
| 938 | 938 | ||
| 939 | 939 | /** | |
| 940 | - * @param {string} type | ||
| 940 | + * @param {string} [type] | ||
| 941 | 941 | * @returns {NodeEventTarget} | |
| 942 | 942 | */ | |
| 943 | 943 | removeAllListeners(type) { | |
0 commit comments