Class DomEventHost<EventMap>

Wraps an EventTarget with a ReadonlyEventHost interface.

Type Parameters

  • EventMap

Hierarchy (view full)

Implements

Constructors

constructor

Properties

eventTarget

Methods

dispose hasAnyListeners hasListeners on

Constructors

constructor

Properties

Protected ReadonlyeventTarget

eventTarget: EventTarget

Methods

dispose

  • dispose(): void

  • Disposal of a DomEventHost removes all listeners.

    Returns void

hasAnyListeners

  • hasAnyListeners(): boolean

  • Returns true if the event host has any listeners.

    Returns boolean

hasListeners

  • hasListeners(type): boolean

  • Returns true if the event host has any listeners for the given type.

    Parameters

    • type: {
          [P in string]: Pick<EventMap, keyof EventMap & string>[P] extends Event
              ? P
              : never
      }[keyof EventMap & string]

    Returns boolean

on

  • on<K>(type, handler, options?): Unsubscribe

  • Adds an event handler for the given typed event.

    Type Parameters

    • K extends string

    Parameters

    • type: K

      A case-sensitive string representing the event type to listen for.

    • handler: EventHandler<DomEventMap<EventMap>[K]>

      A callback to invoke when the event with the given type is dispatched.

    • Optionaloptions: DomEventListenerOptions

      An options object specifies characteristics about the event listener.

    Returns Unsubscribe

    Returns a method, when invoked, removes the handler.

Settings

Member Visibility

On This Page

Constructors
Properties
Methods