EventDispatcher\<EventTypes, Context\>
Class: EventDispatcher<EventTypes, Context>
Section titled “Class: EventDispatcher<EventTypes, Context>”Defined in: events.ts:42
Extended by
Section titled “Extended by”Type Parameters
Section titled “Type Parameters”EventTypes
Section titled “EventTypes”EventTypes extends ValidEventTypes = string | symbol
Context
Section titled “Context”Context = any
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new EventDispatcher<
EventTypes,Context>():EventDispatcher<EventTypes,Context>
Returns
Section titled “Returns”EventDispatcher<EventTypes, Context>
Methods
Section titled “Methods”dispatch()
Section titled “dispatch()”dispatch<
T>(eventName, …args):boolean
Defined in: events.ts:105
Type Parameters
Section titled “Type Parameters”T extends string | symbol
Parameters
Section titled “Parameters”eventName
Section titled “eventName”T
…Parameters<EventListener<EventTypes, T>>
Returns
Section titled “Returns”boolean
emit()
Section titled “emit()”emit<
T>(eventName, …args):boolean
Defined in: events.ts:98
Type Parameters
Section titled “Type Parameters”T extends string | symbol
Parameters
Section titled “Parameters”eventName
Section titled “eventName”T
…Parameters<EventListener<EventTypes, T>>
Returns
Section titled “Returns”boolean
off<
T>(eventName,listener,context?,once?):void
Defined in: events.ts:78
Type Parameters
Section titled “Type Parameters”T extends string | symbol
Parameters
Section titled “Parameters”eventName
Section titled “eventName”T
listener
Section titled “listener”EventListener<EventTypes, T>
context?
Section titled “context?”Context
boolean
Returns
Section titled “Returns”void
offref()
Section titled “offref()”offref<
T>(ref):void
Defined in: events.ts:87
Type Parameters
Section titled “Type Parameters”T extends string | symbol
Parameters
Section titled “Parameters”EventRef<EventTypes, T>
Returns
Section titled “Returns”void
on<
T>(eventName,listener,context?):EventRef<EventTypes,T,Context>
Defined in: events.ts:48
Type Parameters
Section titled “Type Parameters”T extends string | symbol
Parameters
Section titled “Parameters”eventName
Section titled “eventName”T
listener
Section titled “listener”EventListener<EventTypes, T>
context?
Section titled “context?”Context
Returns
Section titled “Returns”EventRef<EventTypes, T, Context>
once()
Section titled “once()”once<
T>(eventName,listener,context?):EventRef<EventTypes,T,Context>
Defined in: events.ts:63
Type Parameters
Section titled “Type Parameters”T extends string | symbol
Parameters
Section titled “Parameters”eventName
Section titled “eventName”T
listener
Section titled “listener”EventListener<EventTypes, T>
context?
Section titled “context?”Context
Returns
Section titled “Returns”EventRef<EventTypes, T, Context>
trigger()
Section titled “trigger()”trigger<
T>(eventName, …args):boolean
Defined in: events.ts:91
Type Parameters
Section titled “Type Parameters”T extends string | symbol
Parameters
Section titled “Parameters”eventName
Section titled “eventName”T
…Parameters<EventListener<EventTypes, T>>
Returns
Section titled “Returns”boolean
tryTrigger()
Section titled “tryTrigger()”tryTrigger<
T>(evt, …args):void
Defined in: events.ts:112
Type Parameters
Section titled “Type Parameters”T extends string | symbol
Parameters
Section titled “Parameters”EventRef<EventTypes, T>
…Parameters<EventListener<EventTypes, T>>
Returns
Section titled “Returns”void