大网数据广告活动
Web 标准与前端开发

TransformStream()

· 52CE 我爱测

`TransformStream()`** 构造函数创建一个新的 TransformStream 对象,该对象表示一对流:一个 WritableStream 表示可写端,和一个 ReadableStream 表示可读端。

Streams

TransformStream() 构造函数创建一个新的 TransformStream 对象,该对象表示一对流:一个 WritableStream 表示可写端,和一个 ReadableStream 表示可读端。

语法

new TransformStream()
new TransformStream(transformer)
new TransformStream(transformer, writableStrategy)
new TransformStream(transformer, writableStrategy, readableStrategy)

参数

  • transformer

    • : 一个表示 transformer 的对象。如果未提供,则生成的流将是一个恒等变换流,它将所有写入可写端的分块转发到可读端,不会有任何改变。

      transformer 对象可以包含以下任何方法。每个方法的 controller 都是一个 TransformStreamDefaultController 实例。

      • start(controller)
        • : 当 TransformStream 被构造时调用。它通常用于使用 TransformStreamDefaultController.enqueue() 对分块进行排队。
      • transform(chunk, controller)
        • : 当一个写入可写端的分块准备好转换时调用,并且执行转换流的工作。如果没有提供 transform() 方法,则使用恒等变换,并且分块将在没有更改的情况下排队。
      • flush(controller)
        • : 当所有写入可写端的分块成功转换后被调用,并且可写端将会关闭。
  • writableStrategy

    • : 一个定义了队列策略的可选对象。它需要两个参数:
      • highWaterMark
        • : 一个非负整数。它定义了在应用背压之前内部队列包含的分块的总数。
      • size(chunk)
        • : 一个包含参数 chunk 的方法。它表示用于每一个块的大小,以字节为单位。
  • readableStrategy

    • : 一个定义了队列策略的可选对象。它需要两个参数:
      • highWaterMark
        • : 一个非负整数。它定义了在应用背压之前内部队列包含的分块的总数。
      • size(chunk)
        • : 一个包含参数 chunk 的方法。它表示用于每一个块的大小,以字节为单位。

[!NOTE] 你可以自定义 readableStrategy 或 writableStrategy,或者使用 ByteLengthQueuingStrategy 或 CountQueuingStrategy 的实例作为对象的值。

示例

将文本转换为大写

以下示例将文本逐块转换为大写。这个示例来自数据流——权威指南,它有关于不同类型流的一些示例。

function upperCaseStream() {
  return new TransformStream({
    transform(chunk, controller) {
      controller.enqueue(chunk.toUpperCase());
    },
  });
}

function appendToDOMStream(el) {
  return new WritableStream({
    write(chunk) {
      el.append(chunk);
    },
  });
}

fetch("./lorem-ipsum.txt").then((response) =>
  response.body
    .pipeThrough(new TextDecoderStream())
    .pipeThrough(upperCaseStream())
    .pipeTo(appendToDOMStream(document.body)),
);

创建一个恒等变换流

如果没有提供 transformer 参数,那么结果将是一个恒等流,它将所有写入可写端的分块转发到可读端,并且不做任何改变。在以下示例中,一个恒等转换流被用于向一个管道添加缓冲。

const writableStrategy = new ByteLengthQueuingStrategy({
  highWaterMark: 1024 * 1024,
});
readableStream
  .pipeThrough(new TransformStream(undefined, writableStrategy))
  .pipeTo(writableStream);

规范

浏览器兼容性

来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。

资料来源与适用范围

资料来源
MDN Web Docs / Mozilla 贡献者
适用范围
请按文中版本与环境说明核对
内容语言
中文;命令、路径和错误标识保留技术原文
本地收录日期
2026-11-15
授权说明
CC BY-SA 2.5

正文与所需资源由本站本地存储。查看来源及更新记录 ↗

请按适用版本和实际日志确认原因;本站没有对每一种系统或设备逐项执行文中的操作。