Skip to content

Commit

Permalink
CR
Browse files Browse the repository at this point in the history
Co-authored-by: Moshe Atlow <moshe@atlow.co.il>
  • Loading branch information
atlowChemi and MoLow committed Mar 14, 2024
1 parent 3b693ac commit 8f85a99
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions doc/api/events.md
Original file line number Diff line number Diff line change
Expand Up @@ -1673,12 +1673,11 @@ changes:
* `eventName` {string|symbol} The name of the event being listened for
* `options` {Object}
* `signal` {AbortSignal} Can be used to cancel awaiting events.
* `close` - {string\[]} Can be used to set event names that will end
the iteration.
* `close` - {string\[]} Event names that will end the iteration.
* `highWatermark` - {integer} **Default:** `Number.MAX_SAFE_INTEGER`
Sets the `highWaterMark` used for the stream.
The low watermark. The emitter is resumed every time size is lower than it.
* `lowWatermark` - {integer} **Default:** `1`
Sets the `lowWaterMark` used for the stream.
The high watermark. The emitter is paused every time size is higher than it.
* Returns: {AsyncIterator} that iterates `eventName` events emitted by the `emitter`

```mjs
Expand Down

0 comments on commit 8f85a99

Please sign in to comment.