mdn/content

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

Open

#37,250 opened on Dec 17, 2024

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Markdown (8,900 stars) (22,427 forks)batch import
Content:WebAPIhelp wanted

Description

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?

https://github.com/w3c/requestidlecallback/issues/104

Do you have anything more you want to share?

No response

MDN metadata

Contributor guide

Tech stack
javascript
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
Update the MDN page for IdleDeadline.timeRemaining to clarify that the return value can drop to zero asynchronously based on the event loop processing model. Reference the HTML spec (https://html.spec.whatwg.org/multipage/webappapis.html#event loop processing model) and the WICG issue (https://github.com/w3c/requestidlecallback/issues/104) for details. The file to modify is /files/en us/web/api/idledeadline/timeremaining/index.md in the mdn/content repository.