---
title: window.cancelIdleCallback()
slug: Web/API/Window/cancelIdleCallback
tags:
  - API
  - JavaScript timers
  - Window
  - cancelIdleCallback
translation_of: Web/API/Window/cancelIdleCallback
---
<div>{{APIRef}}{{SeeCompatTable}}</div>

<h2 id="Summary" name="Summary">概述</h2>

<p> <strong><code>window.cancelIdleCallback()</code></strong> 方法用于取消之前调用{{domxref("window.requestIdleCallback()")}} 的回调。</p>

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

<pre class="syntaxbox">window.cancelIdleCallback(<em>handle</em>);</pre>

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

<dl>
 <dt><code>handle</code></dt>
 <dd>调用 {{domxref("window.requestIdleCallback()")}}  时返回的 ID.</dd>
</dl>

<h3 id="返回值">返回值</h3>

<p><code>undefined</code>.</p>

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

<p>在文章 <a href="/en-US/docs/Web/API/Background_Tasks_API">Cooperative Scheduling of Background Tasks API</a> 中可以查看<a href="/en-US/docs/Web/API/Background_Tasks_API#Example"> 完整示例</a> 。</p>

<h2 id="Specifications" name="Specifications">规范</h2>

<table class="standard-table">
 <tbody>
  <tr>
   <th>Specification</th>
   <th>Status</th>
   <th>Comment</th>
  </tr>
  <tr>
   <td>{{SpecName('Background Tasks')}}</td>
   <td>{{Spec2('Background Tasks')}}</td>
   <td>Initial definition.</td>
  </tr>
 </tbody>
</table>

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

{{Compat("api.Window.cancelIdleCallback")}}