Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit edab2d6

Browse filesBrowse files
mcollinaaddaleax
authored andcommitted
doc: revert incorrect change on readable._read
#17979 introduced a change in the doc that was not correct about _read always being called asynchronously. This does not hold true when it is in flowing mode. See: #17979 Fixes: #24919 PR-URL: #25442 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Yuta Hiroto <hello@hiroppy.me>
1 parent 2172dbf commit edab2d6
Copy full SHA for edab2d6

File tree

Expand file treeCollapse file tree

1 file changed

+1
-7
lines changed
Open diff view settings
Filter options
Expand file treeCollapse file tree

1 file changed

+1
-7
lines changed
Open diff view settings
Collapse file

‎doc/api/stream.md‎

Copy file name to clipboardExpand all lines: doc/api/stream.md
+1-7Lines changed: 1 addition & 7 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -1858,10 +1858,6 @@ const myReadable = new Readable({
18581858
#### readable.\_read(size)
18591859
<!-- YAML
18601860
added: v0.9.4
1861-
changes:
1862-
- version: v10.0.0
1863-
pr-url: https://github.com/nodejs/node/pull/17979
1864-
description: Call `_read()` only once per microtick.
18651861
-->
18661862

18671863
* `size` {number} Number of bytes to read asynchronously
@@ -1881,9 +1877,7 @@ when `_read()` is called again after it has stopped should it resume pushing
18811877
additional data onto the queue.
18821878

18831879
Once the `readable._read()` method has been called, it will not be called again
1884-
until the [`readable.push()`][stream-push] method is called. `readable._read()`
1885-
is guaranteed to be called only once within a synchronous execution, i.e. a
1886-
microtick.
1880+
until the [`readable.push()`][stream-push] method is called.
18871881

18881882
The `size` argument is advisory. For implementations where a "read" is a
18891883
single operation that returns data can use the `size` argument to determine how

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.