WritableStreamDefaultController: error() 方法

基线 2022

新可用

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

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

error() 方法是 WritableStreamDefaultController 接口的方法，它会导致与相关流的任何后续交互出现错误。

此方法很少使用，因为通常情况下，从底层接收器的某个方法返回一个被拒绝的 Promise 就足够了。但是，它可以用于突然关闭流以响应底层接收器交互的正常生命周期之外的事件。

语法

js
error(message)

参数

message

表示您希望后续交互失败的错误的字符串。

返回值

无 (undefined).

异常

TypeError

您尝试出错的流不是 WritableStream。

示例

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

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

规范

规范
流标准
# ref-for-ws-default-controller-error①

浏览器兼容性

BCD 表格仅在浏览器中加载