Class EventList<TArgs>

The EventList is a class that can be used to create a list of event listeners that can be invoked

Type Parameters

TArgs extends any = any

Implements

IEventList

Index

Constructors

Properties

Accessors

isInvoking listenerCount

Methods

addEventListener invoke removeAllEventListeners removeEventListener setEventTarget from

Constructors

constructor

new EventList<TArgs extends unknown = any>(
evts?: Function | (Function | CallInfo)[],
): EventList<TArgs>
Type Parameters
- TArgs extends unknown = any
Parameters
- Optionalevts: Function | (Function | CallInfo)[]
Returns EventList<TArgs>

Properties

`Readonly`isEventList

isEventList: true

checked during instantiate to create a new instance

Accessors

isInvoking

get isInvoking(): boolean
If the event is currently being invoked

Returns boolean

listenerCount

get listenerCount(): number
How many callback methods are subscribed to this event

Returns number

Methods

addEventListener

addEventListener(cb: (args: TArgs) => void): Function
Add a new event listener to this event
Parameters
- cb: (args: TArgs) => void
Returns Function

invoke

invoke(...args: TArgs[]): boolean
Invoke all the methods that are subscribed to this event
Parameters
- ...args: TArgs[]
Returns boolean

removeAllEventListeners

removeAllEventListeners(): void
Returns void

removeEventListener

removeEventListener(cb: undefined | null | Function): void
Parameters
- cb: undefined | null | Function
Returns void

setEventTarget

setEventTarget(key: string, target: object): void
set an event target to try invoke the EventTarget dispatchEvent when this EventList is invoked
Parameters
- key: string
- target: object
Returns void

`Static`from

from(...evts: Function[]): EventList<any>
Parameters
- ...evts: Function[]
Returns EventList<any>