ReadableStream: getReader() Methode

Syntax

getReader()
getReader(options)

Parameter

options Optional

Ein Objekt, das die folgenden Eigenschaften enthält:

mode Optional

Eine Eigenschaft, die den Typ des zu erstellenden Lesers angibt. Die Werte können sein:

• "byob", was dazu führt, dass ein ReadableStreamBYOBReader erstellt wird, der lesbare Bytestreams lesen kann (Streams, die null-Kopierübertragung von einer zugrunde liegenden Bytequelle zum Leser unterstützen, wenn die internen Stream-Puffer leer sind).
• undefined (oder überhaupt nicht angegeben — dies ist der Standard), was dazu führt, dass ein ReadableStreamDefaultReader erstellt wird, der einzelne Chunks von einem Stream lesen kann.

Rückgabewert

Ein Objektinstanz von ReadableStreamDefaultReader oder ReadableStreamBYOBReader, abhängig vom mode Wert.

Ausnahmen

RangeError

Wird ausgelöst, wenn der angegebene Moduswert nicht "byob" oder undefined ist.

TypeError

Wird ausgelöst, wenn der Stream, für den Sie einen Leser erstellen möchten, bereits gesperrt ist oder kein ReadableStream ist. Dies wird auch ausgelöst, wenn ein BYOB-Leser angefordert wird und der Stream-Controller kein ReadableByteStreamController ist (der Stream wurde nicht als zugrunde liegende Quelle mit type="bytes" konstruiert).

Beispiele

Im folgenden einfachen Beispiel wird ein zuvor erstellter benutzerdefinierter ReadableStream gelesen, indem ein ReadableStreamDefaultReader mit getReader() erstellt wird. (Siehe unser einfaches Zufalls-Stream-Beispiel für den vollständigen Code). Jedes Chunk wird nacheinander gelesen und in die Benutzeroberfläche ausgegeben, bis der Stream vollständig gelesen wurde, woraufhin wir aus der rekursiven Funktion zurückkehren und den gesamten Stream an einem anderen Teil der Benutzeroberfläche ausgeben.

function fetchStream() {
  const reader = stream.getReader();
  let charsReceived = 0;

  // read() returns a promise that resolves
  // when a value has been received
  reader.read().then(function processText({ done, value }) {
    // Result objects contain two properties:
    // done  - true if the stream has already given you all its data.
    // value - some data. Always undefined when done is true.
    if (done) {
      console.log("Stream complete");
      para.textContent = result;
      return;
    }

    // value for fetch streams is a Uint8Array
    charsReceived += value.length;
    const chunk = value;
    let listItem = document.createElement("li");
    listItem.textContent = `Received ${charsReceived} characters so far. Current chunk = ${chunk}`;
    list2.appendChild(listItem);

    result += chunk;

    // Read some more, and call this function again
    return reader.read().then(processText);
  });
}

Spezifikationen

Browser-Kompatibilität

Siehe auch

• ReadableStream() Konstruktor
• ReadableStreamDefaultReader
• ReadableStreamBYOBReader
• Verwendung von lesbaren Streams
• Verwendung von lesbaren Bytestreams