ReadableStream: phương thức pipeTo()
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.
Phương thức pipeTo() của giao diện ReadableStream chuyển ReadableStream hiện tại tới WritableStream nhất định và trả về Promise đáp ứng khi quá trình đường ống hoàn tất thành công hoặc từ chối nếu gặp bất kỳ lỗi nào.
Việc truyền một luồng thường sẽ khóa trong suốt thời gian của luồng, ngăn không cho các trình đọc khác khóa luồng đó.
Cú pháp
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 sourceRea dableStreamclosing 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__ MDNPH27__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
AbortSigna lobject, 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());
})();
Thông số kỹ thuật
| Specification |
|---|
| Streams> # ref-for-rs-pipe-to④> |
Khả năng tương thích của trình duyệt
Xem thêm
-
hàm tạo
ReadableStream()