This is an experimental technologyCheck 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
var promise = readableStream.pipeTo(destination[, options]);
Parameters
- destination
- A
WritableStream
that acts as the final destination for theReadableStream
. - options Optional
- The options that should be used when piping to the
writable
stream. Available options are:
preventClose
- If this is set to
true
, 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.signal
: If set to anAbortSignal
object, ongoing pipe operations can then be aborted via the correspondingAbortController
.
- If this is set to
Return value
A Promise
that resolves when the piping process has completed.
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 FinalDestinationStream()))
Specifications
Specification | Status | Comment |
StreamsThe definition of 'pipeTo()' in that specification. | Living Standard | Initial definition. |
Browser compatibility
The compatibility table on 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.
Update compatibility data on GitHub
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Chrome
Full support 59 |
Edge
Full support 79 |
Firefox
No support No |
IE
No support No |
Opera
Full support 46 |
Safari
Full support 10.1 |
WebView Android
Full support 59 |
Chrome Android
Full support 59 |
Firefox Android
No support No |
Opera Android
Full support 43 |
Safari iOS
Full support 10.3 |
Samsung Internet Android
Full support 7.0 |
Legend
- Full support
- Full support
- No support
- No support
- Experimental. Expect behavior to change in the future.'
- Experimental. Expect behavior to change in the future.
ReadableStream.pipeTo() by Mozilla Contributors is licensed under CC-BY-SA 2.5.