ReadableStreamDefaultController: desiredSize プロパティ

Baseline 広く利用可能

この機能は広く実装されており、多くのバージョンの端末やブラウザーで動作します。2020年1月以降、すべてのブラウザーで利用可能です。

desiredSize は ReadableStreamDefaultController インターフェイスの読み取り専用プロパティで、ストリームの内部キューを満たすために必要な希望サイズを返します。

整数。キューがいっぱいになった場合、これは負になる可能性があることに注意してください。

仕様にある基になるプッシュソースと背圧サポートのある読み取り可能なストリームの例は、desiredSize を使用してストリームがいっぱいになったことを手動で検出し、背圧を適用する良い例を示しています。また、ReadablestreamDefaultController.error() を使用して、依存しているシステムの別の部分に障害が発生した場合に手動でストリームのエラーをトリガーします。