CKTIS / JavaScript
debounce: spustenie až po prestávke
`debounce` zlúči sériu rýchlych volaní do jedného. V uvedenom variante sa po prestávke vykoná iba posledné volanie.
Verzia: User-defined debounce helper using web timers; host timer behavior varies
Syntax
const debounced = debounce(fn, waitMs);
debounced(...args);
debounced.cancel();debounce(fn, waitMs) vráti funkciu, ktorá obaľuje fn. Odovzdaj samotnú funkciu fn, nie výsledok jej volania, a nezáporné oneskorenie waitMs v milisekundách. Pre každý zdroj volaní vytvor obaľovaciu funkciu len raz a používaj ju opakovane, napríklad na filtrovanie výsledkov po prestávke v písaní.
Vo variante na konci série (trailing edge) každé volanie zruší čakajúci časovač a spustí nový. Keď časovač napokon uplynie, fn sa zavolá raz s argumentmi a hodnotou this z posledného volania obaľovacej funkcie. Ak volania stále prichádzajú dosť rýchlo, fn sa nemusí spustiť vôbec. Naopak, throttling obmedzuje frekvenciu spúšťania aj vtedy, keď volania pokračujú. Variant na začiatku série (leading edge) spustí fn hneď pri prvom volaní; príklad to nerobí.
Každá obaľovacia funkcia má vlastný časovač. Metóda cancel() v príklade zruší čakajúce spustenie, no nezastaví prácu, ktorá sa už začala. Obaľovacia funkcia ihneď vráti undefined, nie neskorší výsledok fn. Výnimka vyvolaná funkciou fn v obsluhe časovača sa neprenesie späť do kódu, ktorý obaľovaciu funkciu predtým zavolal.
Funkciu debounce a jej metódu cancel() definuje príklad, nie ECMAScript ani webový štandard. Údaj o verzii sa vzťahuje na štandardy, ktoré príklad využíva, nie na samotnú pomocnú funkciu. Príklad používa setTimeout a clearTimeout poskytované hostiteľským prostredím. Zvoľ waitMs v rozsahu, ktorý podporujú časovače tohto prostredia: príliš vysoká hodnota sa môže vyhodnotiť ako oveľa kratšie oneskorenie. Časovač môže uplynúť neskôr, než bolo požadované. Mimo prehliadača over, či a ako dané prostredie poskytuje časovače.
Prí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ýsledok
Search: cat
Spusť celý kód naraz v konzole prehliadača. Tri volania sú synchrónne, takže iba posledné vedie k výpisu `Search: cat`. Oneskorenie 100 ms nezaručuje presný okamih spustenia.
Súvisiace lekcie
- JavaScript · Lekcia 21 · Základná · Verzia: 4