IdleDeadline: timeRemaining() メソッド
利用可能性は限定的
この機能はベースラインではありません。最も広く使用されているブラウザーの一部で動作しません。
Want more support for this feature? Tell us why.
timeRemaining() は IdleDeadline インターフェイスのメソッドで、ユーザーエージェントが現在のアイドル期間に残っていると推定するミリ秒数を返します。このコールバックはいつでもこのメソッドを呼び出して、戻る前にどれだけの時間作業を続けられるかを判定できます。たとえば、コールバックがタスクを終了し、次のタスクを開始する場合、timeRemaining() を呼び出して次のタスクを完了するのに十分な時間があるかどうかを確認できます。十分な時間がない場合、コールバックはすぐに戻るか、残りの時間で他の作業を探すことができます。
timeRemaining() が 0 に達する頃には、コールバックはユーザーエージェントのイベントループに制御を戻すことが推奨されます。
構文
js
timeRemaining()
引数
なし。
返値
DOMHighResTimeStamp を返します。これは、現在のアイドル時間に残っているとユーザーエージェントが推定するミリ秒数を表す浮動小数点値です。この値は理想的には約 5 マイクロ秒以内の精度でです。
IdleDeadline オブジェクトの didTimeout プロパティが true の場合、このメソッドは 0 を返します。
例
完全な例は、バックグラウンドタスク API の協調スケジューリングの記事で紹介しています。
仕様書
| 仕様書 |
|---|
| requestIdleCallback() # dom-idledeadline-timeremaining |