WritableStreamDefaultWriter: desiredSize プロパティ

Baseline 2022

Newly available

Since June 2022, this feature works across the latest devices and browser versions. This feature might not work in older devices or browsers.

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

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

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

例外

TypeError

ライターのロックが解除されてた場合。

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

// ...

const writer = writableStream.getWriter();

// ...

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

仕様書

Specification
Streams Standard
# ref-for-default-writer-desired-size⑥

ブラウザーの互換性

BCD tables only load in the browser