Baza wiedzyCentrum egzaminacyjne
PLPolski
Wybierz język13

CKTIS / JavaScript

IdleDeadline: przyczyna wywołania i pozostały czas bezczynności

`didTimeout` mówi, dlaczego uruchomiono funkcję zwrotną, a `timeRemaining()` szacuje, ile milisekund pozostało w bieżącym okresie bezczynności.

Wersja: ECMAScript 2024 and the current web platform; runtime support varies

Składnia

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

Przeglądarka przekazuje obiekt IdleDeadline jako argument funkcji zwrotnej zarejestrowanej przez window.requestIdleCallback(). Jest to API platformy webowej dostępne w kontekście Window, a nie część ECMAScript 2024. Nie jest dostępne w Web Workerach, a obsługa zależy od przeglądarki. Sprawdź dostępność przed wywołaniem.

deadline.didTimeout to właściwość logiczna tylko do odczytu. true oznacza, że funkcję wywołano z powodu upływu opcjonalnego limitu timeout; false oznacza wywołanie w ramach okresu bezczynności. Gdy limit upłynie, a funkcja nie została jeszcze wywołana, przeglądarka kolejkuje zadanie, które ją uruchomi. Nie przerywa to wykonywanego kodu ani nie gwarantuje punktualnego startu. Bez limitu oczekiwanie może długo potrwać.

deadline.timeRemaining() to metoda bez argumentów. Zwraca nieujemne oszacowanie pozostałego czasu bezczynności w milisekundach, również z częścią ułamkową. Przy didTimeout === true zwraca 0, ale 0 może też oznaczać wyczerpanie czasu przy didTimeout === false. Nie traktuj wyniku jako czasu zarezerwowanego dla kodu ani jako licznika do upływu timeout. Sprawdzaj go w trakcie bieżącego wywołania, zamiast polegać na nim po await.

Dziel pracę na małe porcje i sprawdzaj timeRemaining() > 0 przed każdą z nich. Jeśli wywołanie nastąpiło z powodu upływu limitu, wykonaj co najwyżej małą, niezbędną porcję i zaplanuj resztę na kolejne wywołanie. Warunek pętli oparty na || deadline.didTimeout może opróżnić całą kolejkę mimo braku czasu bezczynności.

Przykłady

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

Wynik

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

W Node.js przykład wypisuje wszystkie cztery wiersze w podanej kolejności. Trzy pierwsze pochodzą z wywołań z testowymi obiektami zastępującymi `IdleDeadline`, a czwarty ze sprawdzenia obiektu bez API. To nie jest test planowania zadań przez przeglądarkę. Po wklejeniu kodu do konsoli deweloperskiej strony program wypisze tylko jeden wiersz: jeden z pierwszych trzech asynchronicznie, jeśli API jest dostępne, albo czwarty od razu. Ustawienie 100 ms nie wymusza wywołania po upływie limitu.

Powiązane lekcje

  • JavaScript · Lekcja 6 · Zaawansowany · Wersja: 4

Źródła