Skip to content

Commit 71b94e1

Browse files
jasnelltargos
authored andcommitted
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 bcca52c commit 71b94e1

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

doc/api/stream.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -65,8 +65,7 @@ object mode is not safe.
6565
<!--type=misc-->
6666

6767
Both [`Writable`][] and [`Readable`][] streams will store data in an internal
68-
buffer that can be retrieved using `writable.writableBuffer` or
69-
`readable.readableBuffer`, respectively.
68+
buffer.
7069

7170
The amount of data potentially buffered depends on the `highWaterMark` option
7271
passed into the stream's constructor. For normal streams, the `highWaterMark`
@@ -110,6 +109,11 @@ writing data *to* the socket. Because data may be written to the socket at a
110109
faster or slower rate than data is received, each side should
111110
operate (and buffer) independently of the other.
112111

112+
The mechanics of the internal buffering are an internal implementation detail
113+
and may be changed at any time. However, for certain advanced implementations,
114+
the internal buffers can be retrieved using `writable.writableBuffer` or
115+
`readable.readableBuffer`. Use of these undocumented properties is discouraged.
116+
113117
## API for stream consumers
114118

115119
<!--type=misc-->

0 commit comments

Comments
 (0)