timeRemaining() documentation should flag that it doesn't just count down

[jyasskin]

MDN URL

https://developer.mozilla.org/en-US/docs/Web/API/IdleDeadline/timeRemaining

What specific section or headline is this issue about?

No response

What information was incorrect, unhelpful, or incomplete?

The text implies that the "current idle period" is a fixed period, and the method just counts down to the end of it. But in fact, it uses an algorithm passed from https://html.spec.whatwg.org/multipage/webappapis.html#event-loop-processing-model that can suddenly jump to zero. I don't think it can increase, but you might want to check with the spec authors to be sure of that.

What did you expect to see?

A description of what asynchronous changes to expect from the return value of this method.

Do you have any supporting links, references, or citations?

w3c/requestidlecallback#104

Do you have anything more you want to share?

No response

MDN metadata

Page report details

• Folder: en-us/web/api/idledeadline/timeremaining
• MDN URL: https://developer.mozilla.org/en-US/docs/Web/API/IdleDeadline/timeRemaining
• GitHub URL: https://github.com/mdn/content/blob/main/files/en-us/web/api/idledeadline/timeremaining/index.md
• Last commit: ce85e3f
• Document last modified: 2024-03-11T23:58:17.000Z