ReadableStream: pipeThrough() 方法

语法

pipeThrough(transformStream)
pipeThrough(transformStream, options)

参数

transformStream

一个 TransformStream（或具有 {writable, readable} 结构的对象），它由一个可读流和一个可写流组成，协同工作将数据从一种形式转换为另一种形式。写入 writable 流的数据可以通过 readable 流以某种转换后的状态读取。例如，TextDecoder 会接收字节并输出字符串，而视频解码器会接收编码后的字节并输出未压缩的视频帧。

options 可选

将流管道传输到 writable 流时应使用的选项。可用选项包括：

preventClose

如果设置为 true，则关闭源 ReadableStream 不会再导致目标 WritableStream 被关闭。

preventAbort

如果设置为 true，则源 ReadableStream 中的错误不会再中止目标 WritableStream。

preventCancel

如果设置为 true，则目标 WritableStream 中的错误不会再取消源 ReadableStream。

signal

如果设置为 AbortSignal 对象，则可以通过相应的 AbortController 来中止正在进行的管道传输操作。

返回值

transformStream 的 readable 端。

异常

TypeError

如果 transformStream 的 writable 和/或 readable 属性未定义，则会抛出此错误。

示例

在下面的示例中（完整的实时代码请参见 Unpack chunks of a PNG，源代码请参见 png-transform-stream），会获取一个图像，并将其主体检索为 ReadableStream。

接下来，我们将记录可读流的内容，使用 pipeThrough() 将其发送到一个创建流的灰度版本的新函数，然后也记录新流的内容。

// Fetch the original image
fetch("png-logo.png")
  // Retrieve its body as ReadableStream
  .then((response) => response.body)
  .then((rs) => logReadableStream("Fetch Response Stream", rs))
  // Create a gray-scaled PNG stream out of the original
  .then((body) => body.pipeThrough(new PNGTransformStream()))
  .then((rs) => logReadableStream("PNG Chunk Stream", rs));

规范

浏览器兼容性

另见

• ReadableStream() 构造函数
• 管道链