This page is not complete.
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.
Promise<void> readableStreamInstance.pipeTo(destination[, options]);
WritableStreamthat acts as the final destination for the
- 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 to
true, the source
ReadableStreamclosing will no longer cause the destination
WritableStreamto 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 source
ReadableStreamwill no longer abort the destination
WritableStream. 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 destination
WritableStreamwill no longer cancel the source
ReadableStream. 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.
Promise that resolves when the piping process has completed.
readableStreamobjects are not a writable stream/readable stream, or one or both of the streams are locked.
// 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 definition of 'pipeTo()' in that specification.
|Living Standard||Initial definition.|
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.
|Feature||Android webview||Chrome for Android||Edge mobile||Firefox for Android||Opera Android||iOS Safari||Samsung Internet|
1. From version 57: this feature is behind the
dom.streams.enabled preference (needs to be set to
true) and the
true). To change preferences in Firefox, visit about:config.