Class ActionHub

The main class that runs actions

Index

Constructors

Properties

context events factory publish? saveToStore

Methods

exec getContext run runAction

Constructors

constructor

new ActionHub(
    events: IEventStoreRead & IEventStoreActions,
    factory: EventFactory,
    publish?: PublishMethod,
): ActionHub
Parameters
- events: IEventStoreRead & IEventStoreActions
- factory: EventFactory
- Optionalpublish: PublishMethod
Returns ActionHub
- Defined in action-hub.ts:31

Properties

`Protected`context

context: ActionContext | undefined = undefined

events

events: IEventStoreRead & IEventStoreActions

factory

factory: EventFactory

`Optional`publish

publish?: PublishMethod

saveToStore

saveToStore: boolean = true

Whether to save all events created by actions to the event store

Methods

exec

exec<Args extends any[]>(
Action: ActionConstructor<Args>,
...args: Args,
): Observable<Event>
Run an action without publishing the events
Type Parameters
- Args extends any[]
Parameters
- Action: ActionConstructor<Args>
- ...args: Args
Returns Observable<Event>
- Defined in action-hub.ts:68

`Protected`getContext

getContext(): Promise<ActionContext>
Returns Promise<ActionContext>
- Defined in action-hub.ts:38

run

run<Args extends any[]>(
Action: ActionConstructor<Args>,
...args: Args,
): Promise<void>
Run an action and publish events using the publish method
Type Parameters
- Args extends any[]
Parameters
- Action: ActionConstructor<Args>
- ...args: Args
Returns Promise<void>
- Defined in action-hub.ts:57

`Static`runAction

runAction(ctx: ActionContext, action: Action): Observable<Event>
Runs an action in a ActionContext and converts the result to an Observable
Parameters
- ctx: ActionContext
- action: Action
Returns Observable<Event>
- Defined in action-hub.ts:49