CKTIS / JavaScript
debounce: erst nach einer Pause ausführen
`debounce` fasst schnell aufeinanderfolgende Aufrufe zusammen. In der gezeigten Variante wird nach einer Pause nur der letzte Aufruf ausgeführt.
Version: User-defined debounce helper using web timers; host timer behavior varies
Syntax
const debounced = debounce(fn, waitMs);
debounced(...args);
debounced.cancel();debounce(fn, waitMs) gibt eine Wrapper-Funktion für fn zurück. Übergib die Funktion fn, nicht das Ergebnis ihres Aufrufs, und eine nichtnegative Wartezeit waitMs in Millisekunden. Erzeuge den Wrapper pro Aufrufquelle nur einmal und verwende ihn erneut, etwa um Ergebnisse nach einer Tipp-Pause zu filtern.
Beim Debouncing am Ende einer Aufruffolge (trailing edge) bricht jeder Aufruf den ausstehenden Timer ab und startet einen neuen. Wenn der Timer schließlich auslöst, läuft fn einmal mit den Argumenten und dem this-Wert des letzten Wrapper-Aufrufs. Folgen die Aufrufe dauerhaft schnell genug aufeinander, läuft fn womöglich gar nicht. Throttling begrenzt dagegen die Ausführungshäufigkeit auch bei fortlaufenden Aufrufen. Die Variante am Anfang der Aufruffolge (leading edge) führt fn beim ersten Aufruf sofort aus; das Beispiel tut das nicht.
Jeder Wrapper hat seinen eigenen Timer. Die gezeigte Methode cancel() verwirft eine ausstehende Ausführung, stoppt aber keine bereits begonnene Arbeit. Der Wrapper gibt sofort undefined zurück, nicht das spätere Ergebnis von fn. Eine von fn im Timer-Callback ausgelöste Ausnahme gelangt nicht zum früheren Aufrufer des Wrappers zurück.
debounce und die Methode cancel() werden im Beispiel definiert, nicht in ECMAScript oder einem Webstandard. Die Versionsangabe bezieht sich auf die Standards, die das Beispiel nutzt, nicht auf die Hilfsfunktion selbst. Das Beispiel nutzt setTimeout und clearTimeout der Laufzeitumgebung. Wähle waitMs im Wertebereich, den die Timer der Laufzeitumgebung unterstützen: Ein zu großer Wert kann als wesentlich kürzere Wartezeit behandelt werden. Der Timer kann später als angefordert auslösen. Prüfe außerhalb eines Browsers, ob und wie die Laufzeitumgebung Timer bereitstellt.
Beispiele
(() => {
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');
})();Ergebnis
Search: cat
Führe den gesamten Code auf einmal in der Browserkonsole aus. Die drei Aufrufe erfolgen synchron, daher führt nur der letzte zur Ausgabe `Search: cat`. Die 100 ms garantieren keinen exakten Ausführungszeitpunkt.
Zugehörige Lektionen
- JavaScript · Lektion 21 · Grundlagen · Version: 4