CKTIS / JavaScript
IdleDeadline: motivo della chiamata e tempo di inattività residuo
`didTimeout` indica perché viene eseguita la callback; `timeRemaining()` stima quanti millisecondi restano nel periodo di inattività corrente.
Versione: ECMAScript 2024 and the current web platform; runtime support varies
Sintassi
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 argumentsIl browser passa un oggetto IdleDeadline alla callback registrata con window.requestIdleCallback(). È un’API web di Window, non fa parte di ECMAScript 2024. Non è disponibile nei Web Worker e il supporto varia a seconda del browser. Verifica che sia disponibile prima di chiamarla.
deadline.didTimeout è una proprietà booleana di sola lettura. true indica che la callback è in esecuzione perché è scaduto il timeout facoltativo; false indica che è stata chiamata durante un periodo di inattività. Se il timeout scade prima che la callback venga eseguita, il browser accoda un’attività per chiamarla. Questo non interrompe il codice in esecuzione né garantisce un istante di avvio preciso. Senza timeout, l’attesa può essere lunga.
deadline.timeRemaining() non accetta argomenti e restituisce una stima non negativa del tempo di inattività residuo, in millisecondi anche frazionari. Restituisce 0 se didTimeout === true, ma può restituire 0 anche se didTimeout === false e il tempo disponibile è esaurito. La stima non rappresenta né tempo di esecuzione riservato né un conto alla rovescia fino al timeout. Consultala durante la callback corrente invece di farvi affidamento dopo un await.
Dividi il lavoro in piccole porzioni e controlla timeRemaining() > 0 prima di ciascuna. Se la chiamata è dovuta alla scadenza, esegui al massimo una piccola porzione indispensabile e pianifica un’altra callback per il resto. Una condizione di ciclo con || deadline.didTimeout può svuotare l’intera coda anche se non c’è tempo di inattività disponibile.
Esempi
(() => {
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({});
})();Risultato
idle: budget available idle: no idle budget timeout: no idle budget requestIdleCallback unavailable
In Node.js l’esempio stampa tutte e quattro le righe nell’ordine indicato. Usa oggetti di test al posto degli oggetti `IdleDeadline` per i primi tre casi e un oggetto senza l’API per l’ultimo. Questo non verifica come il browser pianifica le attività. Se incolli il codice nella console di sviluppo di una pagina del browser, viene stampata una sola riga: una delle prime tre in modo asincrono se l’API è disponibile, oppure subito la quarta in caso contrario. Impostare 100 ms non forza il ramo di scadenza.
Lezioni correlate
- JavaScript · Lezione 6 · Avanzato · Versione: 4