ReadableStreamBYOBReader

ReadableStreamBYOBReader()

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

ReadableStreamBYOBReader.closed Schreibgeschützt

Gibt ein Promise zurück, das erfüllt wird, wenn der Stream geschlossen wird, oder abgelehnt wird, wenn der Stream einen Fehler wirft oder die Sperre des Leser freigegeben wird. Diese Eigenschaft ermöglicht es Ihnen, Code zu schreiben, der auf ein 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 einem Verbraucher das Verlustinteresse am Stream. Das übergebene Argument reason wird der zugrunde liegenden Quelle übergeben, die es möglicherweise nutzt 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 oder mit dem Hinweis abgelehnt wird, dass der Stream geschlossen ist oder einen Fehler aufweist.

ReadableStreamBYOBReader.releaseLock()

Gibt die Sperre des Lesers auf den Stream frei.

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

Erstellen Sie zuerst den Leser mit ReadableStream.getReader() auf dem Stream und geben Sie mode: "byob" im Optionsparameter an. Da dies ein "Bring Your Own Buffer"-Leser ist, müssen wir auch ein ArrayBuffer erstellen, in das gelesen werden soll.

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

Nachfolgend ist eine Funktion aufgeführt, die den Leser verwendet. 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-Puffers ist, der noch nicht beschrieben wurde. Die Parameter der Ansicht werden aus den in vorherigen Aufrufen empfangenen Daten berechnet, die einen Versatz 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 es keine Daten mehr im Stream gibt, wird die read()-Methode mit einem Objekt gelöst, dessen Eigenschaft done auf true gesetzt ist, und die Funktion gibt zurück.

Die ReadableStreamBYOBReader.closed-Eigenschaft gibt ein Versprechen zurück, das verwendet werden kann, um zu überwachen, ob der Stream geschlossen oder ein Fehler aufgetreten ist oder die Lesersperre 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 dabei optional einen Grund an. Dies gibt ein Versprechen zurück, das gelöst 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 Verwenden von lesbaren Byte-Streams ruft die Abbrechen-Methode 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 Sperrung des Lesers auf dem Stream freizugeben, jedoch nur, wenn kein Lesevorgang aussteht:

reader.releaseLock();

• Streams API-Konzepte
• Verwenden eines lesbaren Byte-Streams
• ReadableStream
• Web-streams-polyfill oder sd-streams - Polyfills