Skip to content

API reference / @node-ts/bus-test / TestRoundTripWorkflowState

Class: TestRoundTripWorkflowState ​

Defined in: bus-test/src/helpers/test-round-trip-workflow-state.ts:8

Workflow state with nested types, used to check that workflow state survives a round trip through a persistence

Extends ​

Constructors ​

Constructor ​

ts
new TestRoundTripWorkflowState(): TestRoundTripWorkflowState;

Returns ​

TestRoundTripWorkflowState

Inherited from ​

WorkflowState.constructor

Properties ​

PropertyModifierTypeDefault valueDescriptionOverridesInherited fromDefined in
$namepublicstringTestRoundTripWorkflowState.NAMEA unique name for the workflow state. This should be formatted in a namespace style, ie: 'company/application/workflow-name' eg: $name = 'node-ts/bus-core/my-workflow'WorkflowState.$name-bus-test/src/helpers/test-round-trip-workflow-state.ts:10
$statuspublicWorkflowStatusundefinedMarks if the workflow is currently running or has ended-WorkflowState.$statusbus-core/dist/workflow/workflow-state.d.ts:32
$versionpublicnumberundefinedUsed to manage concurrency when storing the workflow state. This value is incremented each time the data is persisted which keeps locking of data low.-WorkflowState.$versionbus-core/dist/workflow/workflow-state.d.ts:28
$workflowIdpublicstringundefinedUnique identifier of the workflow state-WorkflowState.$workflowIdbus-core/dist/workflow/workflow-state.d.ts:23
checkpointspublicDate[]undefined---bus-test/src/helpers/test-round-trip-workflow-state.ts:18
customerpublicTestCustomerundefined---bus-test/src/helpers/test-round-trip-workflow-state.ts:16
orderIdpublicstringundefined---bus-test/src/helpers/test-round-trip-workflow-state.ts:12
startedAtpublicDateundefined---bus-test/src/helpers/test-round-trip-workflow-state.ts:14
NAMEstaticstring'@node-ts/bus-test/test-round-trip-workflow-state'---bus-test/src/helpers/test-round-trip-workflow-state.ts:9

Released under the MIT License.