Documentation / base / IEventTarget
Interface: IEventTarget<T>
Defined in: libs/base/src/event.ts:50
The event target interface
Extended by
Type Parameters
T
T extends EventMap = any
Properties
[EventMapType]?
readonlyoptional[EventMapType]?:T
Defined in: libs/base/src/event.ts:54
Type-only event map marker.
Methods
on()
on<
K>(type,listener,context?):void
Defined in: libs/base/src/event.ts:61
Sets up a function that will be called whenever the specified event is delivered to the target
Type Parameters
K
K extends string | number | symbol
Parameters
type
K
The event type to listen for
listener
EventListener<T, K>
The callback function
context?
unknown
Context object of the listener function
Returns
void
once()
once<
K>(type,listener,context?):void
Defined in: libs/base/src/event.ts:68
Sets up a function that will be called only once when the specified event is delivered to the target
Type Parameters
K
K extends string | number | symbol
Parameters
type
K
The event type to listen for
listener
EventListener<T, K>
The callback function
context?
unknown
Context object of the listener function
Returns
void
off()
off<
K>(type,listener?,context?):void
Defined in: libs/base/src/event.ts:74
Removes an event listener function previously registered.
Type Parameters
K
K extends string | number | symbol
Parameters
type
K
The event type for which to remove an event listener
listener?
The callback function to be removed
context?
unknown
Returns
void
dispatchEvent()
dispatchEvent<
K>(type, ...args):void
Defined in: libs/base/src/event.ts:80
Synchronously invoke the affected event listeners with an event object
Type Parameters
K
K extends string | number | symbol
Parameters
type
K
args
...T[K]
Returns
void
false if the event was canceled, otherwise true