Skip to content
Permalink
Browse files

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>
  • Loading branch information...
mcollina authored and addaleax committed Jan 11, 2019
1 parent 2172dbf commit edab2d61fd6ae23fcc3328491f251b967d807cb4
Showing with 1 addition and 7 deletions.
  1. +1 −7 doc/api/stream.md
@@ -1858,10 +1858,6 @@ const myReadable = new Readable({
#### readable.\_read(size)
<!-- YAML
added: v0.9.4
changes:
- version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/17979
description: Call `_read()` only once per microtick.
-->

* `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
additional data onto the queue.

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

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

0 comments on commit edab2d6

Please sign in to comment.
You can’t perform that action at this time.