Skip to content

Commit 3e96ac3

Browse files
benjamingrbenjamingr
committed
doc: watermark string behavior
Documents that we calculate the highWaterMark value of streams operating on strings using the number of UTF-16 code units. Fixes: #52818
1 parent 54f1e0a commit 3e96ac3

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

‎doc/api/stream.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -317,7 +317,9 @@ buffer.
317317
The amount of data potentially buffered depends on the `highWaterMark` option
318318
passed into the stream's constructor. For normal streams, the `highWaterMark`
319319
option specifies a [total number of bytes][hwm-gotcha]. For streams operating
320-
in object mode, the `highWaterMark` specifies a total number of objects.
320+
in object mode, the `highWaterMark` specifies a total number of objects. For
321+
streams operating on (but not decoding) strings, the `highWaterMark` specifies
322+
a total number of UTF-16 code units.
321323

322324
Data is buffered in `Readable` streams when the implementation calls
323325
[`stream.push(chunk)`][stream-push]. If the consumer of the Stream does not

0 commit comments

Comments
 (0)