Close the pipe.
The streams handlers will be unset and the read stream resumed unless it is already ended.
Set to true to call {@link WriteStream#end} when the source ReadStream completes, false otherwise.
Calling this overwrites {@link Pipe#endOnFailure} and {@link Pipe#endOnSuccess}.
Set to true to call {@link WriteStream#end} when the source ReadStream fails, false otherwise.
Set to true to call {@link WriteStream#end} when the source ReadStream succeeds, false otherwise.
Start to pipe the elements to the destination WriteStream.
When the operation fails with a write error, the source stream is resumed.
Start to pipe the elements to the destination WriteStream.
When the operation fails with a write error, the source stream is resumed.
Generated using TypeDoc
Pipe data from a ReadStream to a WriteStream and performs flow control where necessary to prevent the write stream buffer from getting overfull.
Instances of this class read items from a ReadStream and write them to a WriteStream. If data can be read faster than it can be written this could result in the write queue of the WriteStream growing without bound, eventually causing it to exhaust all available RAM.
To prevent this, after each write, instances of this class check whether the write queue of the WriteStream is full, and if so, the ReadStream is paused, and a
drainHandleris set on the WriteStream.When the WriteStream has processed half of its backlog, the
drainHandlerwill be called, which results in the pump resuming the ReadStream.This class can be used to pipe from any ReadStream to any WriteStream, e.g. from an HttpServerRequest to an AsyncFile, or from NetSocket to a WebSocket.
Please see the documentation for more information.