Class DomEventHost<EventMap>

Wraps a js EventTarget with a ReadonlyEventHost interface.

Type Parameters

EventMap

Hierarchy (View Summary)

DomEventHost
- NetworkStateImpl

Implements

Index

Constructors

Properties

Methods

dispose hasAnyListeners hasListeners on

Constructors

constructor

new DomEventHost<EventMap>(eventTarget: EventTarget): DomEventHost<EventMap>
Type Parameters
- EventMap
Parameters
- eventTarget: EventTarget
Returns DomEventHost<EventMap>
- Defined in event/DomEventHost.ts:55

Properties

`Protected` `Readonly`eventTarget

eventTarget: EventTarget

Methods

dispose

dispose(): void
Disposal of a DomEventHost removes all listeners.

Returns void
Implementation of Disposable.dispose
- Defined in event/DomEventHost.ts:92

hasAnyListeners

hasAnyListeners(): boolean
Returns true if the event host has any listeners.

Returns boolean
Implementation of DomReadonlyEventHost.hasAnyListeners
- Defined in event/DomEventHost.ts:57

hasListeners

hasListeners(
    type: {
        [P in string]: Pick<EventMap, keyof EventMap & string>[P] extends Event
            ? P
            : never
    }[keyof EventMap & string],
): 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
Implementation of DomReadonlyEventHost.hasListeners
- Defined in event/DomEventHost.ts:61

on

on<K extends string>(
    type: K,
    handler: EventHandler<DomEventMap<EventMap>[K]>,
    options?: DomEventListenerOptions,
): 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.
Implementation of DomReadonlyEventHost.on
- Defined in event/DomEventHost.ts:65