WritableStreamDefaultController

WritableStreamDefaultController はストリーム API のインターフェイスで、WritableStream の状態を制御できるコントローラーを表します。 WritableStream を構築する場合、基になるシンクには、操作のために対応する WritableStreamDefaultController インスタンスが与えられます。

コンストラクター

なし。 WritableStreamDefaultController インスタンスは、WritableStream の構築中に自動的に作成されます。

インスタンスプロパティ

WritableStreamDefaultController.signal 読取専用

このコントローラーに関連付けられた AbortSignal です。

インスタンスメソッド

WritableStreamDefaultController.error()

関連するストリームとの今後のやり取りでエラーが発生します。

例

js
const writableStream = new WritableStream({
  start(controller) {
    // コントローラーで何かをする

    // 必要に応じてストリームをエラーにする
    controller.error("My stream is broken");
  },
  write(chunk, controller) {
    // ...
  },
  close(controller) {
    // ...
  },
  abort(err) {
    // ...
  },
});

仕様書

Specification
Streams Standard
# ws-default-controller-class

ブラウザーの互換性

BCD tables only load in the browser