Class LocalBus<TEvent>

Non-connectable event bus implementation. Can forward events to the main Bus instance.

Type Parameters

TEvent extends Event = Event

Hierarchy

CanonicalItemClass
- LocalBus
  - Model

Implements

EventBus<TEvent>
AwareOfContainerLifecycle

Index

Constructors

Properties

awareOfContainerLifecycle bus isUp logging subscribers subscriptions uuid

Accessors

appClassApplication

Methods

app callSubscribers container down getBoundMethod isConnected make onContainerRelease pipe push shouldBroadcast subscribe up getCanonicalResolver getFullyQualifiedCanonicalResolver setCanonicalResolver

Constructors

constructor

new LocalBus<TEvent>(): LocalBus<TEvent>
Type Parameters
- TEvent extends Event = Event
Returns LocalBus<TEvent>

Inherited from CanonicalItemClass.constructor

Properties

awareOfContainerLifecycle

awareOfContainerLifecycle: true = ...

`Protected` `Readonly` bus

bus: Bus<Event>

`Private` isUp

isUp: boolean = false

True if the bus has been initialized.

`Protected` `Readonly` logging

logging: Logging

`Protected` subscribers

subscribers: Collection<BusSubscriber<TEvent>> = ...

Local listeners subscribed to events on this bus.

`Protected` subscriptions

subscriptions: Collection<BusInternalSubscription> = ...

`Readonly` uuid

uuid: string = ...

Accessors

`Private` appClassApplication

get appClassApplication(): Application
The global application instance.

Returns Application
Inherited from CanonicalItemClass.appClassApplication
- Defined in src/lifecycle/AppClass.ts:31

Methods

`Protected` app

app(): Application
Get the global Application.

Returns Application
Inherited from CanonicalItemClass.app
- Defined in src/lifecycle/AppClass.ts:36

`Protected` callSubscribers

callSubscribers(event: TEvent): Promise<boolean>
Protected
Call all local listeners for the given event. Returns true if the propagation of the event should be halted.
Parameters
- event: TEvent
Returns Promise<boolean>
- Defined in src/support/bus/LocalBus.ts:70

`Protected` container

container(): Container
Get the global Container.

Returns Container
Inherited from CanonicalItemClass.container
- Defined in src/lifecycle/AppClass.ts:41

down

down(): Promise<void>
Clean up this event bus.

Returns Promise<void>
Implementation of EventBus.down
- Defined in src/support/bus/LocalBus.ts:128

getBoundMethod

getBoundMethod(methodName: string): ((...args: any[]) => any)
Get the method with the given name from this class, bound to this class.

Returns
function
Parameters
- methodName: string
Returns ((...args: any[]) => any)
- - (...args: any[]): any
  - Get the method with the given name from this class, bound to this class.
    
    Returns
    function
    Parameters
    - Rest ...args: any[]
    Returns any
Inherited from CanonicalItemClass.getBoundMethod
- Defined in src/lifecycle/AppClass.ts:55

isConnected

isConnected(): boolean
Returns boolean
Implementation of EventBus.isConnected
- Defined in src/support/bus/LocalBus.ts:123

`Protected` make

make<T>(target: any, ...parameters: any[]): T
Call the make() method on the global container.
Type Parameters
- T
Parameters
- target: any
- Rest ...parameters: any[]
Returns T
Inherited from CanonicalItemClass.make
- Defined in src/lifecycle/AppClass.ts:46

onContainerRelease

onContainerRelease(): Awaitable<void>
Called before an instance of a key is released from the container.

Returns Awaitable<void>
Implementation of AwareOfContainerLifecycle.onContainerRelease
- Defined in src/support/bus/LocalBus.ts:141

pipe

pipe<T>(eventKey: StaticInstantiable<T>, line: Pipeline<T, EventHandlerReturn>): Awaitable<EventHandlerSubscription>
Register a pipeline as an event handler.
Type Parameters
- T extends Event
Parameters
- eventKey: StaticInstantiable<T>
- line: Pipeline<T, EventHandlerReturn>
Returns Awaitable<EventHandlerSubscription>
Implementation of EventBus.pipe
- Defined in src/support/bus/LocalBus.ts:79

push

push(event: TEvent): Promise<void>
Push an event onto the bus.
Parameters
- event: TEvent
Returns Promise<void>
Implementation of EventBus.push
- Defined in src/support/bus/LocalBus.ts:36

`Protected` shouldBroadcast

shouldBroadcast(event: TEvent): Promise<boolean>
Returns true if the given event should be pushed to connected event busses.
Parameters
- event: TEvent
Returns Promise<boolean>
- Defined in src/support/bus/LocalBus.ts:56

subscribe

subscribe<T>(eventKey: StaticInstantiable<T>, handler: EventHandler<T>): Promise<EventHandlerSubscription>
Subscribe to an event on the bus.
Type Parameters
- T extends Event
Parameters
- eventKey: StaticInstantiable<T>
- handler: EventHandler<T>
Returns Promise<EventHandlerSubscription>
Implementation of EventBus.subscribe
- Defined in src/support/bus/LocalBus.ts:88

up

up(): Promise<void>
Returns Promise<void>
Implementation of EventBus.up
- Defined in src/support/bus/LocalBus.ts:111

`Static` getCanonicalResolver

getCanonicalResolver(): undefined | string
Get the unqualified canonical resolver of this class, if one has been set.

Returns undefined | string
Inherited from CanonicalItemClass.getCanonicalResolver
- Defined in src/support/CanonicalReceiver.ts:58

`Static` getFullyQualifiedCanonicalResolver

getFullyQualifiedCanonicalResolver(): undefined | string
Get the fully-qualified canonical resolver of this class, if one has been set.

Returns undefined | string
Inherited from CanonicalItemClass.getFullyQualifiedCanonicalResolver
- Defined in src/support/CanonicalReceiver.ts:51

`Static` setCanonicalResolver

setCanonicalResolver(fullyQualifiedResolver: string, unqualifiedResolver: string): void
Sets the fully- and un-qualified canonical resolver strings. Intended for use by the Canonical unit.
Parameters
- fullyQualifiedResolver: string
- unqualifiedResolver: string
Returns void
Inherited from CanonicalItemClass.setCanonicalResolver
- Defined in src/support/CanonicalReceiver.ts:43