【Node.js24.x】Object::ReadableStreamBYOBRequest()メソッドの使い方

ReadableStreamBYOBRequestメソッドは、Node.jsのストリームAPIにおいて、BYOB (Bring Your Own Buffer) モードでデータを効率的に処理するメカニズムを実行するメソッドです。このメソッドは、主にReadableByteStreamControllerのbyobRequestプロパティを通じて提供されるリクエストオブジェクトに対する操作を指します。具体的には、ストリームからデータを受け取る側が提供したバッファビューに直接データを書き込み、その書き込み完了をストリームシステムに通知する一連の処理を管理します。

このメソッドは、view プロパティを通じて供給されたArrayBufferView型のバッファにデータを配置し、その後 respond() メソッドを呼び出すことで、実際に書き込まれたバイト数をストリームに伝えます。これにより、新しいメモリを頻繁に割り当てる必要が少なくなり、既存のバッファを再利用することでメモリアロケーションを最小限に抑え、高パフォーマンスなデータ転送を実現します。システムエンジニアを目指す方にとって、このメソッドは、低レベルのバイトストリーム操作において、メモリ効率の良いデータ処理を実現するための重要な概念となります。効率的なデータフローを設計する際に、このBYOBモードの利点を理解し活用することは非常に有用です。

Copy
1const view = request.view;
2const bytesWritten = Math.min(view.byteLength, 1024); // データを書き込むバイト数を決定
3
4// ここで view.buffer または view に直接データを書き込みます
5// 例: new Uint8Array(view.buffer, view.byteOffset, view.byteLength)[0] = 0xFF;
6
7request.respond(bytesWritten); // 書き込んだバイト数を報告します

引数なし

引数はありません

戻り値なし

戻り値はありません