API reference / @node-ts/bus-test / TestFunctionRoundTripWorkflowState
Class: TestFunctionRoundTripWorkflowState
Defined in: bus-test/src/helpers/test-function-round-trip-workflow-state.ts:8
The state of a workflow declared with defineWorkflow, with nested types, used to check that its state survives a round trip through a persistence
Extends
Constructors
Constructor
ts
new TestFunctionRoundTripWorkflowState(): TestFunctionRoundTripWorkflowState;Returns
TestFunctionRoundTripWorkflowState
Inherited from
Properties
| Property | Modifier | Type | Default value | Description | Overrides | Inherited from | Defined in |
|---|---|---|---|---|---|---|---|
$name | public | string | TestFunctionRoundTripWorkflowState.NAME | A 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-function-round-trip-workflow-state.ts:10 |
$status | public | WorkflowStatus | undefined | Marks if the workflow is currently running or has ended | - | WorkflowState.$status | bus-core/dist/workflow/workflow-state.d.ts:32 |
$version | public | number | undefined | Used 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.$version | bus-core/dist/workflow/workflow-state.d.ts:28 |
$workflowId | public | string | undefined | Unique identifier of the workflow state | - | WorkflowState.$workflowId | bus-core/dist/workflow/workflow-state.d.ts:23 |
checkpoints | public | Date[] | undefined | - | - | - | bus-test/src/helpers/test-function-round-trip-workflow-state.ts:18 |
customer | public | TestCustomer | undefined | - | - | - | bus-test/src/helpers/test-function-round-trip-workflow-state.ts:16 |
orderId | public | string | undefined | - | - | - | bus-test/src/helpers/test-function-round-trip-workflow-state.ts:12 |
startedAt | public | Date | undefined | - | - | - | bus-test/src/helpers/test-function-round-trip-workflow-state.ts:14 |
NAME | static | string | '@node-ts/bus-test/test-function-round-trip-workflow-state' | - | - | - | bus-test/src/helpers/test-function-round-trip-workflow-state.ts:9 |