ReadableStreamBYOBReader

ReadableStreamBYOBReader()

Erstellt und gibt eine Instanz eines ReadableStreamBYOBReader-Objekts zurück.

ReadableStreamBYOBReader.closed Schreibgeschützt

Gibt ein Promise zurück, das erfüllt wird, wenn der Stream geschlossen wird, oder fehlschlägt, wenn der Stream einen Fehler ausgibt oder die Sperre des Lesers freigegeben wird. Diese Eigenschaft ermöglicht es Ihnen, Code zu schreiben, der auf das Ende des Streaming-Prozesses reagiert.

ReadableStreamBYOBReader.cancel()

Gibt ein Promise zurück, das aufgelöst wird, wenn der Stream abgebrochen wird. Das Aufrufen dieser Methode signalisiert einen Verlust des Interesses am Stream durch einen Verbraucher. Das angegebene reason-Argument wird der zugrunde liegenden Quelle übergeben, die es möglicherweise verwendet oder nicht.

ReadableStreamBYOBReader.read()

Überträgt eine Ansicht, in die Daten geschrieben werden müssen, und gibt ein Promise zurück, das sich mit dem nächsten Chunk im Stream auflöst oder mit einem Hinweis abgelehnt wird, dass der Stream geschlossen oder ein Fehler aufgetreten ist.

ReadableStreamBYOBReader.releaseLock()

Gibt die Sperre des Lesers auf den Stream frei.

Das folgende Beispiel stammt aus den Live-Beispielen in Verwendung von lesbaren Byte-Streams.

Zuerst erstellen Sie den Leser mit ReadableStream.getReader() auf dem Stream, wobei im Optionsparameter mode: "byob" angegeben wird. Da es sich hierbei um einen "Bring Your Own Buffer"-Leser handelt, müssen wir auch einen ArrayBuffer erstellen, in den gelesen wird.

const reader = stream.getReader({ mode: "byob" });
let buffer = new ArrayBuffer(200);

Eine Funktion, die den Leser verwendet, wird unten gezeigt. Diese ruft die read()-Methode rekursiv auf, um Daten in den Puffer zu lesen. Die Methode nimmt ein Uint8Array typisiertes Array, das eine Ansicht über den Teil des ursprünglichen Array-Puffers ist, der noch nicht geschrieben wurde. Die Parameter der Ansicht werden aus den Daten berechnet, die in vorherigen Aufrufen empfangen wurden und die einen Offset in den ursprünglichen Array-Puffer definieren.

readStream(reader);

function readStream(reader) {
  let bytesReceived = 0;
  let offset = 0;

  // read() returns a promise that resolves when a value has been received
  reader
    .read(new Uint8Array(buffer, offset, buffer.byteLength - offset))
    .then(function processText({ done, value }) {
      // Result objects contain two properties:
      // done  - true if the stream has already given all its data.
      // value - some data. Always undefined when done is true.

      if (done) {
        logConsumer(`readStream() complete. Total bytes: ${bytesReceived}`);
        return;
      }

      buffer = value.buffer;
      offset += value.byteLength;
      bytesReceived += value.byteLength;

      logConsumer(
        `Read ${value.byteLength} (${bytesReceived}) bytes: ${value}`,
      );
      result += value;

      // Read some more, and call this function again
      return reader
        .read(new Uint8Array(buffer, offset, buffer.byteLength - offset))
        .then(processText);
    });
}

Wenn keine Daten mehr im Stream vorhanden sind, löst sich die Methode read() mit einem Objekt auf, dessen Eigenschaft done auf true gesetzt ist, und die Funktion wird beendet.

Die Eigenschaft ReadableStreamBYOBReader.closed gibt ein Promise zurück, das verwendet werden kann, um zu überwachen, ob der Stream geschlossen oder ein Fehler aufgetreten ist, oder ob die Leser-Sperre freigegeben wird.

reader.closed
  .then(() => {
    // Resolved - code to handle stream closing
  })
  .catch(() => {
    // Rejected - code to handle error
  });

Um den Stream abzubrechen, rufen Sie ReadableStreamBYOBReader.cancel() auf und geben optional einen Grund an. Dies gibt ein Promise zurück, das erfüllt wird, wenn der Stream abgebrochen wurde. Wenn der Stream abgebrochen wird, ruft der Controller seinerseits cancel() auf der zugrunde liegenden Quelle auf und übergibt den optionalen Grund.

Der Beispielcode in Verwendung von lesbaren Byte-Streams ruft die Abbruchmethode auf, wenn eine Schaltfläche gedrückt wird, wie gezeigt:

button.addEventListener("click", () => {
  reader.cancel("user choice").then(() => console.log("cancel complete"));
});

Der Verbraucher kann auch releaseLock() aufrufen, um die Verbindungen des Lesers zum Stream zu lösen, jedoch nur, wenn kein Lesevorgang aussteht:

reader.releaseLock();

• Streams API Konzepte
• Verwendung lesbarer Byte-Streams
• ReadableStream
• WHATWG Stream Visualizer, für eine grundlegende Visualisierung von lesbaren, beschreibbaren und Transformationsstreams.
• Web-streams-polyfill oder sd-streams - Polyfills