Base de connaissancesCentre d’examen
FRFrançais
Choisir la langue13

CKTIS / JavaScript

IdleDeadline : motif de l’appel et temps d’inactivité restant

`didTimeout` indique pourquoi la fonction de rappel s’exécute ; `timeRemaining()` estime en millisecondes le temps d’inactivité encore disponible.

Version : 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 arguments

Le navigateur transmet un objet IdleDeadline à la fonction de rappel enregistrée avec window.requestIdleCallback(). Cette API web est exposée sur Window et ne fait pas partie d’ECMAScript 2024. Elle n’est pas disponible dans les Web Workers et sa prise en charge varie selon le navigateur. Vérifiez sa disponibilité avant de l’appeler.

deadline.didTimeout est une propriété booléenne en lecture seule. true indique un appel dû à l’expiration du délai facultatif timeout ; false indique un appel pendant une période d’inactivité. Si le délai expire avant que la fonction ne soit appelée, le navigateur place une tâche d’appel dans la file. Cela n’interrompt pas le code en cours et ne garantit pas une heure de démarrage précise. Sans délai, l’attente peut être longue.

deadline.timeRemaining() ne prend aucun argument et renvoie une estimation non négative du temps d’inactivité restant, en millisecondes éventuellement fractionnaires. La méthode renvoie 0 si didTimeout === true, mais peut aussi renvoyer 0 si didTimeout === false et que le temps disponible est épuisé. Il ne s’agit ni d’un temps d’exécution réservé ni d’un compte à rebours jusqu’à timeout. Consultez la valeur pendant l’appel en cours plutôt que de vous y fier après un await.

Découpez le travail en petites portions et vérifiez timeRemaining() > 0 avant chacune. Si le délai a déclenché l’appel, traitez au plus une petite portion indispensable et programmez un nouvel appel pour le reste. Une condition de boucle avec || deadline.didTimeout peut vider toute la file même si aucun temps d’inactivité n’est disponible.

Exemples

(() => {
  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({});
})();

Résultat

idle: budget available
idle: no idle budget
timeout: no idle budget
requestIdleCallback unavailable

Sous Node.js, l’exemple affiche les quatre lignes dans l’ordre indiqué. Il utilise des objets de test à la place des objets `IdleDeadline` pour les trois premiers cas, puis un objet dépourvu de l’API pour le dernier. Cela ne teste pas la planification des tâches par le navigateur. Si vous collez le code dans la console de développement d’une page web, il affiche une seule ligne : l’une des trois premières de façon asynchrone si l’API est disponible, ou la quatrième immédiatement sinon. Le réglage de 100 ms ne force pas un appel pour expiration du délai.

Leçons associées

  • JavaScript · Leçon 6 · Avancé · Version : 4

Sources