--- title: AbortSignal slug: Web/API/AbortSignal tags: - API - AbortSignal - DOM - Experimental - Interface - Reference translation_of: Web/API/AbortSignal ---
{{APIRef("DOM")}}{{SeeCompatTable}}

AbortSignal 接口表示一个信号对象（ signal object ），它允许您通过 {{domxref("AbortController")}} 对象与DOM请求（如Fetch）进行通信并在需要时将其中止。

属性

AbortSignal接口还继承了其父接口{{domxref("EventTarget")}}的属性。

{{domxref("AbortSignal.aborted")}} {{readonlyInline}}
以 {{domxref("Boolean")}} 表示与之通信的请求是否被终止（true）或未终止（false）。

事件处理

{{domxref("AbortSignal.onabort")}}
当 {{event("abort_(dom_abort_api)", "abort")}} 事件触发时，即当信号正在与之通信的DOM请求被中止时调用。

方法

AbortSignal接口从其父接口 {{domxref("EventTarget")}} 继承方法。

示例

在以下片段中，我们旨在使用Fetch API下载视频。

我们首先使用{{domxref("AbortController.AbortController", "AbortController()")}}构造函数创建一个控制器，然后使用{{domxref ("AbortController.signal")}}属性。

当获取请求被启动时，我们在请求的选项对象中传递AbortSignal作为一个选项（见下面的{signal}）。 这将信号和控制器与获取请求相关联，并允许我们通过调用{{domxref("AbortController.abort()")}}来中止它，如下面的第二个事件监听器所示。

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

var downloadBtn = document.querySelector('.download');
var abortBtn = document.querySelector('.abort');

downloadBtn.addEventListener('click', fetchVideo);

abortBtn.addEventListener('click', function() {
  controller.abort();
  console.log('Download aborted');
});

function fetchVideo() {
  ...
  fetch(url, {signal}).then(function(response) {
    ...
  }).catch(function(e) {
    reports.textContent = 'Download error: ' + e.message;
  })
}

注意: 当调用 abort() 时，fetch() 会调用 reject，返回一个AbortError。

当前版本Firefox当Promise 含有 DOMException 时，会调用reject。

 

你可以在GitHub上找到一个完整的可用示例——请参阅abort-api（实例在这）。

规范

Specification Status Comment
{{SpecName('DOM WHATWG', '#interface-AbortSignal', 'AbortSignal')}} {{Spec2('DOM WHATWG')}} Initial definition

浏览器兼容性

{{Compat("api.AbortSignal")}}

参见