WritableStreamDefaultController

Baseline Widely available *

This feature is well established and works across many devices and browser versions. It’s been available across browsers since May 2022.

* Some parts of this feature may have varying levels of support.

Hinweis: Diese Funktion ist in Web Workers verfügbar.

Das WritableStreamDefaultController Interface der Streams API repräsentiert einen Controller, der es ermöglicht, den Zustand eines WritableStream zu steuern. Beim Erstellen eines WritableStream wird dem zugrunde liegenden Sink eine entsprechende WritableStreamDefaultController Instanz zur Manipulation gegeben.

Konstruktor

Keiner. WritableStreamDefaultController Instanzen werden automatisch während der WritableStream-Konstruktion erstellt.

Instanzeigenschaften

WritableStreamDefaultController.signal Schreibgeschützt

Gibt das AbortSignal zurück, das mit dem Controller verbunden ist.

Instanzmethoden

WritableStreamDefaultController.error()

Führt dazu, dass alle zukünftigen Interaktionen mit dem zugehörigen Stream einen Fehler verursachen.

Beispiele

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

Spezifikationen

Specification
Streams
# ws-default-controller-class

Browser-Kompatibilität