WritableStream: getWriter()-Methode

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

Die getWriter()-Methode der WritableStream-Schnittstelle gibt eine neue Instanz von WritableStreamDefaultWriter zurück und sperrt den Stream für diese Instanz. Während der Stream gesperrt ist, kann kein anderer Writer erworben werden, bis dieser freigegeben wird.

Syntax

js
getWriter()

Parameter

Keine.

Rückgabewert

Eine WritableStreamDefaultWriter-Objektinstanz.

Ausnahmen

TypeError

Der Stream, für den Sie einen Writer erstellen möchten, ist kein WritableStream oder er ist bereits für einen anderen Writer gesperrt.

Beispiele

Das folgende Beispiel veranschaulicht mehrere Funktionen dieser Schnittstelle. Es zeigt die Erstellung des WritableStream mit einem benutzerdefinierten Senke und einer von der API bereitgestellten Warteschlangenstrategie. Dann wird eine Funktion namens sendMessage() aufgerufen, die den neu erstellten Stream und einen String übergibt. Innerhalb dieser Funktion wird die getWriter()-Methode 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() Versprechen zurück, die bearbeitet werden, um mit Erfolg oder Misserfolg von Chunks 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, { 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 einfachen Writer-Beispiel.

Spezifikationen

Specification
Streams Standard
# ref-for-ws-get-writer①

Browser-Kompatibilität

BCD tables only load in the browser