在此页

• 句法
• 范例
• 规范
• 浏览器兼容性
• 相关话题

这是 实验性技术
检查 浏览器兼容性表格 要小心谨慎在生产中使用这之前。

pipeTo() 方法在 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.

句法

var promise = readableStream.pipeTo(destination[, options]);
					

参数

destination

WritableStream that acts as the final destination for the ReadableStream .

选项 可选

The options that should be used when piping to the writable stream. Available options are:

1. preventClose : If this is set to true , the source ReadableStream closing will no longer cause the destination WritableStream 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.
2. preventAbort : If this is set to true , errors in the source ReadableStream will 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.
3. preventCancel : If this is set to true , errors in the destination WritableStream will 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.
4. signal : If set to an AbortSignal object, ongoing pipe operations can then be aborted via the corresponding AbortController .

返回值

A Promise that resolves when the piping process has completed.

异常

TypeError

writableStream and/or readableStream objects 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.	实时标准	初始定义。

浏览器兼容性

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.

更新 GitHub 上的兼容性数据

	桌面						移动
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
pipeTo	Chrome 59	Edge 79	Firefox No	IE No	Opera 46	Safari 10.1	WebView Android 59	Chrome Android 59	Firefox Android No	Opera Android 43	Safari iOS 10.3	Samsung Internet Android 7.0

图例

完整支持

完整支持

不支持

不支持

实验。期望将来行为有所改变。

实验。期望将来行为有所改变。

元数据

• 最后修改： Feb 12, 2020

相关话题

1. Streams API
2. ReadableStream
3. 构造函数

   1. ReadableStream()
4. 特性

   1. locked
5. 方法

   1. cancel()
   2. getReader()
   3. pipeThrough()
   4. pipeTo()
   5. tee()
6. Related pages for Streams

   1. Body.body
   2. ByteLengthQueuingStrategy
   3. CountQueuingStrategy
   4. ReadableByteStreamController
   5. ReadableStreamBYOBReader
   6. ReadableStreamBYOBRequest
   7. ReadableStreamDefaultController
   8. ReadableStreamDefaultReader
   9. WindowOrWorkerGlobalScope.fetch()
   10. WritableStream
   11. WritableStreamDefaultController
   12. WritableStreamDefaultWriter