Commit edab2d6
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
1 file changed
Lines changed: 1 addition & 7 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1858,10 +1858,6 @@ const myReadable = new Readable({ | |||
| 1858 | 1858 | #### readable.\_read(size) | |
| 1859 | 1859 | <!-- YAML | |
| 1860 | 1860 | 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. | ||
| 1865 | 1861 | --> | |
| 1866 | 1862 | ||
| 1867 | 1863 | * `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 | |||
| 1881 | 1877 | additional data onto the queue. | |
| 1882 | 1878 | ||
| 1883 | 1879 | 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. | ||
| 1887 | 1881 | ||
| 1888 | 1882 | The `size` argument is advisory. For implementations where a "read" is a | |
| 1889 | 1883 | single operation that returns data can use the `size` argument to determine how | |
0 commit comments