WritableStreamDefaultWriter: WritableStreamDefaultWriter()-Konstruktor

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.

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

Der WritableStreamDefaultWriter()-Konstruktor erstellt eine neue Instanz des WritableStreamDefaultWriter-Objekts.

Hinweis: Im Allgemeinen würden Sie diesen Konstruktor nicht manuell verwenden; stattdessen würden Sie die WritableStream.getWriter()-Methode verwenden.

Syntax

js
new WritableStreamDefaultWriter(stream)

Parameter

stream

Der WritableStream, in den geschrieben werden soll.

Rückgabewert

Eine Instanz des WritableStreamDefaultWriter-Objekts.

Ausnahmen

TypeError

Der angegebene stream-Wert ist kein WritableStream oder ist bereits an einen anderen Writer gebunden.

Beispiele

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

js
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);
  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);

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

Spezifikationen

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

Browser-Kompatibilität