diff options
| author | Benjamin Gruenbaum <benjamingr@gmail.com> | 2020-05-16 16:35:45 +0300 |
|---|---|---|
| committer | Benjamin Gruenbaum <benjamingr@gmail.com> | 2020-05-16 16:35:45 +0300 |
| commit | ccbf70c641b79992b7b37660ad964e62fdae41f5 (patch) | |
| tree | 5049c2388ec0676154a1a58c9f2ab5d6829268c4 | |
| parent | 35ba340afa77855aeca98715aa69a7f6deb7c15f (diff) | |
| download | node-new-doc-update-watermark-comment.tar.gz | |
| -rw-r--r-- | doc/api/stream.md | 9 |
1 files changed, 4 insertions, 5 deletions
diff --git a/doc/api/stream.md b/doc/api/stream.md index 0de288caee..e666622e9b 100644 --- a/doc/api/stream.md +++ b/doc/api/stream.md @@ -93,11 +93,10 @@ A key goal of the `stream` API, particularly the [`stream.pipe()`][] method, is to limit the buffering of data to acceptable levels such that sources and destinations of differing speeds will not overwhelm the available memory. -Watermarks only determine the amount of data a stream buffers before it stops -asking for more data (via calling `readable._read()`). Watermarks do not -enforce a strict memory limitation in general. Specific stream -implementations may choose to enforce stricter limits but doing so is -optional. Specifically, `highWaterMark` is a threshold, not a limit. +The `highWaterMark` option is a threshold, not a limit: it dictates the amount +of data that a stream buffers before it stops asking for more data. It does not +enforce a strict memory limitation in general. Specific stream implementations +may choose to enforce stricter limits but doing so is optional. Because [`Duplex`][] and [`Transform`][] streams are both `Readable` and `Writable`, each maintains *two* separate internal buffers used for reading and |