ReadableStream

构造函数

ReadableStream()

创建并从给定的Handler返回一个可读流对象。

属性

ReadableStream.locked 只读

locked返回这个可读流是否被一个读取器锁定。

方法

ReadableStream.cancel()

取消读取一束流, 消耗方发出一个信号，表示对这束流失去兴趣. 可以提供一个参数表示其原因给到底层代码, 使得不在应用这束流。

ReadableStream.getReader()

创建一个读取器并且锁定流到读取器上，其他的读取器不能再捕获它，直到它被释放。

ReadableStream.pipeThrough()

提供一个链式方法用于管道化一个现有的流，通过一个变换流或其他的可写可读对。

ReadableStream.pipeTo()

将现有的可读流管道输出给一个给定的可写流WritableStream，并在输出成功时保证填充，或在发生错误时返回拒绝。

ReadableStream.tee()

tee 方法（tee本意是将高尔夫球放置在球座上）tees 了可读流，返回包含两个ReadableStream实例分支的数组，每个元素接收了相同的传输数据。

使用例程

下面的例子，针对浏览器创建了一个智能的Response来流式化从别的资源处取得的HTML片段。

它演示了Uint8Array与可读流ReadableStream 的协同用法。

fetch("https://www.example.org/").then((response) => {
  const reader = response.body.getReader();
  const stream = new ReadableStream({
    start(controller) {
      // 下面的函数处理每个数据块
      function push() {
        // "done"是一个布尔型，"value"是一个Unit8Array
        reader.read().then(({ done, value }) => {
          // 判断是否还有可读的数据？
          if (done) {
            // 告诉浏览器已经结束数据发送。
            controller.close();
            return;
          }

          // 取得数据并将它通过controller发送给浏览器。
          controller.enqueue(value);
          push();
        });
      };
      
      push();
    }
  });

  return new Response(stream, { headers: { "Content-Type": "text/html" } });
});

规范

浏览器兼容性