WritableStreamDefaultWriter: WritableStreamDefaultWriter() Konstruktor

Hinweis: Dieses Feature ist verfügbar in Web Workers.

Der WritableStreamDefaultWriter() Konstruktor erstellt eine neue WritableStreamDefaultWriter Objektinstanz.

Hinweis: In der Regel würden Sie diesen Konstruktor nicht manuell verwenden; stattdessen würden Sie die Methode WritableStream.getWriter() verwenden.

Syntax

new WritableStreamDefaultWriter(stream)

Parameter

stream: Der WritableStream, in den geschrieben werden soll.

Rückgabewert

Eine Instanz des WritableStreamDefaultWriter Objekts.

Ausnahmen

TypeError: Der bereitgestellte stream-Wert ist kein WritableStream, oder er ist bereits an einen anderen Writer gebunden.

Das folgende Beispiel zeigt die Erstellung eines WritableStream mit einem benutzerdefinierten Sink und einer API-bereitgestellten Warteschlangenstrategie. Es ruft dann eine Funktion namens sendMessage() auf und übergibt den neu erstellten Stream und einen String. Innerhalb dieser Funktion wird die Methode getWriter() des Streams aufgerufen, die eine Instanz von WritableStreamDefaultWriter zurückgibt. Ein forEach()-Aufruf wird verwendet, um jedes Chunk des Strings in den Stream zu schreiben. Schließlich geben write() und close() Promises zurück, die verarbeitet werden, um mit Erfolg oder Misserfolg von Chunks und Streams umzugehen.

const list = document.querySelector("ul");

function sendMessage(message, writableStream) {
  // defaultWriter is of type WritableStreamDefaultWriter
  const defaultWriter = writableStream.getWriter();
  const encoder = new TextEncoder();
  const encoded = encoder.encode(message, { stream: true });
  encoded.forEach((chunk) => {
    defaultWriter.ready
      .then(() => defaultWriter.write(chunk))
      .then(() => {
        console.log("Chunk written to sink.");
      })
      .catch((err) => {
        console.log("Chunk error:", err);
      });
  });
  // Call ready again to ensure that all chunks are written
  //   before closing the writer.
  defaultWriter.ready
    .then(() => {
      defaultWriter.close();
    })
    .then(() => {
      console.log("All chunks written");
    })
    .catch((err) => {
      console.log("Stream error:", err);
    });
}

const decoder = new TextDecoder("utf-8");
const queuingStrategy = new CountQueuingStrategy({ highWaterMark: 1 });
let result = "";
const writableStream = new WritableStream(
  {
    // Implement the sink
    write(chunk) {
      return new Promise((resolve, reject) => {
        const buffer = new ArrayBuffer(1);
        const view = new Uint8Array(buffer);
        view[0] = chunk;
        const decoded = decoder.decode(view, { stream: true });
        const listItem = document.createElement("li");
        listItem.textContent = `Chunk decoded: ${decoded}`;
        list.appendChild(listItem);
        result += decoded;
        resolve();
      });
    },
    close() {
      const listItem = document.createElement("li");
      listItem.textContent = `[MESSAGE RECEIVED] ${result}`;
      list.appendChild(listItem);
    },
    abort(err) {
      console.log("Sink error:", err);
    },
  },
  queuingStrategy,
);

sendMessage("Hello, world.", writableStream);

Den vollständigen Code finden Sie in unserem Einfaches Writer-Beispiel.

Spezifikationen

Specification
Streams Standard # ref-for-default-writer-constructor①

Browser-Kompatibilität

BCD tables only load in the browser