База знанияИзпитен център
BGБългарски
Избери език13

CKTIS / JavaScript

IdleDeadline: причина за извикването и оставащо свободно време

`didTimeout` показва защо е извикана функцията за обратно извикване, а `timeRemaining()` оценява колко милисекунди остават в текущия период на бездействие.

Версия: ECMAScript 2024 and the current web platform; runtime support varies

Синтаксис

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

Браузърът подава обект IdleDeadline на функцията за обратно извикване, регистрирана чрез window.requestIdleCallback(). Това е уеб API в контекста на Window, а не част от ECMAScript 2024. Не е достъпно в Web Workers, а поддръжката зависи от браузъра. Проверете дали API е налично, преди да го извикате.

deadline.didTimeout е булево свойство само за четене. true означава, че функцията се изпълнява заради изтичане на незадължителния срок timeout; false означава, че е извикана през период на бездействие. Ако срокът изтече, преди функцията да се изпълни, браузърът добавя в опашката задача за извикването ѝ. Това не прекъсва изпълняващия се код и не гарантира точен момент на започване. Без срок чакането може да е дълго.

deadline.timeRemaining() не приема аргументи и връща неотрицателна оценка на оставащото свободно време в милисекунди, включително части от милисекундата. Връща 0 при didTimeout === true, но може да върне 0 и при didTimeout === false, ако свободното време е изчерпано. Оценката не е нито запазено време за изпълнение, нито обратно броене до изтичане на timeout. Четете я по време на текущото извикване и не разчитайте на нея след await.

Разделете работата на малки части и проверявайте timeRemaining() > 0 преди всяка. При извикване заради изтекъл срок изпълнете най-много една малка необходима част и насрочете ново извикване за останалото. Условие на цикъл с || deadline.didTimeout може да изпразни цялата опашка, дори да няма свободно време.

Примери

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

Резултат

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

В Node.js примерът извежда и четирите реда в посочения ред. За първите три случая използва тестови обекти вместо обекти `IdleDeadline`, а за последния — обект без API. Това не проверява как браузърът планира задачите. Ако поставите кода в конзолата за разработчици на страница в браузъра, програмата извежда само един ред: асинхронно един от първите три при поддръжка на API или веднага четвъртия при липса на поддръжка. Настройката от 100 ms не налага извикване заради изтекъл срок.

Свързани уроци

  • JavaScript · Урок 6 · Напреднало · Версия: 4

Източници