Graphorin API reference v0.15.1
Graphorin API reference / @graphorin/workflow / / WorkflowState
Interface: WorkflowState<TState>
Defined in: packages/workflow/src/types.ts:362
Stable
Snapshot returned by Workflow.getState. Combines the most recent checkpoint state with the high-level run status / pending pause payload.
Type Parameters
| Type Parameter | Default type |
|---|---|
TState extends object | Record<string, unknown> |
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
checkpointId | readonly | string | - | packages/workflow/src/types.ts:367 |
pendingPause? | readonly | PendingPauseRecord | Carries the value passed to pause(value) when status is suspended. | packages/workflow/src/types.ts:369 |
pendingPauses? | readonly | readonly PendingPauseRecord[] | The FULL pending-pause set from the persisted frontier - parallel pausers, durable timers (wakeAt), awakeables and approvals (name) included. pendingPause remains the first entry for backwards compatibility. | packages/workflow/src/types.ts:376 |
state | readonly | TState | - | packages/workflow/src/types.ts:366 |
status | readonly | "running" | "suspended" | "completed" | "failed" | "aborted" | - | packages/workflow/src/types.ts:365 |
stepNumber | readonly | number | - | packages/workflow/src/types.ts:364 |
threadId | readonly | string | - | packages/workflow/src/types.ts:363 |