Skip to content

Commit 8f85a99

Browse files
atlowChemiMoLow
andauthored
CR
Co-authored-by: Moshe Atlow <[email protected]>
1 parent 3b693ac commit 8f85a99

File tree

1 file changed

+3
-4
lines changed

1 file changed

+3
-4
lines changed

doc/api/events.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1673,12 +1673,11 @@ changes:
16731673
* `eventName` {string|symbol} The name of the event being listened for
16741674
* `options` {Object}
16751675
* `signal` {AbortSignal} Can be used to cancel awaiting events.
1676-
* `close` - {string\[]} Can be used to set event names that will end
1677-
the iteration.
1676+
* `close` - {string\[]} Event names that will end the iteration.
16781677
* `highWatermark` - {integer} **Default:** `Number.MAX_SAFE_INTEGER`
1679-
Sets the `highWaterMark` used for the stream.
1678+
The low watermark. The emitter is resumed every time size is lower than it.
16801679
* `lowWatermark` - {integer} **Default:** `1`
1681-
Sets the `lowWaterMark` used for the stream.
1680+
The high watermark. The emitter is paused every time size is higher than it.
16821681
* Returns: {AsyncIterator} that iterates `eventName` events emitted by the `emitter`
16831682

16841683
```mjs

0 commit comments

Comments
 (0)