ReadableStreamDefaultController.close()

ReadableStreamDefaultController 接口的 close() 方法用于关闭关联的流。

reader 将仍然可以从流中读取任何先前入队的数据块,但是一旦读取这些数据块,流将被关闭。如果你想完全的丢弃这个流并且丢弃任何入队的数据块,你可以使用 ReadableStream.cancel() 或者 ReadableStreamDefaultReader.cancel()

语法

js

close()

参数

无。

返回值

无(undefined)。

异常

TypeError

如果源对象不是 ReadableStreamDefaultController 则抛出该异常。

示例

在下面的简单示例中,使用构造函数创建一个自定义的 ReadableStream(有关完整代码,参见我们的简单随机流展示)。start() 函数每秒生成一个随机字符串并且将他们送入流中。cancel() 函数用于在 ReadableStream.cancel() 被调用时停止随机字符串的生成。

当按下按钮时,将停止生成,使用 ReadableStreamDefaultController.close() 关闭流,并运行另一个函数以读取流中的数据。

js

const stream = new ReadableStream({
  start(controller) {
    interval = setInterval(() => {
      let string = randomChars();
      // 将随机字符串添加到流
      controller.enqueue(string);
      // 在屏幕上展示
      let listItem = document.createElement("li");
      listItem.textContent = string;
      list1.appendChild(listItem);
    }, 1000);
    button.addEventListener("click", function () {
      clearInterval(interval);
      fetchStream();
      controller.close();
    });
  },
  pull(controller) {
    // 在这个例子中不使用 pull
  },
  cancel() {
    // 如果取消了 reader,则会调用该函数,
    // 所以我们应该在这里停止生成字符串
    clearInterval(interval);
  },
});

规范

Specification
Streams Standard
# ref-for-rs-default-controller-close①

浏览器兼容性

BCD tables only load in the browser

参见