File tree 1 file changed +19
-0
lines changed
1 file changed +19
-0
lines changed Original file line number Diff line number Diff line change @@ -1657,12 +1657,31 @@ console.log(listenerCount(myEmitter, 'event'));
1657
1657
added:
1658
1658
- v13.6.0
1659
1659
- v12.16.0
1660
+ changes:
1661
+ - version: REPLACEME
1662
+ pr-url: https://github.com/nodejs/node/pull/52080
1663
+ description: Support `highWaterMark` and `lowWaterMark` options,
1664
+ For consistency. Old options are still supported.
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.
1660
1670
-->
1661
1671
1662
1672
* ` emitter ` {EventEmitter}
1663
1673
* ` eventName ` {string|symbol} The name of the event being listened for
1664
1674
* ` options ` {Object}
1665
1675
* ` signal ` {AbortSignal} Can be used to cancel awaiting events.
1676
+ * ` close ` - {string\[ ] } Names of events that will end the iteration.
1677
+ * ` highWaterMark ` - {integer} ** Default:** ` Number.MAX_SAFE_INTEGER `
1678
+ The high watermark. The emitter is paused every time the size of events
1679
+ being 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 the size of events
1683
+ being buffered is lower than it. Supported only on emitters implementing
1684
+ ` pause() ` and ` resume() ` methods.
1666
1685
* Returns: {AsyncIterator} that iterates ` eventName ` events emitted by the ` emitter `
1667
1686
1668
1687
``` mjs
You can’t perform that action at this time.
0 commit comments