CKTIS / JavaScript
IdleDeadline: reden voor de aanroep en resterende inactieve tijd
`didTimeout` geeft aan waarom de callback wordt uitgevoerd; `timeRemaining()` schat hoeveel milliseconden er in de huidige inactieve periode over zijn.
Versie: ECMAScript 2024 and the current web platform; runtime support varies
Syntax
window.requestIdleCallback(callback);
window.requestIdleCallback(callback, { timeout: milliseconds });
// Inside callback(deadline), where deadline is an IdleDeadline:
deadline.didTimeout; // read-only boolean property
deadline.timeRemaining(); // number of milliseconds, no argumentsDe browser geeft een IdleDeadline-object door aan de callback die je met window.requestIdleCallback() registreert. Dit is een web-API op Window, geen onderdeel van ECMAScript 2024. Ze is niet beschikbaar in Web Workers en de ondersteuning verschilt per browser. Controleer vóór de aanroep of de API beschikbaar is.
deadline.didTimeout is een alleen-lezen booleaanse eigenschap. true betekent dat de callback wordt uitgevoerd omdat de optionele timeout is verstreken; false betekent dat de aanroep tijdens een inactieve periode plaatsvond. Als de termijn verstrijkt voordat de callback is uitgevoerd, zet de browser een taak voor de aanroep in de wachtrij. Dat onderbreekt lopende code niet en garandeert geen exact starttijdstip. Zonder time-out kan de callback lang op zich laten wachten.
deadline.timeRemaining() accepteert geen argumenten en geeft een niet-negatieve schatting van de resterende inactieve tijd in milliseconden, eventueel met een fractie. De methode geeft 0 terug bij didTimeout === true, maar kan ook 0 teruggeven bij didTimeout === false als de beschikbare tijd op is. De schatting is geen gereserveerde uitvoeringstijd en telt niet af naar timeout. Lees de waarde tijdens de huidige callback en vertrouw er niet op na een await.
Verdeel het werk in kleine stukken en controleer vóór elk stuk timeRemaining() > 0. Is de aanroep het gevolg van de time-out, voer dan hoogstens één klein noodzakelijk stuk uit en plan een nieuwe callback voor de rest. Een lusvoorwaarde met || deadline.didTimeout kan de hele wachtrij leegmaken, ook als er geen inactieve tijd beschikbaar is.
Voorbeelden
(() => {
function logIdleStatus(host) {
if (typeof host.requestIdleCallback !== 'function') {
console.log('requestIdleCallback unavailable');
return;
}
host.requestIdleCallback((deadline) => {
const reason = deadline.didTimeout ? 'timeout' : 'idle';
const budget = deadline.timeRemaining() > 0
? 'budget available'
: 'no idle budget';
console.log(`${reason}: ${budget}`);
}, { timeout: 100 });
}
if (typeof window !== 'undefined') {
logIdleStatus(window);
return;
}
// Test doubles exercise the callback without browser scheduling.
for (const [didTimeout, remaining] of [[false, 5], [false, 0], [true, 0]]) {
logIdleStatus({
requestIdleCallback(callback) {
callback({ didTimeout, timeRemaining: () => remaining });
},
});
}
logIdleStatus({});
})();Resultaat
idle: budget available idle: no idle budget timeout: no idle budget requestIdleCallback unavailable
In Node.js toont het voorbeeld alle vier de regels in de aangegeven volgorde. Voor de eerste drie gevallen gebruikt het testobjecten in plaats van `IdleDeadline`-objecten, en voor het laatste geval een object zonder de API. Dit test niet hoe de browser taken plant. Plak je de code in de ontwikkelaarsconsole van een browserpagina, dan verschijnt er maar één regel: een van de eerste drie asynchroon als de API wordt ondersteund, of anders meteen de vierde. De instelling van 100 ms dwingt de time-outroute niet af.
Gerelateerde lessen
- JavaScript · Les 6 · Gevorderd · Versie: 4