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

AbortController:abort() 方法

· 52CE 我爱测

AbortController 接口的 **`abort()`** 方法会在一个异步操作完成之前中止它。它能够中止 fetch 请求、各种响应主体或者流的消耗。

DOM

AbortController 接口的 abort() 方法会在一个异步操作完成之前中止它。它能够中止 fetch 请求、各种响应主体或者流的消耗。

语法

abort()
abort(reason)

参数

  • reason
    • : 操作中止的原因,可以是各种 JavaScript 值。如果没有指定,则将原因设置为“AbortError”DOMException。

返回值

无(undefined)。

示例

以下片段中,我们将使用 Fetch API 下载一个视频。

我们首先使用 AbortController.AbortController 构造函数创建一个 controller,然后使用 AbortController.signal 属性获取到它关联的 AbortSignal 对象的引用。

当 fetch 请求初始化时,我们将 AbortSignal 作为一个选项传递进入请求的选项对象中(下面的 {signal})。这将 signal 和 controller 与 fetch 请求相关联,并且允许我们通过调用 AbortController.abort() 去中止它,如下面的第二个事件监听器。

const controller = new AbortController();
const signal = controller.signal;

const url = "video.mp4";
const downloadBtn = document.querySelector(".download");
const abortBtn = document.querySelector(".abort");

downloadBtn.addEventListener("click", fetchVideo);

abortBtn.addEventListener("click", () => {
  controller.abort();
  console.log("Download aborted");
});

function fetchVideo() {
  fetch(url, { signal })
    .then((response) => {
      console.log("Download complete", response);
    })
    .catch((err) => {
      console.error(`Download error: ${err.message}`);
    });
}

[!NOTE] 当 abort() 被调用时,fetch() promise 将会抛出 DOMException 类型的 Error(名称为 AbortError)。

你可以在 github 上找到完整的工作示例;你还可以看它的在线演示。

规范

浏览器兼容性

参见

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

资料来源与适用范围

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

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

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