register-event-listeners

Index

Interfaces

EventMap

Type aliases

Functions

registerEventListeners

Type aliases

EventHandler

EventHandler<EventName>: EventName extends keyof EventMap ? EventHandlerSignature<EventName> | EventListenerOrEventListenerObject : EventListenerOrEventListenerObject | null

Type parameters

EventName: EventType

EventListener

EventListener<E>: [E extends NonEmptyString<E> ? E : never, EventHandler<E>, ListenerOptions?]

Type parameters

E: EventType

EventListeners

EventListeners<E>: EventListener<E>[]

Type parameters

E: EventType

EventType

EventType: LiteralUnion<keyof EventMap, string>

In other word, Event name. e.g.'scroll', 'touchmove'…

ListenerOptions

ListenerOptions: boolean | AddEventListenerOptions

Functions

Const registerEventListeners

registerEventListeners<K>(eventTarget: EventTarget, eventListeners: "" extends K ? EventListeners<EventType> : EventListeners<K>): { register: () => void; unRegister: () => void }

- Defined in src/registerEventListeners.ts:12
Type parameters
- K: EventType
Parameters
- eventTarget: EventTarget
- eventListeners: "" extends K ? EventListeners<EventType> : EventListeners<K>
Returns { register: () => void; unRegister: () => void }
- register: () => void
  - - (): void
    - Returns void
- unRegister: () => void
  - - (): void
    - Returns void

Index

Interfaces

Type aliases

Functions

Type aliases

EventHandler

Type parameters

EventName: EventType

EventListener

Type parameters

E: EventType

EventListeners

Type parameters

E: EventType

EventType

ListenerOptions

Functions

Const registerEventListeners

Type parameters

K: EventType

Parameters

eventTarget: EventTarget

eventListeners: "" extends K ? EventListeners<EventType> : EventListeners<K>

Returns { register: () => void; unRegister: () => void }

register: () => void

Returns void

unRegister: () => void

Returns void