Class EventBus

A non-queued bus implementation that executes subscribers immediately in the main thread.

Hierarchy

EventBus
- PropagatingEventBus

Implements

Bus

Index

Constructors

constructor

Properties

subscribers

Methods

Constructors

constructor

new EventBus(): EventBus

Returns EventBus

Properties

Protected subscribers

subscribers: Collection<EventSubscriberEntry<any>> = ...

Collection of subscribers, by their events.

Methods

Protected buildSubscription

buildSubscription(id: string): EventSubscription

- Defined in src/event/EventBus.ts:42
Build an EventSubscription object for the subscriber of the given ID.

Parameters
- id: string
Returns EventSubscription

dispatch

dispatch(event: Dispatchable): Promise<void>

Implementation of Bus.dispatch
- Defined in src/event/EventBus.ts:31
Parameters
- event: Dispatchable
Returns Promise<void>

subscribe

subscribe<T>(event: StaticClass<T, Instantiable<T>>, subscriber: EventSubscriber<T>): Awaitable<EventSubscription>

Implementation of Bus.subscribe
- Defined in src/event/EventBus.ts:16
Type parameters
- T: Dispatchable
Parameters
- event: StaticClass<T, Instantiable<T>>
- subscriber: EventSubscriber<T>
Returns Awaitable<EventSubscription>

unsubscribe

unsubscribe<T>(subscriber: EventSubscriber<T>): Awaitable<void>

Implementation of Bus.unsubscribe
- Defined in src/event/EventBus.ts:27
Type parameters
- T: Dispatchable
Parameters
- subscriber: EventSubscriber<T>
Returns Awaitable<void>

extollo (v. latin) - to lift up, to elevate

Extollo is a free & libre application framework in TypeScript.