AddEventListenerOptions

interface

interface AddEventListenerOptions extends EventListenerOptions

Options for configuring an event listener via addEventListener.

This interface extends EventListenerOptions and provides additional configuration options to control event listener behavior.

Example

eventTarget.addEventListener('message', handler, {
  once: true,
  passive: true,
  signal: controller.signal
});

Properties

once

once?: boolean

When set to true, the listener will automatically be removed after it has been invoked once.

passive

passive?: boolean

When set to true, indicates that the listener will never call preventDefault(). This provides a performance optimization opportunity for event processing. If a passive listener attempts to call preventDefault(), the call will be ignored and a warning may be generated.

signal

signal?: AbortSignal

An AbortSignal that can be used to remove the event listener when aborted.

Example

const controller = new AbortController();
eventTarget.addEventListener('message', handler, { signal: controller.signal });

// Later, to remove the listener:
controller.abort();