mdn/content

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

Closed

#37,250 opened on Dec 17, 2024

View on GitHubContributor guide
 (3 comments) (0 reactions) (0 assignees)Markdown (23,202 forks)batch import
Content:WebAPIhelp wanted

Repository metrics

Stars
 (10,935 stars)
PR merge metrics
 (Avg merge 7d 3h) (147 merged PRs in 30d)

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

Research direction
Review the spec link (https://html.spec.whatwg.org/multipage/webappapis.html#event loop processing model) and the GitHub issue w3c/requestidlecallback#104 to understand the algorithm, then update the MDN documentation to clarify that timeRemaining() can suddenly jump to zero and does not simply count down.
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.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Basic understanding of web APIs
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90