Base di conoscenzaCentro esami
ITItaliano
Scegli la lingua13

CKTIS / JavaScript

Listener di eventi monouso con `once`

Usa `{ once: true }` per invocare la callback al massimo una volta per registrazione. La registrazione viene rimossa prima della chiamata.

Versione: Current web platform; runtime support varies

Sintassi

target.addEventListener(type, listener);
target.addEventListener(type, listener, { once: true });
target.addEventListener(type, listener, useCapture);

L’opzione once di EventTarget.addEventListener fa parte dell’oggetto delle opzioni passato come terzo argomento. Con { once: true }, la callback può essere invocata al massimo una volta per quella registrazione. Omettere once equivale a usare false. Passare direttamente true come terzo argomento imposta capture, non once.

L’API rimuove la registrazione appena prima di invocare la callback. Una chiamata annidata a dispatchEvent() con un nuovo evento dello stesso tipo non può quindi invocare la callback tramite la stessa registrazione. Se la callback solleva un’eccezione, la registrazione non viene ripristinata. Se nessun evento raggiunge la callback, once da solo non rimuove la registrazione.

Sullo stesso oggetto di destinazione, richiamare addEventListener() con lo stesso tipo di evento, la stessa callback e lo stesso valore di capture lascia invariata la registrazione, anche se cambia once. Per modificare l’opzione, usa prima removeEventListener() con il tipo, la callback e il valore di capture corrispondenti, poi registra di nuovo la callback.

EventTarget è un’API del DOM fornita dall’ambiente host e non fa parte di ECMAScript 2024. Controlla che l’ambiente in cui eseguirai il codice supporti l’opzione.

Esempi

{
  const target = new EventTarget();
  let calls = 0;

  target.addEventListener("ready", () => {
    calls += 1;
    if (calls === 1) target.dispatchEvent(new Event("ready"));
  }, { once: true });

  target.dispatchEvent(new Event("ready"));
  target.dispatchEvent(new Event("ready"));
  console.log(`calls: ${calls}`);
}

Risultato

calls: 1

La prima chiamata a `dispatchEvent()` invoca la callback. Né la chiamata annidata né quella successiva la invocano di nuovo. Output atteso: `calls: 1`.

Lezioni correlate

  • JavaScript · Lezione 39 · Avanzato · Versione: 4

Fonti