WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / JavaScript

IdleDeadline: Aufrufgrund und verbleibende Leerlaufzeit

`didTimeout` gibt den Grund für den Callback-Aufruf an. `timeRemaining()` schätzt die verbleibende Zeit der aktuellen Leerlaufphase in Millisekunden.

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

Der Browser übergibt dem mit window.requestIdleCallback() registrierten Callback ein IdleDeadline-Objekt. Die Schnittstelle gehört zur Web-API von Window und nicht zu ECMAScript 2024. Sie steht in Web Workern nicht zur Verfügung und wird nicht von allen Browsern unterstützt. Prüfe deshalb vor dem Aufruf, ob die API verfügbar ist.

deadline.didTimeout ist eine schreibgeschützte boolesche Eigenschaft. true bedeutet, dass der Callback wegen Ablaufs des optionalen timeout ausgeführt wird. false steht für einen Aufruf während einer Leerlaufphase. Läuft die Frist ab, bevor der Callback ausgeführt wurde, stellt der Browser eine Aufgabe für den Aufruf in die Warteschlange. Das unterbricht keinen laufenden Code und garantiert keinen exakten Startzeitpunkt. Ohne Frist kann der Callback lange warten.

deadline.timeRemaining() ist eine Methode ohne Argumente. Sie liefert eine nichtnegative Schätzung der verbleibenden Leerlaufzeit in Millisekunden, auch als Bruchteil einer Millisekunde. Bei didTimeout === true liefert sie 0; bei didTimeout === false kann sie ebenfalls 0 liefern, wenn das Zeitbudget erschöpft ist. Der Wert ist weder reservierte Ausführungszeit noch ein Countdown bis timeout. Frage ihn im aktuellen Callback ab und verlasse dich nach einem await nicht darauf.

Teile die Arbeit in kleine Abschnitte und prüfe vor jedem Abschnitt timeRemaining() > 0. Bei einem Aufruf wegen Fristablaufs erledige höchstens einen kleinen unverzichtbaren Abschnitt und plane für den Rest einen weiteren Callback ein. Eine Schleifenbedingung mit || deadline.didTimeout kann die ganze Warteschlange abarbeiten, obwohl keine Leerlaufzeit verfügbar ist.

Beispiele

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

Ergebnis

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

Unter Node.js gibt das Beispiel alle vier Zeilen in der angegebenen Reihenfolge aus. Für die ersten drei Fälle verwendet es Testobjekte anstelle echter `IdleDeadline`-Objekte, für die vierte Zeile ein Objekt ohne die API. Dabei wird die Aufgabenplanung des Browsers nicht geprüft. Fügst du den Code in die Entwicklerkonsole einer Browserseite ein, gibt das Programm nur eine Zeile aus: mit API-Unterstützung eine der ersten drei asynchron, sonst sofort die vierte. Die Einstellung von 100 ms erzwingt keinen Aufruf wegen Fristablaufs.

Zugehörige Lektionen

  • JavaScript · Lektion 6 · Fortgeschritten · Version: 4

Quellen