Draft
This page is not complete.
This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
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
readableStreamInstance.pipeTo(destination, options);
Parameters
- destination
- A
WritableStream
that acts as the final destination for theReadableStream
. - options Optional
- An options object containing properties that can define when cancellation, closing, or aborting of the stream is prevented (all optional). The options are:
preventClose
: If this is set totrue
, the sourceReadableStream
closing will no longer cause the destinationWritableStream
to 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 totrue
, errors in the sourceReadableStream
will 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 totrue
, errors in the destinationWritableStream
will 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.
Return value
Void.
Exceptions
- TypeError
- The
writableStream
and/orreadableStream
objects 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 FinalDestinationSteam()))
Specifications
Specification | Status | Comment |
---|---|---|
Streams The definition of 'pipeTo()' in that specification. |
Living Standard | Initial definition. |
Browser compatibility
The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
No compatibility data found. Please contribute data for "path.to.feature.NameOfTheProperty" (depth: 1) to the MDN compatibility data repository.