Baza znanjaIzpitno središče
SLSlovenščina
Izberi jezik13

CKTIS / JavaScript

IdleDeadline: razlog za klic in preostali čas nedejavnosti

`didTimeout` pove, zakaj se je izvedla povratna funkcija; `timeRemaining()` oceni, koliko milisekund je še na voljo v trenutnem obdobju nedejavnosti.

Različica: 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

Brskalnik posreduje objekt IdleDeadline povratni funkciji, registrirani z window.requestIdleCallback(). Gre za spletni API v okolju Window, ne za del ECMAScripta 2024. V spletnih delavcih (Web Workers) ni na voljo, podpora pa se med brskalniki razlikuje. Pred klicem preverite razpoložljivost API-ja.

deadline.didTimeout je logična lastnost samo za branje. true pomeni, da se funkcija izvaja zaradi izteka neobveznega roka timeout; false pomeni, da je bila poklicana v obdobju nedejavnosti. Če se rok izteče, preden se funkcija izvede, brskalnik v čakalno vrsto doda opravilo za njen klic. To ne prekine izvajanja obstoječe kode in ne zagotovi točnega časa začetka. Brez roka je lahko čakanje dolgo.

deadline.timeRemaining() ne sprejme argumentov in vrne nenegativno oceno preostalega časa nedejavnosti v milisekundah, tudi z ulomljenim delom. Pri didTimeout === true vrne 0, lahko pa vrne 0 tudi pri didTimeout === false, ko časa ni več. Ocena ne pomeni rezerviranega časa za izvajanje in ne odšteva do izteka timeout. Preberite jo med trenutnim klicem in se nanjo ne zanašajte po await.

Delo razdelite na majhne dele in pred vsakim preverite timeRemaining() > 0. Če je klic sprožil iztek roka, opravite največ en majhen nujni del in za ostalo načrtujte nov klic. Pogoj zanke z || deadline.didTimeout lahko izprazni celotno čakalno vrsto, tudi če ni več časa nedejavnosti.

Primeri

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

V okolju Node.js primer izpiše vse štiri vrstice v navedenem vrstnem redu. Za prve tri primere uporabi testne objekte namesto objektov `IdleDeadline`, za zadnjega pa objekt brez API-ja. S tem ne preverja, kako brskalnik razporeja opravila. Če kodo prilepite v razvijalsko konzolo strani v brskalniku, program izpiše samo eno vrstico: eno od prvih treh asinhrono, če je API podprt, sicer pa takoj četrto. Nastavitev 100 ms ne vsili klica zaradi izteka roka.

Povezane lekcije

  • JavaScript · Lekcija 6 · Napredna · Različica: 4

Viri