ReadableStream BYOBReader

背景

BYOBは「自分のバッファを持参する」という意味の略語です。ReadableStreamBYOBReaderは、開発者が提供したバッファに読み込むことを可能にし、コピーを最小限に抑えます。

ReadableStreamBYOBReaderのインスタンスは、readメソッドを除いて、ReadableStreamDefaultReaderと機能的に同一です。

ReadableStreamBYOBReaderは、そのコンストラクタを介してインスタンス化されるのではなく、ReadableStreamから取得されます：

const { readable, writable } = new TransformStream();
const reader = readable.getReader({ mode: 'byob' });

---

メソッド

• read(bufferArrayBufferView) : Promise<ReadableStreamBYOBReadResult>

  • 渡されたバッファに読み込まれた次の利用可能なデータチャンクを持つプロミスを返します。

• readAtLeast(minBytes, bufferArrayBufferView) : Promise<ReadableStreamBYOBReadResult>

  • 渡されたバッファに読み込まれた次の利用可能なデータチャンクを持つプロミスを返します。プロミスは、少なくともminBytesが読み込まれるまで解決されません。

---

一般的な問題

警告

readは、バッファに読み込むべき最小バイト数を制御することはできません。1 MiBのバッファを割り当てた場合でも、カーネルはEOFが直後に続くかどうかにかかわらず、この読み取りを1バイトで満たす権利があります。

実際、Workersチームは、readが通常提供されたバッファのわずか1%しか満たさないことを発見しました。

readAtLeastは、ユーザーが読み取りを解決する前に少なくともminBytesバイトがバッファに読み込まれなければならないことを指定できる、Streams APIへの非標準の拡張です。

---

関連リソース

• Streams
• Streams API WHATWG仕様におけるBYOBリーダーに関する背景 ↗