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③

瀏覽器相容性