ReadableStream: pipeTo() method
Baseline
Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since May 2022.
Note: This feature is available in Web Workers.
The pipeTo() method of the ReadableStream interface pipes the current ReadableStream to a given WritableStream and returns a Promise that fulfills when the piping process completes successfully, or rejects if any errors were encountered.
Piping a stream will generally lock it for the duration of the pipe, preventing other readers from locking it.
Syntax
pipeTo(destination)
pipeTo(destination, options)
Parameters
destination-
A
WritableStreamthat acts as the final destination for theReadableStream. optionsOptional-
The options that should be used when piping to the
writablestream. Available options are:preventClose-
If this is set to
true, the sourceReadableStreamclosing will no longer cause the destinationWritableStreamto be closed. The method will return a fulfilled promise once this process completes, unless an error is encountered while closing the destination in which case it will be rejected with that error. preventAbort-
If this is set to
true, errors in the sourceReadableStreamwill no longer abort the destinationWritableStream. The method will return a promise rejected with the source's error, or with any error that occurs during aborting the destination. preventCancel-
If this is set to
true, errors in the destinationWritableStreamwill no longer cancel the sourceReadableStream. In this case the method will return a promise rejected with the source's error, or with any error that occurs during canceling the source. In addition, if the destination writable stream starts out closed or closing, the source readable stream will no longer be canceled. In this case the method will return a promise rejected with an error indicating piping to a closed stream failed, or with any error that occurs during canceling the source. signal-
If set to an
AbortSignalobject, ongoing pipe operations can then be aborted via the correspondingAbortController.
Return value
A Promise that resolves when the piping process has completed.
Exceptions
TypeError-
The
writableStreamand/orreadableStreamobjects are not a writable stream/readable stream, or one or both of the streams are locked.
Examples
// Fetch the original image
fetch("png-logo.png")
// Retrieve its body as ReadableStream
.then((response) => response.body)
.then((body) => body.pipeThrough(new PNGTransformStream()))
.then((rs) => rs.pipeTo(new FinalDestinationStream()));
The same example, but using await:
(async () => {
// Fetch the original image
const response = await fetch("png-logo.png");
// Retrieve its body as ReadableStream
await response.body
.pipeThrough(new PNGTransformStream())
.pipeTo(new FinalDestinationStream());
})();
Specifications
| Specification |
|---|
| Streams # ref-for-rs-pipe-to④ |
Browser compatibility
Loading…
See also
ReadableStream()constructor- Pipe chains