SagaBuilderModule
PackageFCQRS
Contains types and functions for building and initializing sagas
Summary
| Name | Signature | Synopsis |
|---|---|---|
| init | init actorApi sagaData userHandleEvent userApplySideEffects userApply originatorFactory sagaName snapshotPolicy | High-level saga initialization that handles all wrapping automatically |
| initSimple | initSimple actorApi sagaData userHandleEvent userApplySideEffects userApply originatorFactory sagaName snapshotPolicy | Simplified saga initialization with unwrapped apply function |
init actorApi sagaData userHandleEvent userApplySideEffects userApply originatorFactory sagaName snapshotPolicy
Member
High-level saga initialization that handles all wrapping automatically
Parameters
| Name | Type | Description |
|---|---|---|
| actorApi | IActor | |
| sagaData | 'SagaData | |
| userHandleEvent | obj -> SagaState<'SagaData, 'UserState option> -> EventAction<'UserState> | |
| userApplySideEffects | SagaState<'SagaData, 'UserState> -> bool -> SagaTransition<'UserState> * ExecuteCommand list | |
| userApply | SagaState<'SagaData, SagaStateWrapper<'UserState, 'TEvent>> -> SagaState<'SagaData, SagaStateWrapper<'UserState, 'TEvent>> | |
| originatorFactory | string -> IEntityRef<obj> | |
| sagaName | string | |
| snapshotPolicy | SnapshotPolicy |
Returns
EntityFac<obj>
initSimple actorApi sagaData userHandleEvent userApplySideEffects userApply originatorFactory sagaName snapshotPolicy
Member
Simplified saga initialization with unwrapped apply function
Parameters
| Name | Type | Description |
|---|---|---|
| actorApi | IActor | |
| sagaData | 'SagaData | |
| userHandleEvent | obj -> SagaState<'SagaData, 'UserState option> -> EventAction<'UserState> | |
| userApplySideEffects | SagaState<'SagaData, 'UserState> -> bool -> SagaTransition<'UserState> * ExecuteCommand list | |
| userApply | SagaState<'SagaData, 'UserState> -> SagaState<'SagaData, 'UserState> | |
| originatorFactory | string -> IEntityRef<obj> | |
| sagaName | string | |
| snapshotPolicy | SnapshotPolicy |
Returns
EntityFac<obj>