GeezerVison is showing github.com — doc: clarify undocumented stream properties · nodejs/node@71b94e1
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 +6-2Lines changed: 6 additions & 2 deletions - Display the source diff
- Display the rich diff
| Original file line number | Diff line number | Diff line change |
|---|
@@ -65,8 +65,7 @@ object mode is not safe. |
65 | 65 | <!--type=misc--> |
66 | 66 |
|
67 | 67 | 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. |
70 | 69 |
|
71 | 70 | The amount of data potentially buffered depends on the `highWaterMark` option |
72 | 71 | 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 |
110 | 109 | faster or slower rate than data is received, each side should |
111 | 110 | operate (and buffer) independently of the other. |
112 | 111 |
|
| 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 | + |
113 | 117 | ## API for stream consumers |
114 | 118 |
|
115 | 119 | <!--type=misc--> |
|