blob: e811923848cbf972230cdddd12c97c6cbaa9cc6c (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
|
---
title: AbortSignal
slug: Web/API/AbortSignal
tags:
- API
- AbortSignal
- DOM
- Experimental
- Interface
- Reference
translation_of: Web/API/AbortSignal
---
<div>{{APIRef("DOM")}}{{SeeCompatTable}}</div>
<p><code><strong>AbortSignal </strong></code>接口表示一个信号对象（ signal object ），它允许您通过 {{domxref("AbortController")}} 对象与DOM请求（如Fetch）进行通信并在需要时将其中止。</p>
<h2 id="属性">属性</h2>
<p><em>AbortSignal接口还继承了其父接口{{domxref("EventTarget")}}的属性。</em></p>
<dl>
<dt>{{domxref("AbortSignal.aborted")}} {{readonlyInline}}</dt>
<dd><em>以 </em>{{domxref("Boolean")}} 表示<em>与之通信的请求是否被终止（true）或未终止（false）。</em></dd>
</dl>
<h3 id="事件处理">事件处理</h3>
<dl>
<dt>{{domxref("AbortSignal.onabort")}}</dt>
<dd>当 {{event("abort_(dom_abort_api)", "abort")}} 事件触发时，即当信号正在与之通信的DOM请求被中止时调用。</dd>
</dl>
<h2 id="方法">方法</h2>
<p><em>AbortSignal接口从其父接口 {{domxref("EventTarget")}} 继承方法。</em></p>
<h2 id="示例">示例</h2>
<p>在以下片段中，我们旨在使用Fetch API下载视频。</p>
<p>我们首先使用{{domxref("AbortController.AbortController", "AbortController()")}}构造函数创建一个控制器，然后使用{{domxref ("AbortController.signal")}}属性。</p>
<p>当获取请求被启动时，我们在请求的选项对象中传递AbortSignal作为一个选项（见下面的{signal}）。 这将信号和控制器与获取请求相关联，并允许我们通过调用{{domxref("AbortController.abort()")}}来中止它，如下面的第二个事件监听器所示。</p>
<pre class="brush: js">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;
})
}</pre>
<div class="note">
<p><strong>注意</strong>: 当调用<code> abort() </code>时，<code>fetch()</code> 会调用 reject，返回一个AbortError。</p>
</div>
<div class="warning">
<p>当前版本Firefox当<code>Promise</code> 含有 <code>DOMException</code> 时，会调用reject。</p>
</div>
<p> </p>
<p>你可以在GitHub上找到一个完整的可用示例——请参阅<a href="https://github.com/mdn/dom-examples/tree/master/abort-api">abort-api</a>（<a href="https://mdn.github.io/dom-examples/abort-api/">实例在这</a>）。</p>
<h2 id="规范">规范</h2>
<table class="standard-table">
<tbody>
<tr>
<th scope="col">Specification</th>
<th scope="col">Status</th>
<th scope="col">Comment</th>
</tr>
<tr>
<td>{{SpecName('DOM WHATWG', '#interface-AbortSignal', 'AbortSignal')}}</td>
<td>{{Spec2('DOM WHATWG')}}</td>
<td>Initial definition</td>
</tr>
</tbody>
</table>
<h2 id="浏览器兼容性">浏览器兼容性</h2>
<p>{{Compat("api.AbortSignal")}}</p>
<h2 id="参见">参见</h2>
<ul>
<li><a href="/en-US/docs/Web/API/Fetch_API">Fetch API</a></li>
<li><a href="https://developers.google.com/web/updates/2017/09/abortable-fetch">Abortable Fetch</a> by Jake Archibald</li>
</ul>
|
