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 ist, oder abgelehnt wird, wenn der Stream einen Fehler wirft 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 an dem Stream durch einen Verbraucher. Das übergebene reason-Argument wird an die zugrunde liegende Quelle gegeben, die es möglicherweise verwendet oder nicht.

ReadableStreamBYOBReader.read()

Übermittelt 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 ablehnt, dass der Stream geschlossen oder fehlerhaft ist.

ReadableStreamBYOBReader.releaseLock()

Gibt die Sperre des Lesers auf den Stream frei.

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

Zuerst erstellen Sie den Leser mit ReadableStream.getReader() auf dem Stream, wobei mode: "byob" im Optionsparameter angegeben wird. Da es sich um einen "Bringen Sie Ihren eigenen Puffer mit"-Leser handelt, müssen wir auch einen ArrayBuffer erstellen, in den gelesen werden soll.

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 entgegen, das eine Ansicht über den Teil des ursprünglichen Array-Buffers ist, der noch nicht geschrieben wurde. Die Parameter der Ansicht werden anhand der Daten berechnet, die in vorherigen Aufrufen empfangen wurden, welche einen Offset in den ursprünglichen Array-Buffer 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 die read()-Methode sich mit einem Objekt auf, dessen Eigenschaft done auf true gesetzt ist, und die Funktion kehrt zurück.

Die ReadableStreamBYOBReader.closed-Eigenschaft gibt ein Promise zurück, das verwendet werden kann, um zu überwachen, ob der Stream geschlossen oder fehlerhaft ist, oder die Lesersperre freigegeben wurde.

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

Um den Stream zu stornieren, rufen Sie ReadableStreamBYOBReader.cancel() auf und geben optional einen reason an. Dies gibt ein Promise zurück, das sich auflöst, wenn der Stream storniert wurde. Wenn der Stream storniert wird, ruft der Controller wiederum cancel() an der zugrunde liegenden Quelle auf und übergibt den optionalen Grund.

Der Beispielcode in Verwendung lesbarer Byte-Streams ruft die Abbruchmethode auf, wenn eine Taste 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 Halte des Lesers auf dem Stream freizugeben, jedoch nur, wenn keine Leseoperation aussteht:

reader.releaseLock();

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