requestIdleCallback

Limited availability

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

window.requestIdleCallback() メソッドを利用すると、ブラウザーがアイドル状態の時に実行される関数をキューに登録できます。これにより、アニメーションや入力への応答など、遅延が問題となる処理に影響を与えることなく、優先度の低いバックグラウンド処理をメインスレッド内で実行することができます。キューに登録された関数は原則として先に登録したものが先に実行されますが、指定された timeout を守るために必要であれば優先して実行されることがあります。

requestIdleCallback() をアイドルコールバック関数の中で呼び出すことで、別のコールバックを次のイベントループ以降すぐに実行されるようスケジュールすることもできます。

メモ: timeout は必須のタスクにおいては設定することを強くおすすめします。設定しない場合、コールバックが実行するまでに数秒かかってしまう可能性もあるからです。

構文

js
requestIdleCallback(callback)
requestIdleCallback(callback, options)

引数

callback

イベントループがアイドル状態になったときに実行されるコールバック関数への参照。コールバック関数は引数に IdleDeadline オブジェクトを受け取り、処理に使える残り時間や、この呼び出しがタイムアウト時間の経過によるものかどうかを知ることができます。

options 省略可

任意の設定パラメータです。現在はひとつのプロパティのみ定義されています。

  • timeout:このパラメータに指定された時間(ミリ秒)が経過してもコールバックがまだ実行されていない場合、(パフォーマンスに影響を与える可能性があっても)コールバックを実行するタスクがイベントループにキューイングされます。 timeout が正の数値でない場合は無視されます。

返値

コールバックをキャンセルする時に Window.cancelIdleCallback() メソッドに渡す ID を返します。

Cooperative Scheduling of Background Tasks APIの記事で、例を一式紹介しています。

仕様書

Specification
requestIdleCallback()
# the-requestidlecallback-method

ブラウザーの互換性

Report problems with this compatibility data on GitHub
desktopmobile
Chrome
Edge
Firefox
Opera
Safari
Chrome Android
Firefox for Android
Opera Android
Safari on iOS
Samsung Internet
WebView Android
WebView on iOS
requestIdleCallback

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support
No support
No support
See implementation notes.

関連情報