CKTIS / JavaScript
IdleDeadline: důvod volání a zbývající čas nečinnosti
`didTimeout` říká, proč se zpětné volání spustilo; `timeRemaining()` odhaduje, kolik milisekund zbývá v aktuálním období nečinnosti.
Verze: ECMAScript 2024 and the current web platform; runtime support varies
Syntaxe
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 argumentsProhlížeč předá objekt IdleDeadline funkci zpětného volání zaregistrované pomocí window.requestIdleCallback(). Jde o webové API v kontextu Window, nikoli o součást ECMAScriptu 2024. Ve Web Workerech není dostupné a podpora se liší podle prohlížeče. Před voláním dostupnost ověřte.
deadline.didTimeout je booleovská vlastnost pouze pro čtení. true znamená, že volání vyvolalo vypršení volitelné lhůty timeout; false znamená, že k volání došlo v období nečinnosti. Pokud lhůta vyprší dřív, než se funkce spustí, prohlížeč zařadí úlohu pro její spuštění do fronty. Tím se nepřeruší běžící kód ani se nezaručí přesný okamžik spuštění. Bez lhůty může čekání trvat dlouho.
deadline.timeRemaining() nepřijímá žádné argumenty a vrací nezáporný odhad zbývajícího času nečinnosti v milisekundách, případně i ve zlomcích milisekundy. Při didTimeout === true vrací 0, ale 0 může vrátit i při didTimeout === false, pokud už dostupný čas vypršel. Odhad není rezervovaný čas na běh kódu ani odpočet do vypršení timeout. Čtěte ho během aktuálního volání, nespoléhejte na něj po await.
Rozdělte práci na malé části a před každou ověřte timeRemaining() > 0. Při volání po vypršení lhůty proveďte nejvýše jednu malou nezbytnou část a pro zbytek naplánujte další volání. Podmínka cyklu s || deadline.didTimeout může vyprázdnit celou frontu, i když nezbývá žádný čas nečinnosti.
Pří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ýsledek
idle: budget available idle: no idle budget timeout: no idle budget requestIdleCallback unavailable
V Node.js příklad vypíše všechny čtyři řádky v uvedeném pořadí. Pro první tři případy používá testovací objekty místo objektů `IdleDeadline` a pro poslední případ objekt bez API. Tím se netestuje plánování úloh v prohlížeči. Po vložení kódu do vývojářské konzole na stránce v prohlížeči program vypíše jediný řádek: s podporou API asynchronně jeden z prvních tří, bez podpory ihned čtvrtý. Nastavení 100 ms nevynutí volání po vypršení lhůty.
Související lekce
- JavaScript · Lekce 6 · Pokročilá · Verze: 4