ReadableStream: getReader() メソッド

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since ⁨2019年1月⁩.

getReader() はReadableStream インターフェイスのメソッドで、リーダーを作成し、それでストリームをロックします。ストリームがロックされている間は、このリーダーが解放されるまで他のリーダーを取得できません。

構文

getReader()getReader(options)

引数

options省略可

以下のプロパティを持つオブジェクトです。

mode省略可

作成するリーダーの種類を指定するプロパティです。値は以下の通り。

"byob": 読み取り可能なバイトストリーム（内部ストリームバッファーが空のときに、基礎となるバイトソースからリーダーへのゼロコピー転送に対応しているストリーム）を読み取ることができるReadableStreamBYOBReader を作成します。
undefined （または指定しない場合、既定値）。これにより、ストリームから個々のチャンクを読み取ることができるReadableStreamDefaultReader が作成されます。

返値

mode 値に応じて、ReadableStreamDefaultReader またはReadableStreamBYOBReader オブジェクトのインスタンス。

例外

RangeError: 指定されたmode 値が"byob" またはundefined ではありません。
TypeError: リーダーを作成しようとしているストリームがReadableStream ではありません。これは、 BYOB リーダーが要求されたときに、ストリームコントローラーがReadableByteStreamController でない（ストリームがtype="bytes" で基礎ソースとして構築されていない）場合にも発生します。

次の簡単な例では、getReader() を使用して作成したReadableStreamDefaultReader を使用して、以前に作成した独自のReadableStream を読み取ります（完全なコードについては、単純なランダムストリームの例を参照）。各チャンクを順番に読み取り、ストリームの読み取りが完了するまで UI に出力します。ストリームの読み取りが完了すると、再帰関数から戻り、ストリーム全体を UI の別の部分に出力します。

function fetchStream() {  const reader = stream.getReader();  let charsReceived = 0;  // read() は、値を受け取ったときに解決する promise を返します  reader.read().then(function processText({ done, value }) {    // 結果オブジェクトには2つのプロパティが含まれます。    // done - ストリームがすべてのデータを既に提供している場合は true。    // value - 一部のデータ。 done が true の場合、常に undefined。    if (done) {      console.log("Stream complete");      para.textContent = value;      return;    }    // フェッチしたストリームの値は 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;    // さらに読み、この関数を再度呼び出します    return reader.read().then(processText);  });}