Commit 53ad91c
doc,stream: _transform happens one at a time
Add a note to the stream docs specifying that at most a single
call to _transform can happen, and the provided callback()
should be used to process another chunk.
Fixes: #3208
PR-URL: #14321
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>1 parent 72febfd commit 53ad91c
1 file changed
Lines changed: 4 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -2033,6 +2033,10 @@ The `transform._transform()` method is prefixed with an underscore because it | |||
| 2033 | 2033 | is internal to the class that defines it, and should never be called directly by | |
| 2034 | 2034 | user programs. | |
| 2035 | 2035 | ||
| 2036 | + `transform._transform()` is never called in parallel; streams implement a | ||
| 2037 | + queue mechanism, and to receive the next chunk, `callback` must be | ||
| 2038 | + called, either synchronously or asychronously. | ||
| 2039 | + | ||
| 2036 | 2040 | #### Class: stream.PassThrough | |
| 2037 | 2041 | ||
| 2038 | 2042 | The `stream.PassThrough` class is a trivial implementation of a [Transform][] | |
0 commit comments