aboutsummaryrefslogtreecommitdiff
path: root/files/zh-cn/web/api/abortsignal
diff options
context:
space:
mode:
authorPeter Bengtsson <mail@peterbe.com>2020-12-08 14:40:17 -0500
committerPeter Bengtsson <mail@peterbe.com>2020-12-08 14:40:17 -0500
commit33058f2b292b3a581333bdfb21b8f671898c5060 (patch)
tree51c3e392513ec574331b2d3f85c394445ea803c6 /files/zh-cn/web/api/abortsignal
parent8b66d724f7caf0157093fb09cfec8fbd0c6ad50a (diff)
downloadtranslated-content-33058f2b292b3a581333bdfb21b8f671898c5060.tar.gz
translated-content-33058f2b292b3a581333bdfb21b8f671898c5060.tar.bz2
translated-content-33058f2b292b3a581333bdfb21b8f671898c5060.zip
initial commit
Diffstat (limited to 'files/zh-cn/web/api/abortsignal')
-rw-r--r--files/zh-cn/web/api/abortsignal/aborted/index.html57
-rw-r--r--files/zh-cn/web/api/abortsignal/index.html107
-rw-r--r--files/zh-cn/web/api/abortsignal/onabort/index.html61
3 files changed, 225 insertions, 0 deletions
diff --git a/files/zh-cn/web/api/abortsignal/aborted/index.html b/files/zh-cn/web/api/abortsignal/aborted/index.html
new file mode 100644
index 0000000000..eca97c13cf
--- /dev/null
+++ b/files/zh-cn/web/api/abortsignal/aborted/index.html
@@ -0,0 +1,57 @@
+---
+title: AbortSignal.aborted
+slug: Web/API/AbortSignal/aborted
+translation_of: Web/API/AbortSignal/aborted
+---
+<div>{{APIRef("DOM")}}{{SeeCompatTable}}</div>
+
+<p><strong><code>aborted</code></strong>是一个只读属性,它返回一个{{domxref("Boolean")}}表示与DOM通讯的信号是(<code>true</code>)否(<code>false</code>)已被放弃。</p>
+
+<h2 id="语法">语法</h2>
+
+<pre class="brush: js">var isAborted = abortSignal.aborted;</pre>
+
+<h3 id="取值">取值</h3>
+
+<p>一个{{domxref("Boolean")}}</p>
+
+<h2 id="示例">示例</h2>
+
+<p>在下面的代码段中,我们创建了一个新的<code>AbortController</code>对象,并获取它的{{domxref("AbortSignal")}} (位于<code>signal</code>属性中)。然后我们用<code>aborted</code>属性检查这个信号是否已被放弃,并把相应的日志发送给终端。</p>
+
+<pre class="brush: js">var controller = new AbortController();
+var signal = controller.signal;
+
+// ...
+
+signal.aborted ? console.log('Request has been aborted') : console.log('Request not aborted');
+</pre>
+
+<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', '#dom-abortsignal-onabort', 'onabort')}}</td>
+ <td>{{Spec2('DOM WHATWG')}}</td>
+ <td>初始定义</td>
+ </tr>
+ </tbody>
+</table>
+
+<h2 id="浏览器兼容性">浏览器兼容性</h2>
+
+
+
+<p>{{Compat("api.AbortSignal.aborted")}}</p>
+
+<h2 id="参见">参见</h2>
+
+<ul>
+ <li><a href="/en-US/docs/Web/API/Fetch_API">Fetch API</a></li>
+</ul>
diff --git a/files/zh-cn/web/api/abortsignal/index.html b/files/zh-cn/web/api/abortsignal/index.html
new file mode 100644
index 0000000000..445511e99c
--- /dev/null
+++ b/files/zh-cn/web/api/abortsignal/index.html
@@ -0,0 +1,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>
+
+<div class="hidden">此页面上的兼容性表格由结构化数据生成。 如果您想提供数据,请查看https://github.com/mdn/browser-compat-data并向我们发送拉取请求。</div>
+
+<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>
diff --git a/files/zh-cn/web/api/abortsignal/onabort/index.html b/files/zh-cn/web/api/abortsignal/onabort/index.html
new file mode 100644
index 0000000000..e72dd94c4a
--- /dev/null
+++ b/files/zh-cn/web/api/abortsignal/onabort/index.html
@@ -0,0 +1,61 @@
+---
+title: AbortSignal.onabort
+slug: Web/API/AbortSignal/onabort
+tags:
+ - API
+ - Fetch
+ - onabort
+ - 事件处理
+ - 属性
+ - 测试
+ - 终止属性
+translation_of: Web/API/AbortSignal/onabort
+---
+<div>{{APIRef("DOM")}}{{SeeCompatTable}}</div>
+
+<div>当事件被{{event("abort_(cancellable_fetch)", "终止")}},{{domxref("FetchSignal")}}接口的<strong><code>onabort</code></strong> 只读属性就会被调用。例子.当fetch的请求信号被终止。</div>
+
+<h2 id="语法">语法</h2>
+
+<pre class="brush: js">abortSignal.onabort = function() { ... };</pre>
+
+<h2 id="示例">示例</h2>
+
+<p>在下面例子中, 我们将创建一个新的 <code>AbortController</code> 对象,并获取它的{{domxref("AbortSignal")}} (在 <code>signal</code> 属性中可用)。然后我们查看 <code>onabort</code> 属性是否被终止,并将相应的日志输出到控制台。</p>
+
+<pre class="brush: js">var controller = new AbortController();
+var signal = controller.signal;
+
+signal.onabort = function() {
+ console.log('Request aborted');
+};
+</pre>
+
+<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', '#dom-abortsignal-aborted', 'onabort')}}</td>
+ <td>{{Spec2('DOM WHATWG')}}</td>
+ <td>初始定义</td>
+ </tr>
+ </tbody>
+</table>
+
+<h2 id="浏览器兼容性">浏览器兼容性</h2>
+
+
+
+<p>{{Compat("api.AbortSignal.onabort")}}</p>
+
+<h2 id="参考文档">参考文档</h2>
+
+<ul>
+ <li><a href="/en-US/docs/Web/API/Fetch_API">Fetch API</a></li>
+</ul>