pipeTo() method of the
ReadableStream interface pipes the current
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.
var promise = readableStream.pipeTo(destination[, options]);
WritableStreamthat acts as the final destination for the
- options Optional
- The options that should be used when piping to the
writablestream. Available 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.
signal: If set to an
AbortSignalobject, ongoing pipe operations can then be aborted via the corresponding
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.|
BCD tables only load in the browser