Window: cancelIdleCallback() method

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

The window.cancelIdleCallback() method cancels a callback previously scheduled with window.requestIdleCallback().

Syntax

js
cancelIdleCallback(handle)

Parameters

handle

The ID value returned by window.requestIdleCallback() when the callback was established.

Return value

None (undefined).

Examples

See our complete example in the article Cooperative Scheduling of Background Tasks API.

Specifications

Specification
requestIdleCallback()
# the-cancelidlecallback-method

Browser compatibility

BCD tables only load in the browser