Commit 214dbac
doc: clarify undocumented stream properties
Fixes: #28592
Signed-off-by: James M Snell <jasnell@gmail.com>
PR-URL: #36715
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Robert Nagy <ronagy@icloud.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>1 parent 242ce19 commit 214dbac
1 file changed
Lines changed: 6 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -75,8 +75,7 @@ object mode is not safe. | |||
| 75 | 75 | <!--type=misc--> | |
| 76 | 76 | ||
| 77 | 77 | Both [`Writable`][] and [`Readable`][] streams will store data in an internal | |
| 78 | - buffer that can be retrieved using `writable.writableBuffer` or | ||
| 79 | - `readable.readableBuffer`, respectively. | ||
| 78 | + buffer. | ||
| 80 | 79 | ||
| 81 | 80 | The amount of data potentially buffered depends on the `highWaterMark` option | |
| 82 | 81 | passed into the stream's constructor. For normal streams, the `highWaterMark` | |
@@ -120,6 +119,11 @@ writing data *to* the socket. Because data may be written to the socket at a | |||
| 120 | 119 | faster or slower rate than data is received, each side should | |
| 121 | 120 | operate (and buffer) independently of the other. | |
| 122 | 121 | ||
| 122 | + The mechanics of the internal buffering are an internal implementation detail | ||
| 123 | + and may be changed at any time. However, for certain advanced implementations, | ||
| 124 | + the internal buffers can be retrieved using `writable.writableBuffer` or | ||
| 125 | + `readable.readableBuffer`. Use of these undocumented properties is discouraged. | ||
| 126 | + | ||
| 123 | 127 | ## API for stream consumers | |
| 124 | 128 | ||
| 125 | 129 | <!--type=misc--> | |
0 commit comments