Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit 5d3ee72

Browse filesBrowse files
benjamingrtargos
benjamingr
authored and
targos
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 PR-URL: #52842 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Robert Nagy <ronagy@icloud.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
1 parent fbce317 commit 5d3ee72
Copy full SHA for 5d3ee72

File tree

Expand file treeCollapse file tree

1 file changed

+3
-1
lines changed
Open diff view settings
Filter options
Expand file treeCollapse file tree

1 file changed

+3
-1
lines changed
Open diff view settings
Collapse file

‎doc/api/stream.md‎

Copy file name to clipboardExpand all lines: doc/api/stream.md
+3-1Lines changed: 3 additions & 1 deletion
  • Display the source diff
  • Display the rich diff
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 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.