CKTIS / JavaScript
debounce: wywołanie po przerwie
Funkcja `debounce` łączy serię szybkich wywołań w jedno. W pokazanym wariancie po przerwie wykonywane jest tylko ostatnie wywołanie.
Wersja: User-defined debounce helper using web timers; host timer behavior varies
Składnia
const debounced = debounce(fn, waitMs);
debounced(...args);
debounced.cancel();debounce(fn, waitMs) zwraca funkcję opakowującą fn. Przekaż funkcję fn, a nie wynik jej wywołania, oraz nieujemne opóźnienie waitMs w milisekundach. Utwórz funkcję opakowującą raz dla danego źródła wywołań i używaj jej ponownie, na przykład do filtrowania wyników po przerwie w pisaniu.
W wariancie na końcu serii (trailing edge) każde wywołanie anuluje oczekujący timer i ustawia nowy. Gdy timer w końcu zadziała, fn wykona się raz z argumentami i wartością this z ostatniego wywołania funkcji opakowującej. Przy nieprzerwanej serii szybkich wywołań fn może w ogóle się nie wykonać. Z kolei throttle ogranicza częstotliwość wykonywania nawet wtedy, gdy wywołania nie ustają. Wariant na początku serii (leading edge) wykonuje fn od razu przy pierwszym wywołaniu; przykład nie działa w ten sposób.
Każda funkcja opakowująca ma własny timer. Pokazana metoda cancel() usuwa oczekujące wywołanie, ale nie zatrzymuje pracy, która już się rozpoczęła. Funkcja opakowująca od razu zwraca undefined, a nie późniejszy wynik fn. Wyjątek zgłoszony przez fn w wywołaniu timera nie trafia do kodu, który wcześniej wywołał funkcję opakowującą.
Funkcję debounce i metodę cancel() definiuje przykład, a nie ECMAScript ani standard platformy webowej. Informacja o wersji odnosi się do standardów, z których korzysta przykład, a nie do samej funkcji pomocniczej. Przykład korzysta z setTimeout i clearTimeout udostępnianych przez środowisko. Wybierz waitMs z zakresu obsługiwanego przez timery w tym środowisku: zbyt duża wartość może zostać potraktowana jako znacznie krótsze opóźnienie. Timer może zadziałać później, niż wynika z podanego opóźnienia. Poza przeglądarką sprawdź dostępność i zachowanie timerów w danym środowisku.
Przykłady
(() => {
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');
})();Wynik
Search: cat
Uruchom cały kod naraz w konsoli przeglądarki. Trzy wywołania następują synchronicznie, więc tylko ostatnie prowadzi do wypisania `Search: cat`. Wartość 100 ms nie gwarantuje dokładnej chwili wykonania.
Powiązane lekcje
- JavaScript · Lekcja 21 · Podstawowy · Wersja: 4