files/zh-cn/web/api/extendableevent/waituntil/index.html


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

---
title: ExtendableEvent.waitUntil()
slug: Web/API/ExtendableEvent/waitUntil
translation_of: Web/API/ExtendableEvent/waitUntil
---
<p>{{APIRef("Service Workers API")}}</p>

<p><code><strong>ExtendableEvent.waitUntil()</strong></code> 方法告诉事件分发器该事件仍在进行。这个方法也可以用于检测进行的任务是否成功。在服务工作线程中，这个方法告诉浏览器事件一直进行，直至 promise 解决，浏览器不应该在事件中的异步操作完成之前终止服务工作线程。</p>

<p>服务工作线程（<a href="/zh-CN/docs/Web/API/ServiceWorkerGlobalScope">service workers</a>）中的 {{domxref("ServiceWorkerGlobalScope/install_event", "install")}} 事件使用 <code>waitUntil()</code> 来将服务工作线程保持在 {{domxref("ServiceWorkerRegistration.installing", "installing")}} 阶段。如果传入 <code>waitUntil()</code> 的 promise 被拒绝，则将此次安装视为失败，丢弃这个服务工作线程。这主要用于确保在服务工作线程安装以前，所有依赖的核心缓存都已经成功载入。</p>

<p>服务工作线程（<a href="/zh-CN/docs/Web/API/ServiceWorkerGlobalScope">service workers</a>）中的 {{domxref("ServiceWorkerGlobalScope/activate_event", "activate")}} 事件使用 <code>waitUntil()</code> 来延迟函数事件，如 <code>fetch</code> 和 <code>push</code>，直至传入 <code>waitUntil()</code> 的 promise 被解决。这让服务工作线程有时间更新数据库架构（database schema）和删除过时缓存（{{domxref("Cache", "caches")}}），让其他事件能在一个完成更新的状态下进行。</p>

<p> <code>waitUntil()</code> 方法最初必须在事件回调里调用，在此之后，方法可以被调用多次，直至所有传入的 promise 被解决。</p>

<div class="note">
<p><strong>注意</strong>: 上述段落描述的行为已经在Firefox 43中被修复 (参见 {{bug(1180274)}}.)</p>
</div>

<h2 id="语法">语法</h2>

<pre class="notranslate"><em>extendableEvent</em>.waitUntil(<em>promise</em>);</pre>

<h3 id="参数">参数</h3>

<p>一个 {{jsxref("Promise")}}.</p>

<h2 id="示例">示例</h2>

<p>在服务工作线程的 <code>install</code> 事件中使用 <code>waitUntil()</code>。</p>

<pre class="notranslate">addEventListener('install', event =&gt; {
  const preCache = async () =&gt; {
    const cache = await caches.open('static-v1');
    return cache.addAll([
      '/',
      '/about/',
      '/static/styles.css'
    ]);
  };
  event.waitUntil(preCache());
});</pre>

<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('Service Workers', '#dom-extendableevent-waituntil', 'waitUntil()')}}</td>
   <td>{{Spec2('Service Workers')}}</td>
   <td>Initial definition</td>
  </tr>
 </tbody>
</table>

<h2 id="浏览器兼容性">浏览器兼容性</h2>

<p>{{Compat("api.ExtendableEvent.waitUntil")}}</p>

<h2 id="另参见">另参见</h2>

<ul>
 <li><a href="https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorker_API/Using_Service_Workers">Using Service Workers</a></li>
 <li><a class="external external-icon" href="https://github.com/mdn/sw-test">Service workers basic code example</a></li>
 <li><a class="external external-icon" href="https://jakearchibald.github.io/isserviceworkerready/">Is ServiceWorker ready?</a></li>
 <li>{{jsxref("Promise")}}</li>
 <li><a href="https://developer.mozilla.org/en-US/docs/Web/Guide/Performance/Using_web_workers">Using web workers</a></li>
</ul>