WritableStreamDefaultController

Baseline 已廣泛支援

此功能已成熟,並可在許多裝置和瀏覽器版本上使用。自 2022 年 5 月以來,它已在各個瀏覽器中可用。

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

Streams API 的 WritableStreamDefaultController 介面代表一個控制器,允許控制 WritableStream 的狀態。在構建 WritableStream 時,底層資料匯(sink)會獲得一個相應的 WritableStreamDefaultController 例項來進行操作。

建構函式

無。WritableStreamDefaultController 例項是在 WritableStream 構造過程中自動建立的。

例項屬性

WritableStreamDefaultController.signal 只讀

返回與該控制器關聯的 AbortSignal

例項方法

WritableStreamDefaultController.error()

導致與關聯流的任何未來互動都發生錯誤。

示例

js
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) {
    // …
  },
});

規範

規範
Streams
# ws-default-controller-class

瀏覽器相容性