diff options
| author | Matteo Collina <hello@matteocollina.com> | 2019-01-11 12:53:37 +0100 |
|---|---|---|
| committer | Matteo Collina <hello@matteocollina.com> | 2019-01-15 09:44:45 +0530 |
| commit | 2f1ae9eebb65db3ae2bffd9e5dde6ff0a8b66219 (patch) | |
| tree | dcb17fcd86f1996ab58ac8223d03354410599601 /doc/api | |
| parent | 66f45e7e5b7ef661678eb48bb630bb99acc7618b (diff) | |
| download | android-node-v8-2f1ae9eebb65db3ae2bffd9e5dde6ff0a8b66219.tar.gz android-node-v8-2f1ae9eebb65db3ae2bffd9e5dde6ff0a8b66219.tar.bz2 android-node-v8-2f1ae9eebb65db3ae2bffd9e5dde6ff0a8b66219.zip | |
doc: revert incorrect change on readable._read
https://github.com/nodejs/node/pull/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: https://github.com/nodejs/node/pull/17979
Fixes: https://github.com/nodejs/node/issues/24919
PR-URL: https://github.com/nodejs/node/pull/25442
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Yuta Hiroto <hello@hiroppy.me>
Diffstat (limited to 'doc/api')
| -rw-r--r-- | doc/api/stream.md | 8 |
1 files changed, 1 insertions, 7 deletions
diff --git a/doc/api/stream.md b/doc/api/stream.md index 6518b45e8b..c35c799129 100644 --- a/doc/api/stream.md +++ b/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 |