WritableStream: abort() 方法

Baseline 已广泛支持

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

注意:此功能在 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();

规范

规范
Streams
# ref-for-ws-abort③

浏览器兼容性