ReadableStreamBYOBReader

Konstruktor

ReadableStreamBYOBReader()

Erstellt und gibt eine ReadableStreamBYOBReader-Objektinstanz zurück.

Instanzeigenschaften

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 verursacht 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 aufgelöst wird, wenn der Stream abgebrochen wird. Ein Aufruf dieser Methode signalisiert einen Verlust des Interesses an dem Stream durch einen Verbraucher. Das übergebene reason-Argument wird der zugrunde liegenden Quelle übergeben, 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 mit dem nächsten Chunk im Stream aufgelöst wird oder mit einem Hinweis darauf fehlschlägt, dass der Stream geschlossen ist oder einen Fehler hat.

ReadableStreamBYOBReader.releaseLock()

Gibt die Sperre des Lesers auf dem Stream frei.

Beispiele

Das folgende Beispiel stammt aus den Live-Beispielen von Verwendung von lesbaren Bytestreams.

Erstellen Sie zunächst den Leser, indem Sie ReadableStream.getReader() auf dem Stream aufrufen und im Optionsparameter mode: "byob" angeben. Da dies ein "Bring Your Own Buffer"-Leser ist, 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, ist unten dargestellt. 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 von den in vorherigen Aufrufen empfangenen Daten berechnet, die einen Offset im 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, das die Eigenschaft done auf true gesetzt hat, und die Funktion gibt zurück.

Die Eigenschaft ReadableStreamBYOBReader.closed gibt ein Versprechen zurück, das verwendet werden kann, um zu überwachen, ob der Stream geschlossen ist, einen Fehler aufweist oder die Sperre des Lesers freigegeben wurde.

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 Versprechen zurück, das aufgelöst wird, wenn der Stream abgebrochen wurde. Wenn der Stream abgebrochen wird, ruft der Controller wiederum cancel() auf der zugrunde liegenden Quelle auf und übergibt den optionalen Grund.

Der Beispielcode in Verwendung von lesbaren Bytestreams ruft die Cancel-Methode auf, wenn ein Button 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 Sperre des Lesers auf dem Stream freizugeben, jedoch nur, wenn keine Leseoperation aussteht:

reader.releaseLock();

Spezifikationen

Browser-Kompatibilität

Siehe auch

• Konzepte der Streams-API
• Verwendung von lesbaren Bytestreams
• ReadableStream
• Web-streams-polyfill