GeezerVison is showing github.com — doc: watermark string behavior · nodejs/node@5d3ee72
File tree
Expand file treeCollapse file tree
Open diff view settings
Expand file treeCollapse file tree
Open diff view settings
Collapse file
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 number | Diff line number | Diff line change |
|---|
@@ -317,7 +317,9 @@ buffer. |
317 | 317 | The amount of data potentially buffered depends on the `highWaterMark` option |
318 | 318 | passed into the stream's constructor. For normal streams, the `highWaterMark` |
319 | 319 | 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. |
321 | 323 |
|
322 | 324 | Data is buffered in `Readable` streams when the implementation calls |
323 | 325 | [`stream.push(chunk)`][stream-push]. If the consumer of the Stream does not |
|