Commit f6964dc
doc: clarify when readable._read(...) is called
Fixes: #38586
PR-URL: #38726
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Robert Nagy <ronagy@icloud.com>1 parent 3481b02 commit f6964dc
1 file changed
Lines changed: 6 additions & 4 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -2564,10 +2564,12 @@ All `Readable` stream implementations must provide an implementation of the | |||
| 2564 | 2564 | ||
| 2565 | 2565 | When [`readable._read()`][] is called, if data is available from the resource, | |
| 2566 | 2566 | the implementation should begin pushing that data into the read queue using the | |
| 2567 | - [`this.push(dataChunk)`][stream-push] method. `_read()` should continue reading | ||
| 2568 | - from the resource and pushing data until `readable.push()` returns `false`. Only | ||
| 2569 | - when `_read()` is called again after it has stopped should it resume pushing | ||
| 2570 | - additional data onto the queue. | ||
| 2567 | + [`this.push(dataChunk)`][stream-push] method. `_read()` will be called again | ||
| 2568 | + after each call to [`this.push(dataChunk)`][stream-push] once the stream is | ||
| 2569 | + ready to accept more data. `_read()` may continue reading from the resource and | ||
| 2570 | + pushing data until `readable.push()` returns `false`. Only when `_read()` is | ||
| 2571 | + called again after it has stopped should it resume pushing additional data into | ||
| 2572 | + the queue. | ||
| 2571 | 2573 | ||
| 2572 | 2574 | Once the [`readable._read()`][] method has been called, it will not be called | |
| 2573 | 2575 | again until more data is pushed through the [`readable.push()`][stream-push] | |
0 commit comments