WritableStreamDefaultController

基线 2022

新可用

自 2022 年 6 月起，此功能可在最新的设备和浏览器版本中使用。此功能可能无法在较旧的设备或浏览器中使用。

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

WritableStreamDefaultController是流 API的一个接口，它表示一个控制器，允许控制WritableStream的状态。在构造 WritableStream 时，底层接收器会获得一个相应的 WritableStreamDefaultController 实例来进行操作。

构造函数

无。WritableStreamDefaultController 实例在 WritableStream 构造期间自动创建。

实例属性

WritableStreamDefaultController.signal 只读: 返回与控制器关联的AbortSignal。

实例方法

WritableStreamDefaultController.error(): 导致与相关流的任何未来交互都出错。

示例

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) {
    // ...
  },
});

规范

规范
流标准 # ws-default-controller-class

浏览器兼容性

BCD 表格仅在启用了 JavaScript 的浏览器中加载。