WritableStreamDefaultController

Baseline 已广泛支持

此功能已成熟,并可在许多设备和浏览器版本上使用。自 2022 年 5 月以来,它已在各个浏览器中可用。

注意:此功能在 Web Workers 中可用。

Streams API 的 WritableStreamDefaultController 接口代表一个控制器,允许控制 WritableStream 的状态。在构建 WritableStream 时,底层数据汇(sink)会获得一个相应的 WritableStreamDefaultController 实例来进行操作。

构造函数

无。WritableStreamDefaultController 实例是在 WritableStream 构造过程中自动创建的。

实例属性

WritableStreamDefaultController.signal 只读

返回与该控制器关联的 AbortSignal

实例方法

WritableStreamDefaultController.error()

导致与关联流的任何未来交互都发生错误。

示例

js
const writableStream = new WritableStream({
  start(controller) {
    // do stuff with controller

    // error stream if necessary
    controller.error("My stream is broken");
  },
  write(chunk, controller) {
    // …
  },
  close(controller) {
    // …
  },
  abort(err) {
    // …
  },
});

规范

规范
Streams
# ws-default-controller-class

浏览器兼容性