ReadableStreamBYOBReader

Konstruktor

ReadableStreamBYOBReader()

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

Instanzeigenschaften

ReadableStreamBYOBReader.closed Schreibgeschützt

Gibt ein Promise zurück, das erfüllt wird, wenn der Stream geschlossen wird, oder verwirft, 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.

Instanzmethoden

ReadableStreamBYOBReader.cancel()

Gibt ein Promise zurück, das erfüllt wird, wenn der Stream abgebrochen wird. Durch Aufrufen dieser Methode wird das Interesse eines Verbrauchers am Stream signalisiert. Das übergebene reason-Argument wird der zugrunde liegenden Quelle gegeben, 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 mit dem nächsten Chunk im Stream aufgelöst wird oder mit einem Hinweis, dass der Stream geschlossen ist oder einen Fehler hat, abgelehnt wird.

ReadableStreamBYOBReader.releaseLock()

Gibt die Sperre des Lesers auf dem Stream frei.

Beispiele

Das folgende Beispiel stammt aus den Live-Beispielen in Lesbare Byte-Streams verwenden.

Zuerst erstellen Sie den Leser mit ReadableStream.getReader() am Strom, wobei im Optionsparameter mode: "byob" angegeben wird. Da dies ein "Bring Your Own Buffer"-Reader ist, müssen wir auch ein ArrayBuffer erstellen, in das 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 typed array, das eine Ansicht über den Teil des ursprünglichen Array-Buffers ist, der noch nicht beschrieben wurde. Die Parameter der Ansicht werden aus den in früheren Aufrufen empfangenen Daten berechnet, 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, wird die read()-Methode mit einem Objekt aufgelöst, dessen Eigenschaft done auf true gesetzt ist, und die Funktion gibt zurück.

Die ReadableStreamBYOBReader.closed-Eigenschaft gibt ein Promise zurück, das verwendet werden kann, um das Schließen des Streams, Fehler oder die Freigabe der Leser-Sperre zu überwachen.

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

Um den Stream zu kündigen, rufen Sie ReadableStreamBYOBReader.cancel() auf, wobei optional ein reason angegeben wird. Dies gibt ein Promise zurück, das erfüllt wird, wenn der Stream abgebrochen wurde. Wenn der Stream abgebrochen ist, ruft der Controller wiederum cancel() auf der zugrunde liegenden Quelle auf, wobei der optionale Grund übergeben wird.

Der Beispielcode in Lesbare Byte-Streams verwenden 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 den Griff des Lesers am Stream freizugeben, jedoch nur, wenn kein Lesevorgang aussteht:

reader.releaseLock();

Spezifikationen

Browser-Kompatibilität

Siehe auch

• Konzepte der Streams-API
• Verwenden eines lesbaren Byte-Streams
• ReadableStream
• Web-streams-polyfill