Baza znanjaCentar za ispite
HRHrvatski
Odaberi jezik13

CKTIS / JavaScript

IdleDeadline: razlog poziva i preostalo vrijeme mirovanja

`didTimeout` pokazuje zašto se izvršava povratna funkcija, a `timeRemaining()` procjenjuje koliko je milisekundi preostalo u trenutačnom razdoblju mirovanja.

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

Sintaksa

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

Preglednik predaje objekt IdleDeadline povratnoj funkciji registriranoj s window.requestIdleCallback(). To je web API u kontekstu Window, a ne dio ECMAScripta 2024. Nije dostupan u okruženju Web Workers, a podrška ovisi o pregledniku. Prije poziva provjeri je li API dostupan.

deadline.didTimeout je logičko svojstvo samo za čitanje. true znači da se funkcija izvršava zbog isteka neobaveznog roka timeout; false znači da je pozvana tijekom razdoblja mirovanja. Istekne li rok prije izvršavanja funkcije, preglednik stavlja zadatak za njezin poziv u red čekanja. Time se ne prekida izvršavanje postojećeg koda niti se jamči točan trenutak početka. Bez roka čekanje može dugo trajati.

deadline.timeRemaining() ne prima argumente i vraća nenegativnu procjenu preostalog vremena mirovanja u milisekundama, koje mogu imati razlomljeni dio. Vraća 0 kad je didTimeout === true, ali može vratiti 0 i kad je didTimeout === false, ako je raspoloživo vrijeme potrošeno. Procjena nije rezervirano vrijeme za izvršavanje ni odbrojavanje do isteka timeout. Očitaj je tijekom trenutačnog poziva i ne oslanjaj se na nju nakon await.

Podijeli posao na male dijelove i prije svakoga provjeri timeRemaining() > 0. Ako je poziv posljedica isteka roka, izvrši najviše jedan mali nužni dio i zakaži novi poziv za ostatak. Uvjet petlje s || deadline.didTimeout može isprazniti cijeli red čekanja čak i kad nema vremena mirovanja.

Primjeri

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

Rezultat

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

U okruženju Node.js primjer ispisuje sva četiri retka navedenim redoslijedom. Za prva tri slučaja koristi testne objekte umjesto objekata `IdleDeadline`, a za posljednji objekt bez API-ja. Time se ne provjerava kako preglednik raspoređuje zadatke. Ako zalijepiš kôd u razvojnu konzolu stranice u pregledniku, program ispisuje samo jedan redak: jedan od prva tri asinkrono uz podršku za API ili četvrti odmah ako podrške nema. Postavka od 100 ms ne prisiljava program da odabere granu za istek roka.

Povezane lekcije

  • JavaScript · Lekcija 6 · Napredno · Verzija: 4

Izvori