CKTIS / JavaScript
IdleDeadline: dôvod volania a zostávajúci čas nečinnosti
`didTimeout` hovorí, prečo sa spustilo spätné volanie; `timeRemaining()` odhaduje, koľko milisekúnd zostáva v aktuálnom období nečinnosti.
Verzia: 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 argumentsPrehliadač odovzdá objekt IdleDeadline funkcii spätného volania zaregistrovanej cez window.requestIdleCallback(). Ide o webové API v kontexte Window, nie o súčasť ECMAScriptu 2024. Nie je dostupné vo Web Workeroch a podpora závisí od prehliadača. Pred volaním overte jeho dostupnosť.
deadline.didTimeout je booleovská vlastnosť určená iba na čítanie. true znamená, že volanie vyvolalo uplynutie voliteľnej lehoty timeout; false znamená, že sa funkcia zavolala v období nečinnosti. Ak lehota uplynie pred spustením funkcie, prehliadač zaradí úlohu na jej spustenie do frontu. Tým nepreruší bežiaci kód ani nezaručí presný čas spustenia. Bez lehoty môže čakanie trvať dlho.
deadline.timeRemaining() neprijíma argumenty a vracia nezáporný odhad zostávajúceho času nečinnosti v milisekundách, prípadne aj v zlomkoch milisekundy. Pri didTimeout === true vracia 0, ale 0 môže vrátiť aj pri didTimeout === false, ak sa dostupný čas vyčerpal. Odhad nie je vyhradený čas na vykonanie kódu ani odpočet do uplynutia timeout. Čítajte ho počas aktuálneho volania, nespoliehajte sa naň po await.
Rozdeľte prácu na malé časti a pred každou overte timeRemaining() > 0. Pri volaní po uplynutí lehoty vykonajte najviac jednu malú nevyhnutnú časť a pre zvyšok naplánujte ďalšie volanie. Podmienka cyklu s || deadline.didTimeout môže vyprázdniť celý front, aj keď už nezostáva žiadny čas nečinnosti.
Príklady
(() => {
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({});
})();Výsledok
idle: budget available idle: no idle budget timeout: no idle budget requestIdleCallback unavailable
V Node.js príklad vypíše všetky štyri riadky v uvedenom poradí. Pre prvé tri prípady používa testovacie objekty namiesto objektov `IdleDeadline` a pre posledný prípad objekt bez API. Tým sa netestuje plánovanie úloh v prehliadači. Po vložení kódu do vývojárskej konzoly stránky v prehliadači program vypíše iba jeden riadok: s podporou API asynchrónne jeden z prvých troch, bez podpory ihneď štvrtý. Nastavenie 100 ms nevynúti volanie po uplynutí lehoty.
Súvisiace lekcie
- JavaScript · Lekcia 6 · Pokročilá · Verzia: 4