Skip to content

Commit dd66c48

Browse files
deokjinkimtargos
authored andcommitted
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

File tree

2 files changed

+17
-3
lines changed

2 files changed

+17
-3
lines changed

doc/api/events.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2334,6 +2334,20 @@ equivalent `EventEmitter` API. The only difference between `addListener()` and
23342334
`addEventListener()` is that `addListener()` will return a reference to the
23352335
`EventTarget`.
23362336

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+
23372351
#### `nodeEventTarget.eventNames()`
23382352

23392353
<!-- YAML
@@ -2395,7 +2409,7 @@ added: v14.5.0
23952409

23962410
* Returns: {EventTarget} this
23972411

2398-
Node.js-specific alias for `eventTarget.removeListener()`.
2412+
Node.js-specific alias for `eventTarget.removeEventListener()`.
23992413

24002414
#### `nodeEventTarget.on(type, listener)`
24012415

@@ -2409,7 +2423,7 @@ added: v14.5.0
24092423

24102424
* Returns: {EventTarget} this
24112425

2412-
Node.js-specific alias for `eventTarget.addListener()`.
2426+
Node.js-specific alias for `eventTarget.addEventListener()`.
24132427

24142428
#### `nodeEventTarget.once(type, listener)`
24152429

lib/internal/event_target.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -937,7 +937,7 @@ class NodeEventTarget extends EventTarget {
937937
}
938938

939939
/**
940-
* @param {string} type
940+
* @param {string} [type]
941941
* @returns {NodeEventTarget}
942942
*/
943943
removeAllListeners(type) {

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy