WritableStream：abort() 方法

基线 2022

新可用

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

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

WritableStream 接口的abort() 方法中止流，表示生产者无法再成功写入流，并且需要立即将其移至错误状态，并丢弃任何排队的写入操作。

语法

js
abort(reason)

参数

reason

提供中止原因的人类可读字符串。

返回值

一个Promise，它使用reason参数中给定的值完成。

异常

TypeError

您尝试中止的流不是WritableStream，或者它已锁定。

示例

js
const writableStream = new WritableStream(
  {
    write(chunk) {
      // ...
    },
    close() {
      // ...
    },
    abort(err) {
      // ...
    },
  },
  queuingStrategy,
);

// ...

// abort the stream later on, when required
writableStream.abort();

规范

规范
流标准
# ref-for-ws-abort③

浏览器兼容性

BCD 表格仅在浏览器中加载