大网数据广告活动
Web 标准与前端开发

ReadableStreamBYOBReader: cancel() method

· 52CE 我爱测

The **`cancel()`** method of the ReadableStreamBYOBReader interface returns a Promise that resolves when the stream is canceled. Calling this method signals a loss of interest in the stream by a consumer.

Streams

The cancel() method of the ReadableStreamBYOBReader interface returns a Promise that resolves when the stream is canceled. Calling this method signals a loss of interest in the stream by a consumer.

[!NOTE] If the reader is active, the cancel() method behaves the same as that for the associated stream (ReadableStream.cancel()).

Syntax

cancel()
cancel(reason)

Parameters

  • reason
    • : A human-readable reason for the cancellation. The underlying source may or may not use it.

Return value

A Promise, which fulfills with the value given in the reason parameter.

Exceptions

  • TypeError
    • : The source object is not a ReadableStreamBYOBReader, or the stream has no owner.

Examples

This example code calls the cancel() method when a button is pressed, passing the string "user choice" as a reason. The promise resolves when cancellation completes.

button.addEventListener("click", () => {
  reader.cancel("user choice").then(() => console.log(`cancel complete`));
});

Note that this code can be seen running in the Using readable byte streams example code (press the Cancel stream button).

Specifications

Browser compatibility

See also

来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。

资料来源与适用范围

资料来源
MDN Web Docs / Mozilla 贡献者
适用范围
请按文中版本与环境说明核对
内容语言
中文;命令、路径和错误标识保留技术原文
本地收录日期
2026-11-15
授权说明
CC BY-SA 2.5

正文与所需资源由本站本地存储。查看来源及更新记录 ↗

请按适用版本和实际日志确认原因;本站没有对每一种系统或设备逐项执行文中的操作。