Commit 45fccc9
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 0ddf73a commit 45fccc9
2 files changed
Lines changed: 17 additions & 3 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -2314,6 +2314,20 @@ equivalent `EventEmitter` API. The only difference between `addListener()` and | |||
| 2314 | 2314 | `addEventListener()` is that `addListener()` will return a reference to the | |
| 2315 | 2315 | `EventTarget`. | |
| 2316 | 2316 | ||
| 2317 | + #### `nodeEventTarget.emit(type, arg)` | ||
| 2318 | + | ||
| 2319 | + <!-- YAML | ||
| 2320 | + added: v15.2.0 | ||
| 2321 | + --> | ||
| 2322 | + | ||
| 2323 | + * `type` {string} | ||
| 2324 | + * `arg` {any} | ||
| 2325 | + * Returns: {boolean} `true` if event listeners registered for the `type` exist, | ||
| 2326 | + otherwise `false`. | ||
| 2327 | + | ||
| 2328 | + Node.js-specific extension to the `EventTarget` class that dispatches the | ||
| 2329 | + `arg` to the list of handlers for `type`. | ||
| 2330 | + | ||
| 2317 | 2331 | #### `nodeEventTarget.eventNames()` | |
| 2318 | 2332 | ||
| 2319 | 2333 | <!-- YAML | |
@@ -2375,7 +2389,7 @@ added: v14.5.0 | |||
| 2375 | 2389 | ||
| 2376 | 2390 | * Returns: {EventTarget} this | |
| 2377 | 2391 | ||
| 2378 | - Node.js-specific alias for `eventTarget.removeListener()`. | ||
| 2392 | + Node.js-specific alias for `eventTarget.removeEventListener()`. | ||
| 2379 | 2393 | ||
| 2380 | 2394 | #### `nodeEventTarget.on(type, listener)` | |
| 2381 | 2395 | ||
@@ -2389,7 +2403,7 @@ added: v14.5.0 | |||
| 2389 | 2403 | ||
| 2390 | 2404 | * Returns: {EventTarget} this | |
| 2391 | 2405 | ||
| 2392 | - Node.js-specific alias for `eventTarget.addListener()`. | ||
| 2406 | + Node.js-specific alias for `eventTarget.addEventListener()`. | ||
| 2393 | 2407 | ||
| 2394 | 2408 | #### `nodeEventTarget.once(type, listener)` | |
| 2395 | 2409 | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -916,7 +916,7 @@ class NodeEventTarget extends EventTarget { | |||
| 916 | 916 | } | |
| 917 | 917 | ||
| 918 | 918 | /** | |
| 919 | - * @param {string} type | ||
| 919 | + * @param {string} [type] | ||
| 920 | 920 | * @returns {NodeEventTarget} | |
| 921 | 921 | */ | |
| 922 | 922 | removeAllListeners(type) { | |
0 commit comments