Skip to content

Commit 45fccc9

Browse files
deokjinkimdanielleadams
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 <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]>
1 parent 0ddf73a commit 45fccc9

File tree

2 files changed

+17
-3
lines changed

2 files changed

+17
-3
lines changed

doc/api/events.md

+16-2
Original file line numberDiff line numberDiff line change
@@ -2314,6 +2314,20 @@ equivalent `EventEmitter` API. The only difference between `addListener()` and
23142314
`addEventListener()` is that `addListener()` will return a reference to the
23152315
`EventTarget`.
23162316

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

23192333
<!-- YAML
@@ -2375,7 +2389,7 @@ added: v14.5.0
23752389

23762390
* Returns: {EventTarget} this
23772391

2378-
Node.js-specific alias for `eventTarget.removeListener()`.
2392+
Node.js-specific alias for `eventTarget.removeEventListener()`.
23792393

23802394
#### `nodeEventTarget.on(type, listener)`
23812395

@@ -2389,7 +2403,7 @@ added: v14.5.0
23892403

23902404
* Returns: {EventTarget} this
23912405

2392-
Node.js-specific alias for `eventTarget.addListener()`.
2406+
Node.js-specific alias for `eventTarget.addEventListener()`.
23932407

23942408
#### `nodeEventTarget.once(type, listener)`
23952409

lib/internal/event_target.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -916,7 +916,7 @@ class NodeEventTarget extends EventTarget {
916916
}
917917

918918
/**
919-
* @param {string} type
919+
* @param {string} [type]
920920
* @returns {NodeEventTarget}
921921
*/
922922
removeAllListeners(type) {

0 commit comments

Comments
 (0)