CKTIS / JavaScript
Escuchas de eventos de un solo uso con `once`
Usa `{ once: true }` para ejecutar la función de escucha como máximo una vez por registro. El registro se elimina antes de llamar a la función.
Versión: Current web platform; runtime support varies
Sintaxis
target.addEventListener(type, listener);
target.addEventListener(type, listener, { once: true });
target.addEventListener(type, listener, useCapture);La opción once de EventTarget.addEventListener va en el objeto de opciones que se pasa como tercer argumento. Con { once: true }, ese registro puede ejecutar la función de escucha como máximo una vez. Si omites once, su valor es false. Pasar true directamente como tercer argumento activa capture, no once.
La API elimina el registro justo antes de llamar a la función. Por tanto, una llamada anidada a dispatchEvent() con un nuevo evento del mismo tipo no puede ejecutar la función a través de ese mismo registro. Si la función lanza una excepción, el registro no se restablece. Si ningún evento llega a la función, once por sí solo no elimina el registro.
En el mismo objeto de destino, volver a llamar a addEventListener() con el mismo tipo de evento, la misma función y el mismo valor de capture deja intacto el registro, aunque cambie once. Para cambiar esa opción, usa primero removeEventListener() con el tipo, la función y el valor de capture correspondientes, y después vuelve a registrar la función.
EventTarget es una API del DOM que proporciona el entorno anfitrión, no una función de ECMAScript 2024. Comprueba que el entorno donde se ejecutará el código admita esta opción.
Ejemplos
{
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}`);
}Resultado
calls: 1
La primera llamada a `dispatchEvent()` ejecuta la función. Ni la llamada anidada ni la posterior vuelven a ejecutarla. Salida esperada: `calls: 1`.
Lecciones relacionadas
- JavaScript · Lección 39 · Avanzado · Versión: 4