GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — doc: clarify undocumented stream properties · nodejs/node@71b94e1

File tree

Expand file treeCollapse file tree
Open diff view settings
Filter options
  • doc/api
    • stream.md
Expand file treeCollapse file tree
Open diff view settings
Collapse file

‎doc/api/stream.md‎

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 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 (0)
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.