WritableStreamDefaultController

Baseline 2022

Newly available

Since June 2022, this feature works across the latest devices and browser versions. This feature might not work in older devices or browsers.

Stream API 中的 WritableStreamDefaultController 接口表示一个允许控制 WritableStream 状态的控制器。当构造 WritableStream 时，会为底层的接收器提供一个相应的 WritableStreamDefaultController 实例以进行操作。

构造函数

无。WritableStreamDefaultController 实例会在构造 WritableStream 时被自动创建。

实例属性

WritableStreamDefaultController.signal 只读: 返回与 controller 相关联的 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) {
    ...
  }
});

规范

Specification
Streams Standard # ws-default-controller-class

浏览器兼容性

BCD tables only load in the browser