IdleDeadline.timeRemaining()

IdleDeadline 接口上的 timeRemaining() 方法返回当前空闲期间剩余的估计毫秒数。回调函数可以在任何时候调用此方法,以确定在必须返回之前它可以继续工作多长时间。例如,如果回调完成了一个任务,并且有另一个任务要开始,它可以调用 timeRemaining() 来查看是否有足够的时间来完成下一个任务。如果没有,回调函数可以立即返回,或者用剩余的时间寻找其他合适的工作。

timeRemaining() 达到 0 时,建议回调应该将控制权返回给用户代理的事件循环。

语法

js
timeRemaining = IdleDeadline.timeRemaining();

返回值

一个 DOMHighResTimeStamp 值(是一个浮点数),表示用户代理估计在当前空闲期间内剩余的毫秒数。理想情况下,该值精确到大约 5 微秒。

如果 IdleDeadline 对象的 didTimeout 属性为 true ,该方法返回 0

示例

在文章后台任务协作调度 API 中可以查看完整示例

规范

Specification
requestIdleCallback() Cooperative Scheduling of Background Tasks
# dom-idledeadline-timeremaining

浏览器兼容性

BCD tables only load in the browser

参见