Skip to content

Documentation / @ripl/dom / onDOMEvent

Function: onDOMEvent() ​

onDOMEvent<TElement, TEvent>(element, event, handler, options?): Disposable

Defined in: dom/src/dom.ts:42

Attaches a strongly-typed event listener to a DOM element and returns a disposable for cleanup.

Type Parameters ​

Type Parameter
TElement extends EventTarget
TEvent extends string

Parameters ​

ParameterTypeDescription
elementTElementThe target to listen on.
eventTEventThe event type to listen for.
handlerDOMEventHandler<TElement, TEvent>The listener to invoke.
options?AddEventListenerOptionsNative addEventListener options, e.g. { capture: true, passive: true }.

Returns ​

Disposable

A disposable that removes the listener.