Class Events

Implements

Events

Index

Constructors

Methods

clear dispatch emit listen off on unlisten

Constructors

constructor

new Events(): Events
Returns Events

Methods

clear

clear(): void
Clear all event listeners

Returns void
Implementation of IEvents.clear
- Defined in core/kernel/src/tree/events.ts:7

dispatch

dispatch<T>(event: string, data: T): void
Dispatch an event with data
Type Parameters
- T
Parameters
- event: string
  Event name
- data: T
  Event data
Returns void
Implementation of IEvents.dispatch
- Defined in core/kernel/src/tree/events.ts:12

emit

emit<T>(event: string, data: T): void
Alias for dispatch
Type Parameters
- T
Parameters
- event: string
  Event name
- data: T
  Event data
Returns void
Implementation of IEvents.emit
- Defined in core/kernel/src/tree/events.ts:16

listen

listen<T>(event: string, callback: EventCallback<T>): void
Alias for on
Type Parameters
- T
Parameters
- event: string
  Event name
- callback: EventCallback<T>
  Event handler
Returns void
Implementation of IEvents.listen
- Defined in core/kernel/src/tree/events.ts:20

off

off<T>(event: string, callback: EventCallback<T>): void
Remove an event listener
Type Parameters
- T
Parameters
- event: string
  Event name
- callback: EventCallback<T>
  Event handler
Returns void
Implementation of IEvents.off
- Defined in core/kernel/src/tree/events.ts:36

on

on<T>(event: string, callback: EventCallback<T>): void
Add an event listener
Type Parameters
- T
Parameters
- event: string
  Event name
- callback: EventCallback<T>
  Event handler
Returns void
Implementation of IEvents.on
- Defined in core/kernel/src/tree/events.ts:24

unlisten

unlisten<T>(event: string, callback: EventCallback<T>): void
Alias for off
Type Parameters
- T
Parameters
- event: string
  Event name
- callback: EventCallback<T>
  Event handler
Returns void
Implementation of IEvents.unlisten
- Defined in core/kernel/src/tree/events.ts:54