WritableStreamDefaultWriter: desiredSize property

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since May 2022.

Note: This feature is available in Web Workers.

desiredSize là thuộc tính chỉ đọc của giao diện WritableStreamDefaultWriter trả về kích thước mong muốn cần để lấp đầy hàng đợi nội bộ của luồng.

Giá trị

Một số nguyên. Lưu ý rằng giá trị này có thể âm nếu hàng đợi bị đầy quá mức.

Giá trị sẽ là null nếu luồng không thể được ghi thành công (do đang ở trạng thái lỗi, hoặc đã có một thao tác hủy được xếp hàng), và bằng 0 nếu luồng đã đóng.

Ngoại lệ

TypeError

Khóa của trình ghi đã bị giải phóng.

Ví dụ

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

// …

const writer = writableStream.getWriter();

// …

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

Thông số kỹ thuật

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

Tương thích trình duyệt