CKTIS / JavaScript
debounce : exécuter après une pause
`debounce` regroupe les appels rapprochés. Dans la variante présentée, seul le dernier appel est exécuté, après une pause.
Version : User-defined debounce helper using web timers; host timer behavior varies
Syntaxe
const debounced = debounce(fn, waitMs);
debounced(...args);
debounced.cancel();debounce(fn, waitMs) renvoie une fonction qui enveloppe fn. Passez la fonction fn, et non le résultat de son appel, ainsi qu’un délai waitMs positif ou nul, en millisecondes. Créez cette fonction enveloppe une seule fois par source d’appels et réutilisez-la, par exemple pour filtrer des résultats après une pause dans la saisie.
Dans la variante de fin de série (trailing edge), chaque appel annule le minuteur en attente et en démarre un nouveau. Quand le minuteur se déclenche enfin, fn s’exécute une fois avec les arguments et la valeur de this du dernier appel à la fonction enveloppe. Si les appels restent assez rapprochés, fn peut ne jamais s’exécuter. Le throttling, lui, limite la fréquence d’exécution même si les appels continuent. La variante de début de série (leading edge) exécute fn dès le premier appel ; ce n’est pas le cas de l’exemple.
Chaque fonction enveloppe a son propre minuteur. La méthode cancel() de l’exemple annule une exécution en attente, mais n’arrête pas un travail déjà commencé. La fonction enveloppe renvoie immédiatement undefined, et non le résultat ultérieur de fn. Une exception levée par fn dans le rappel du minuteur ne remonte pas au code qui avait appelé la fonction enveloppe.
La fonction debounce et sa méthode cancel() sont définies dans l’exemple, et non par ECMAScript ou par une norme du Web. L’indication de version concerne les normes sur lesquelles s’appuie l’exemple, et non la fonction elle-même. L’exemple utilise les fonctions setTimeout et clearTimeout fournies par l’environnement hôte. Choisissez une valeur de waitMs dans la plage prise en charge par les minuteurs de cet environnement : une valeur trop élevée peut être interprétée comme un délai bien plus court. Le minuteur peut se déclencher plus tard que prévu. Hors d’un navigateur, vérifiez si l’environnement fournit des minuteurs et comment ils fonctionnent.
Exemples
(() => {
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');
})();Résultat
Search: cat
Exécutez tout le code en une seule fois dans la console du navigateur. Les trois appels sont synchrones : seul le dernier entraîne l’affichage de `Search: cat`. Le délai de 100 ms ne garantit pas un instant d’exécution précis.
Leçons associées
- JavaScript · Leçon 21 · Débutant · Version : 4