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

ByteLengthQueuingStrategyクラスは、Web Streams APIにおいて、ストリームがキューに保持できるデータの量をバイト単位で管理するための戦略を定義するクラスです。このクラスは、主にWritableStreamやTransformStreamのような書き込み可能なストリームで使用され、ストリームへのデータの書き込みと内部バッファのバランスを調整する役割を担います。

この戦略を利用することで、ストリームはあらかじめ設定されたバイト数（highWaterMark）を超えるデータがキューに溜まらないように制御できます。highWaterMarkは、ByteLengthQueuingStrategyのコンストラクタに引数として数値で指定され、キューがこの値を超えそうになると、ストリームはバックプレッシャーをかけ、データの供給元に対して一時的に書き込みを停止するよう信号を送ります。これにより、メモリの過剰な消費を防ぎ、システムリソースを効率的に使用できます。

ByteLengthQueuingStrategyは、その名前が示す通り、データの「バイト長」に基づいてキューの管理を行います。ストリームに書き込まれる各データチャンクのバイト長を計算し、キュー全体のサイズを正確に把握します。例えば、大きなバイナリファイルをストリームで処理する際など、データの実際のバイトサイズに基づいてキューを管理することが重要となる場面で、この戦略は非常に効果を発揮します。初心者の方にとって、このクラスは、データの流れをスムーズに保ちつつ、メモリが過剰に使われてアプリケーションが不安定になるのを防ぐための、非常に実用的な仕組みと理解できるでしょう。

Copy
1new ByteLengthQueuingStrategy({ highWaterMark: 1024 });

options

• highWaterMark: number: ストリームの最大バイト長（バイト単位）
• size: (chunk: Buffer | string | any[]): number: チャンクのサイズを計算する関数

ByteLengthQueuingStrategy

ByteLengthQueuingStrategyオブジェクトが返されます。このオブジェクトは、ストリームのエンコーディングされたバイト長に基づいて、キューイング戦略を管理するために使用されます。