WorkflowsModule

PackageFCQRS.Workflows
Registers workflows with an actor system.

Summary

NameSignatureSynopsis
registerregister api definitionRegisters the workflow and returns its handle.
signalsignal handle id name payloadStores the signal `name` with a typed payload for the instance `id`.

register

register api definition
Member
Registers the workflow and returns its handle. Instances that were running when the process last stopped resume as soon as this is called.

Parameters

NameTypeDescription
apiIActor
definitionWorkflowDefinition<'Input, 'Result>

Returns

WorkflowHandle<'Input, 'Result>

signal

signal handle id name payload
Member
Stores the signal `name` with a typed payload for the instance `id`.

Parameters

NameTypeDescription
handleWorkflowHandle<'Input, 'Result>
idstring
namestring
payload'Signal

Returns

Async<unit>