Commit e2484b2
doc: add comment about highWaterMark limit
Add a comment regarding memory limits and setting highWaterMark
PR-URL: #33432
Reviewd-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Robert Nagy <ronagy@icloud.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>1 parent 8d47e8b commit e2484b2
1 file changed
Lines changed: 5 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -93,6 +93,11 @@ A key goal of the `stream` API, particularly the [`stream.pipe()`][] method, | |||
| 93 | 93 | is to limit the buffering of data to acceptable levels such that sources and | |
| 94 | 94 | destinations of differing speeds will not overwhelm the available memory. | |
| 95 | 95 | ||
| 96 | + The `highWaterMark` option is a threshold, not a limit: it dictates the amount | ||
| 97 | + of data that a stream buffers before it stops asking for more data. It does not | ||
| 98 | + enforce a strict memory limitation in general. Specific stream implementations | ||
| 99 | + may choose to enforce stricter limits but doing so is optional. | ||
| 100 | + | ||
| 96 | 101 | Because [`Duplex`][] and [`Transform`][] streams are both `Readable` and | |
| 97 | 102 | `Writable`, each maintains *two* separate internal buffers used for reading and | |
| 98 | 103 | writing, allowing each side to operate independently of the other while | |
0 commit comments