blob: 8caa750806f2dc321c1c271f3b8190b1e44bf1ee (
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
|
---
title: AbortController
slug: Web/API/AbortController
translation_of: Web/API/AbortController
---
<div>{{APIRef("DOM")}}{{SeeCompatTable}}</div>
<p><strong><code>AbortController</code></strong> 介面代表一個控制器物件，讓你可以在需要時中斷一個或多個 DOM 請求。</p>
<p>你可以使用 {{domxref("AbortController.AbortController()")}} 建立一個新的 <code>AbortController</code> 物件。與 DOM 請求溝通時則是使用 {{domxref("AbortSignal")}} 物件。</p>
<h2 id="建構子">建構子</h2>
<dl>
<dt>{{domxref("AbortController.AbortController()")}}</dt>
<dd>建立一個新的 <code>AbortController</code> 物件實體。</dd>
</dl>
<h2 id="屬性">屬性</h2>
<dl>
<dt>{{domxref("AbortController.signal")}} {{readonlyInline}}</dt>
<dd>回傳一個 {{domxref("AbortSignal")}} 物件實體，可以用來中斷一個 DOM 請求、或是與其溝通。</dd>
</dl>
<h2 id="方法">方法</h2>
<dl>
<dt>{{domxref("AbortController.abort()")}}</dt>
<dd>在一個 DOM 請求完成前中斷他。這可以用來中斷 <a href="/zh-TW/docs/Web/API/WindowOrWorkerGlobalScope/fetch">fetch 請求</a>、對任何 Response {{domxref("Body")}} 的讀取、或是資料流。</dd>
</dl>
<h2 id="範例">範例</h2>
<p>在下面的程式碼片段中，我們要用 <a href="/zh-TW/docs/Web/API/Fetch_API">Fetch API</a> 來下載一部影片。</p>
<p>我們首先用 {{domxref("AbortController.AbortController","AbortController()")}} 建立一個控制器，然後透過 {{domxref("AbortController.signal")}} 屬性取得他的 {{domxref("AbortSignal")}} 物件。</p>
<p>在初始化 <a href="/en-TW/docs/Web/API/WindowOrWorkerGlobalScope/fetch">fetch 請求</a> 的時候，我們把 <code>AbortSignal</code> 作為選項傳入該請求的選項物件中（參考下方的 <code>{signal}</code>）。這樣會把剛才的中斷訊號與控制器跟 fetch 請求關聯起來，讓我們可以透過呼叫 {{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('下載已中斷');
});
function fetchVideo() {
...
fetch(url, {signal}).then(function(response) {
...
}).catch(function(e) {
reports.textContent = '下載錯誤: ' + e.message;
})
}</pre>
<div class="note">
<p><strong>注意</strong>: 當 <code>abort()</code> 被呼叫的時候，<code>fetch()</code> 回傳的 Promise 會被以 <code>AbortError</code> 拒絕。</p>
</div>
<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-abortcontroller', 'AbortController')}}</td>
<td>{{Spec2('DOM WHATWG')}}</td>
<td>初始定義</td>
</tr>
</tbody>
</table>
<h2 id="瀏覽器相容性">瀏覽器相容性</h2>
<p>{{Compat("api.AbortController")}}</p>
<h2 id="參見">參見</h2>
<ul>
<li><a href="/zh-TW/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>
|
