| title | slug | l10n | ||
|---|---|---|---|---|
AbortController：abort() 方法 |
Web/API/AbortController/abort |
|
{{APIRef("DOM")}}{{AvailableInWorkers}}
{{domxref("AbortController")}} 接口的 abort() 方法会在一个异步操作完成之前中止它。它能够中止 fetch 请求、各种响应主体或者流的消耗。
abort()
abort(reason)
reason{{optional_inline}}- : 操作中止的原因，可以是各种 JavaScript 值。如果没有指定，则将原因设置为“AbortError”{{domxref("DOMException")}}。
无（{{jsxref("undefined")}}）。
以下片段中，我们将使用 Fetch API 下载一个视频。
我们首先使用 {{domxref("AbortController.AbortController","AbortController()")}} 构造函数创建一个 controller，然后使用 {{domxref("AbortController.signal")}} 属性获取到它关联的 {{domxref("AbortSignal")}} 对象的引用。
当 fetch 请求初始化时，我们将 AbortSignal 作为一个选项传递进入请求的选项对象中（下面的 {signal}）。这将 signal 和 controller 与 fetch 请求相关联，并且允许我们通过调用 {{domxref("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 上找到完整的工作示例；你还可以看它的在线演示。
{{Specifications}}
{{Compat}}