aboutsummaryrefslogtreecommitdiff
path: root/files/ko/web/api/abortcontroller/index.html
blob: 4d3b92e09bcdc9582262df51cb3ec7ad2b6895e9 (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
---
title: AbortController
slug: Web/API/AbortController
tags:
  - API
  - AbortController
  - 레퍼런스
  - 실험적
  - 인터페이스
translation_of: Web/API/AbortController
---
<div>{{APIRef("DOM")}}{{SeeCompatTable}}</div>

<p><strong><code>AbortController</code></strong> 인터페이스는 하나 이상의 웹 요청을 취소할 수 있게 해준다.</p>

<p>{{domxref("AbortController.AbortController()")}} 생성자를 사용해 새로운 <code>AbortController</code> 를 생성한다. {{domxref("AbortSignal")}} 객체를 사용해 DOM 요청과의 통신이 완료된다.</p>

<h2 id="생성자">생성자</h2>

<dl>
 <dt>{{domxref("AbortController()")}}</dt>
 <dd>새로운 <code>AbortController</code> 객체 인터페이스를 생성한다.</dd>
</dl>

<h2 id="프로퍼티">프로퍼티</h2>

<dl>
 <dt>{{domxref("AbortController.signal")}} {{readonlyInline}}</dt>
 <dd>DOM 요청과 통신하거나 취소하는데 사용되는 {{domxref("AbortSignal")}} 객체 인터페이스를 반환한다.</dd>
</dl>

<h2 id="메소드">메소드</h2>

<dl>
 <dt>{{domxref("AbortController.abort()")}}</dt>
 <dd>DOM 요청이 완료되기 전에 취소한다. 이를 통해 <a href="https://wiki.developer.mozilla.org/ko/docs/Web/API/WindowOrWorkerGlobalScope/fetch">fetch 요청</a>, 모든 응답 {{domxref("Body")}} 소비, 스트림을 취소할 수 있다.</dd>
</dl>

<h2 id="예제">예제</h2>

<p>다음 스니펫에서는 <a href="https://wiki.developer.mozilla.org/ko/docs/Web/API/Fetch_API">Fetch API</a>를 사용해 비디오를 다운로드하는 것을 목표로 한다.</p>

<p>먼저 {{domxref("AbortController.AbortController","AbortController()")}} 생성자를 사용해 컨트롤러를 {{domxref("AbortController.signal")}} 프로퍼티를 사용해 {{domxref("AbortSignal")}} 객체와 관계된 참조를 얻는다.</p>

<p><a href="/ko/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('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> promise는 <code dir="ltr">AbortError</code>으로 명명된 <code dir="ltr">DOMException</code>과 함께 reject된다.</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">명세</th>
   <th scope="col">상태</th>
   <th scope="col">코멘트</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="https://wiki.developer.mozilla.org/ko/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>