WritableStreamDefaultWriter: desiredSize 属性

基线 2022

新可用

自 2022 年 6 月起，此功能在最新的设备和浏览器版本上均可使用。此功能可能无法在较旧的设备或浏览器上使用。

注意：此功能在Web Workers 中可用。

desiredSize 是 WritableStreamDefaultWriter 接口的只读属性，它返回填充流的内部队列所需的所需大小。

值

一个整数。请注意，如果队列已满，则此值可以为负数。

如果无法成功写入流（由于流出错或已排队中止），则该值为 null；如果流已关闭，则该值为零。

异常

TypeError

写入器的锁已释放。

示例

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

// ...

const writer = writableStream.getWriter();

// ...

// return stream's desired size
let size = writer.desiredSize;

规范

规范
流标准
# ref-for-default-writer-desired-size⑥

浏览器兼容性

BCD 表格仅在浏览器中加载