Skip to content

Commit 2b844ed

Browse files
committed
doc: document missing options of events.on
Fixes: nodejs#52078 Refs: nodejs#41276
1 parent 98fe47a commit 2b844ed

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

doc/api/events.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1661,12 +1661,27 @@ console.log(listenerCount(myEmitter, 'event'));
16611661
added:
16621662
- v13.6.0
16631663
- v12.16.0
1664+
changes:
1665+
- version:
1666+
- v20.0.0
1667+
pr-url: https://github.com/nodejs/node/pull/41276
1668+
description: The `close`, `highWaterMark`, and `lowWaterMark`
1669+
options are supported now.
16641670
-->
16651671

16661672
* `emitter` {EventEmitter}
16671673
* `eventName` {string|symbol} The name of the event being listened for
16681674
* `options` {Object}
16691675
* `signal` {AbortSignal} Can be used to cancel awaiting events.
1676+
* `close` - {string\[]} Event names that will end the iteration.
1677+
* `highWaterMark` - {integer} **Default:** `Number.MAX_SAFE_INTEGER`
1678+
The high watermark. The emitter is paused every time size of events being
1679+
buffered is higher than it. Supported only on emitters implementing
1680+
`pause()` and `resume()` methods.
1681+
* `lowWaterMark` - {integer} **Default:** `1`
1682+
The low watermark. The emitter is resumed every time size of events being
1683+
buffered is lower than it. Supported only on emitters implementing
1684+
`pause()` and `resume()` methods.
16701685
* Returns: {AsyncIterator} that iterates `eventName` events emitted by the `emitter`
16711686

16721687
```mjs

0 commit comments

Comments
 (0)