CKTIS / JavaScript
IdleDeadline: motivo de la llamada y tiempo de inactividad restante
`didTimeout` indica por qué se ejecuta la función de devolución de llamada; `timeRemaining()` estima cuántos milisegundos de inactividad quedan.
Versión: ECMAScript 2024 and the current web platform; runtime support varies
Sintaxis
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 argumentsEl navegador pasa un objeto IdleDeadline a la función de devolución de llamada registrada con window.requestIdleCallback(). Es una API web de Window, no una función de ECMAScript 2024. No está disponible en Web Workers y su compatibilidad varía según el navegador. Comprueba que la API esté disponible antes de llamarla.
deadline.didTimeout es una propiedad booleana de solo lectura. true significa que la llamada se debe al vencimiento del plazo opcional timeout; false significa que se hizo durante un período de inactividad. Si el plazo vence antes de que se ejecute la función, el navegador encola una tarea para llamarla. Esto no interrumpe el código en ejecución ni garantiza una hora de inicio exacta. Sin un plazo, la función puede tardar mucho en ejecutarse.
deadline.timeRemaining() no recibe argumentos y devuelve una estimación no negativa del tiempo de inactividad restante en milisegundos, que pueden ser fraccionarios. Devuelve 0 si didTimeout === true, pero también puede devolver 0 si didTimeout === false y se ha agotado el tiempo disponible. La estimación no reserva tiempo de ejecución ni cuenta hacia atrás hasta timeout. Consúltala durante la llamada actual en lugar de confiar en ella después de un await.
Divide el trabajo en bloques pequeños y comprueba timeRemaining() > 0 antes de cada bloque. Si la llamada se debe al vencimiento del plazo, ejecuta como mucho un bloque pequeño e imprescindible y programa otra llamada para el resto. Una condición de bucle con || deadline.didTimeout puede vaciar toda la cola aunque no quede tiempo de inactividad.
Ejemplos
(() => {
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({});
})();Resultado
idle: budget available idle: no idle budget timeout: no idle budget requestIdleCallback unavailable
En Node.js, el ejemplo muestra las cuatro líneas en el orden indicado. Usa objetos de prueba en lugar de objetos `IdleDeadline` para los tres primeros casos y un objeto sin la API para el último. Esto no comprueba cómo programa las tareas el navegador. Si pegas el código en la consola de desarrollo de una página del navegador, solo muestra una línea: una de las tres primeras de forma asíncrona si la API está disponible, o la cuarta de inmediato si no lo está. Configurar 100 ms no obliga a tomar la rama de vencimiento del plazo.
Lecciones relacionadas
- JavaScript · Lección 6 · Avanzado · Versión: 4