Znalostní bázeCentrum zkoušek
CSČeština
Vybrat jazyk13

CKTIS / JavaScript

debounce: spuštění až po odmlce

`debounce` sloučí sérii rychlých volání do jediného. V uvedené variantě se po odmlce provede pouze poslední volání.

Verze: User-defined debounce helper using web timers; host timer behavior varies

Syntaxe

const debounced = debounce(fn, waitMs);
debounced(...args);
debounced.cancel();

debounce(fn, waitMs) vrátí funkci, která obaluje fn. Předej samotnou funkci fn, ne výsledek jejího volání, a nezápornou prodlevu waitMs v milisekundách. Pro každý zdroj volání vytvoř obalovou funkci jen jednou a používej ji opakovaně, třeba k filtrování výsledků po odmlce v psaní.

Ve variantě na konci série (trailing edge) každé volání zruší čekající časovač a spustí nový. Jakmile časovač doběhne, fn se zavolá jednou s argumenty a hodnotou this z posledního volání obalové funkce. Pokud volání přicházejí stále dost rychle, fn se nemusí spustit vůbec. Naproti tomu throttling omezuje četnost spouštění i při nepřetržitém volání. Varianta na začátku série (leading edge) spouští fn hned při prvním volání; příklad to nedělá.

Každá obalová funkce má vlastní časovač. Metoda cancel() v příkladu zruší čekající spuštění, ale nezastaví práci, která už začala. Obalová funkce ihned vrací undefined, nikoli pozdější výsledek fn. Výjimka vyvolaná funkcí fn v obsluze časovače se nepřenese zpět do kódu, který obalovou funkci dříve zavolal.

Funkci debounce a její metodu cancel() definuje příklad, nikoli ECMAScript ani webový standard. Údaj o verzi se týká standardů, které příklad využívá, nikoli samotné pomocné funkce. Příklad používá setTimeout a clearTimeout poskytované hostitelským prostředím. Zvol waitMs v rozsahu podporovaném časovači tohoto prostředí: příliš vysoká hodnota se může vyhodnotit jako mnohem kratší prodleva. Časovač může doběhnout později, než bylo požadováno. Mimo prohlížeč ověř, zda a jak dané prostředí časovače poskytuje.

Příklady

(() => {
  function debounce(fn, waitMs) {
    let timer;

    function cancel() {
      if (timer !== undefined) {
        clearTimeout(timer);
        timer = undefined;
      }
    }

    function debounced(...args) {
      cancel();
      timer = setTimeout(() => {
        timer = undefined;
        Reflect.apply(fn, this, args);
      }, waitMs);
    }

    debounced.cancel = cancel;
    return debounced;
  }

  const search = {
    prefix: 'Search: ',
    update: debounce(function (query) {
      console.log(this.prefix + query);
    }, 100),
  };

  search.update('c');
  search.update('ca');
  search.update('cat');
})();

Výsledek

Search: cat

Spusť celý kód najednou v konzoli prohlížeče. Tři volání jsou synchronní, takže pouze poslední vede k výpisu `Search: cat`. Prodleva 100 ms nezaručuje přesný okamžik spuštění.

Související lekce

  • JavaScript · Lekce 21 · Základní · Verze: 4

Zdroje