WritableStreamDefaultWriter.desiredSize

草案

このページは完成していません。

Experimental

これは実験的な機能です。
本番で使用する前にブラウザー互換性一覧表をチェックしてください。

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

構文

var desiredSize = writableStreamDefaultWriter.desiredSize;

値

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

値は、（エラーが発生したか、中止がキューに入れられたために）ストリームに正常に書き込むことができない場合、null になり、ストリームが閉じられると 0 になります。

例外

TypeError: ライターのロックが解除されています。

例

const writableStream = new WritableStream({
  write(chunk) {
    ...
  },
  close() {
    ...
  },
  abort(err) {
    ...
  }
}, queuingStrategy);

...

const writer = writableStream.getWriter();

...

// ストリームの希望サイズを返します
let size = writer.desiredSize;

仕様

仕様	状態	コメント
Streams desiredSize の定義	現行の標準	初期定義

ブラウザーの互換性

BCD tables only load in the browser