Base di conoscenzaCentro esami
ITItaliano
Scegli la lingua13

CKTIS / JavaScript

debounce: eseguire dopo una pausa

`debounce` raggruppa più chiamate ravvicinate in una sola. Nella variante mostrata, dopo una pausa viene eseguita solo l’ultima chiamata.

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

Sintassi

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

debounce(fn, waitMs) restituisce una funzione wrapper per fn. Passa la funzione fn, non il risultato di una sua chiamata, e un ritardo waitMs non negativo in millisecondi. Crea il wrapper una volta per ogni fonte di chiamate e riutilizzalo, per esempio per filtrare i risultati quando chi digita si ferma per un momento.

Nella variante di fine sequenza (trailing edge), ogni chiamata annulla il timer in attesa e ne avvia uno nuovo. Quando il timer scatta, fn viene eseguita una sola volta con gli argomenti e il valore di this dell’ultima chiamata al wrapper. Se le chiamate continuano ad arrivare abbastanza rapidamente, fn potrebbe non essere mai eseguita. Il throttling, invece, limita la frequenza di esecuzione anche mentre le chiamate continuano. La variante di inizio sequenza (leading edge) esegue fn subito alla prima chiamata; l’esempio non lo fa.

Ogni wrapper ha un proprio timer. Il metodo cancel() mostrato annulla un’esecuzione in attesa, ma non ferma un lavoro già iniziato. Il wrapper restituisce subito undefined, non il risultato successivo di fn. Un’eccezione lanciata da fn nella callback del timer non si propaga al codice che aveva chiamato il wrapper.

debounce e il suo metodo cancel() sono definiti nell’esempio, non da ECMAScript o da uno standard web. L’indicazione della versione si riferisce agli standard su cui si basa l’esempio, non alla funzione stessa. L’esempio usa setTimeout e clearTimeout forniti dall’ambiente ospitante. Scegli un valore di waitMs nell’intervallo supportato dai timer dell’ambiente: un valore troppo alto può essere interpretato come un ritardo molto più breve. Il timer può scattare più tardi del previsto. Fuori dal browser, verifica se e come l’ambiente di esecuzione fornisce i timer.

Esempi

(() => {
  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');
})();

Risultato

Search: cat

Esegui tutto il codice in una volta nella console del browser. Le tre chiamate sono sincrone, quindi solo l’ultima produce la riga `Search: cat`. I 100 ms non garantiscono un momento esatto di esecuzione.

Lezioni correlate

  • JavaScript · Lezione 21 · Base · Versione: 4

Fonti