From e692972014ad186ab2f0651d14aaea6e73c5c844 Mon Sep 17 00:00:00 2001 From: wangshun <96341168+xixi-box@users.noreply.github.com> Date: Sat, 7 Nov 2026 19:35:41 +0000 Subject: [PATCH] fix: doc: `readable.read()` still documents pre-v26 behaviour (returns a Signed-off-by: wangshun <96341168+xixi-box@users.noreply.github.com> --- doc/api/stream.md | 12 ++++++++++-- src/UNKNOWN.egg-info/PKG-INFO | 5 +++++ src/UNKNOWN.egg-info/SOURCES.txt | 7 +++++++ src/UNKNOWN.egg-info/dependency_links.txt | 1 + src/UNKNOWN.egg-info/top_level.txt | 11 +++++++++++ 5 files changed, 34 insertions(+), 2 deletions(-) create mode 100644 src/UNKNOWN.egg-info/PKG-INFO create mode 100644 src/UNKNOWN.egg-info/SOURCES.txt create mode 100644 src/UNKNOWN.egg-info/dependency_links.txt create mode 100644 src/UNKNOWN.egg-info/top_level.txt diff --git a/doc/api/stream.md b/doc/api/stream.md index 1e8a2bd1ef93..6601dfa2da2a 100644 --- a/doc/api/stream.md +++ b/doc/api/stream.md @@ -1557,6 +1557,11 @@ closed until the Node.js process exits, regardless of the specified options. * `size` {number} Optional argument to specify how much data to read. @@ -1573,8 +1578,11 @@ The optional `size` argument specifies a specific number of bytes to read. If the stream has ended, in which case all of the data remaining in the internal buffer will be returned. -If the `size` argument is not specified, all of the data contained in the -internal buffer will be returned. +If the `size` argument is not specified, `readable.read()` returns the next +buffered chunk. In object mode, this is the next object, as before. To read all +of the currently buffered data in a single call, use +`readable.read(readable.readableLength)`. In some edge cases it might be +necessary to call `readable.read(0)` first. The `size` argument must be less than or equal to 1 GiB. diff --git a/src/UNKNOWN.egg-info/PKG-INFO b/src/UNKNOWN.egg-info/PKG-INFO new file mode 100644 index 000000000000..837c47839dd6 --- /dev/null +++ b/src/UNKNOWN.egg-info/PKG-INFO @@ -0,0 +1,5 @@ +Metadata-Version: 2.4 +Name: UNKNOWN +Version: 0.0.0 +License-File: LICENSE +Dynamic: license-file diff --git a/src/UNKNOWN.egg-info/SOURCES.txt b/src/UNKNOWN.egg-info/SOURCES.txt new file mode 100644 index 000000000000..9be0f3913632 --- /dev/null +++ b/src/UNKNOWN.egg-info/SOURCES.txt @@ -0,0 +1,7 @@ +LICENSE +README.md +pyproject.toml +src/UNKNOWN.egg-info/PKG-INFO +src/UNKNOWN.egg-info/SOURCES.txt +src/UNKNOWN.egg-info/dependency_links.txt +src/UNKNOWN.egg-info/top_level.txt \ No newline at end of file diff --git a/src/UNKNOWN.egg-info/dependency_links.txt b/src/UNKNOWN.egg-info/dependency_links.txt new file mode 100644 index 000000000000..8b137891791f --- /dev/null +++ b/src/UNKNOWN.egg-info/dependency_links.txt @@ -0,0 +1 @@ + diff --git a/src/UNKNOWN.egg-info/top_level.txt b/src/UNKNOWN.egg-info/top_level.txt new file mode 100644 index 000000000000..a5ca1ad6b106 --- /dev/null +++ b/src/UNKNOWN.egg-info/top_level.txt @@ -0,0 +1,11 @@ +api +crypto +dataqueue +dtls +ffi +glob +inspector +permission +quic +res +tracing