ReadableStreamBYOBReader: phương thức cancel()
Baseline
2026
Newly available
Since March 2026, this feature works across the latest devices and browser versions. This feature might not work in older devices or browsers.
Note: This feature is available in Web Workers.
Phương thức cancel() của giao diện ReadableStreamBYOBReader trả về một Promise được giải quyết khi stream bị hủy.
Gọi phương thức này báo hiệu rằng consumer không còn quan tâm đến stream.
Note:
Nếu reader đang hoạt động, phương thức cancel() hoạt động giống như phương thức tương ứng của stream liên quan (ReadableStream.cancel()).
Cú pháp
cancel()
cancel(reason)
Tham số
reasonOptional-
Lý do hủy mà con người có thể đọc được. Nguồn bên dưới có thể hoặc không sử dụng nó.
Giá trị trả về
Một Promise, hoàn thành với giá trị được cho trong tham số reason.
Ngoại lệ
TypeError-
Đối tượng nguồn không phải là
ReadableStreamBYOBReader, hoặc stream không có chủ.
Ví dụ
Mã ví dụ này gọi phương thức cancel() khi nút được nhấn, truyền chuỗi "user choice" làm lý do.
Promise được giải quyết khi việc hủy hoàn tất.
button.addEventListener("click", () => {
reader.cancel("user choice").then(() => console.log(`cancel complete`));
});
Lưu ý rằng mã này có thể thấy đang chạy trong ví dụ Sử dụng readable byte streams (nhấn nút Cancel stream).
Thông số kỹ thuật
| Specification |
|---|
| Streams # ref-for-generic-reader-cancel② |
Tương thích trình duyệt
Xem thêm
- Hàm khởi tạo
ReadableStreamBYOBReader() - Sử dụng readable byte stream