Browse Source

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: https://github.com/nodejs/node/issues/3208
PR-URL: https://github.com/nodejs/node/pull/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>
v6.x
Matteo Collina 8 years ago
committed by Myles Borins
parent
commit
d6ab8e2f43
No known key found for this signature in database GPG Key ID: 933B01F40B5CA946
  1. 4
      doc/api/stream.md

4
doc/api/stream.md

@ -1920,6 +1920,10 @@ The `transform._transform()` method is prefixed with an underscore because it
is internal to the class that defines it, and should never be called directly by
user programs.
`transform._transform()` is never called in parallel; streams implement a
queue mechanism, and to receive the next chunk, `callback` must be
called, either synchronously or asychronously.
#### Class: stream.PassThrough
The `stream.PassThrough` class is a trivial implementation of a [Transform][]

Loading…
Cancel
Save