Skip to content

Commit edab2d6

Browse 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 <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Yuta Hiroto <[email protected]>
1 parent 2172dbf commit edab2d6

File tree

1 file changed

+1
-7
lines changed

1 file changed

+1
-7
lines changed

doc/api/stream.md

+1-7
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)