kernel/events/event-bus
Classes
Section titled “Classes”EventBus
Section titled “EventBus”Defined in: app/src/kernel/events/event-bus.ts:34
Publishes typed application events between modules that do not know each other. A failing listener is reported to the error handler and does not stop the others.
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new EventBus(
onError):EventBus
Defined in: app/src/kernel/events/event-bus.ts:39
Parameters
Section titled “Parameters”onError
Section titled “onError”Receives errors thrown by listeners.
Returns
Section titled “Returns”Methods
Section titled “Methods”dispose()
Section titled “dispose()”dispose():
void
Defined in: app/src/kernel/events/event-bus.ts:76
Removes all subscriptions.
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”emit()
Section titled “emit()”emit<
T>(type,payload):void
Defined in: app/src/kernel/events/event-bus.ts:71
Delivers an event to all current subscribers.
Type Parameters
Section titled “Type Parameters”T
Parameters
Section titled “Parameters”EventType<T>
The event type.
payload
Section titled “payload”T
The payload.
Returns
Section titled “Returns”void
on<
T>(type,listener):Disposable
Defined in: app/src/kernel/events/event-bus.ts:49
Subscribes to an event type.
Type Parameters
Section titled “Type Parameters”T
Parameters
Section titled “Parameters”EventType<T>
The event type.
listener
Section titled “listener”Listener<T>
Receives each payload.
Returns
Section titled “Returns”A disposable that unsubscribes.
once()
Section titled “once()”once<
T>(type,listener):Disposable
Defined in: app/src/kernel/events/event-bus.ts:58
Subscribes to the next occurrence of an event type only.
Type Parameters
Section titled “Type Parameters”T
Parameters
Section titled “Parameters”EventType<T>
The event type.
listener
Section titled “listener”Listener<T>
Receives the payload once.
Returns
Section titled “Returns”Interfaces
Section titled “Interfaces”EventType
Section titled “EventType”Defined in: app/src/kernel/events/event-bus.ts:9
A typed application event, such as TabActivated or SettingChanged. The type
parameter is the payload.
Type Parameters
Section titled “Type Parameters”T
Properties
Section titled “Properties”
readonlyname:string
Defined in: app/src/kernel/events/event-bus.ts:11
Name for diagnostics and logs.
Type Aliases
Section titled “Type Aliases”EventErrorHandler
Section titled “EventErrorHandler”EventErrorHandler = (
error,event) =>void
Defined in: app/src/kernel/events/event-bus.ts:28
Receives listener errors of the EventBus.
Parameters
Section titled “Parameters”unknown
EventType<unknown>
Returns
Section titled “Returns”void
Variables
Section titled “Variables”EventBusToken
Section titled “EventBusToken”Defined in: app/src/kernel/events/event-bus.ts:94
Token for the application-wide EventBus.
Functions
Section titled “Functions”defineEvent()
Section titled “defineEvent()”defineEvent<
T>(name):EventType<T>
Defined in: app/src/kernel/events/event-bus.ts:23
Defines a new event type. Event types are compared by identity, not by name.
Type Parameters
Section titled “Type Parameters”T
Parameters
Section titled “Parameters”string
Name for diagnostics, conventionally in PascalCase.
Returns
Section titled “Returns”EventType<T>