Graphorin API reference v0.1.0
Graphorin API reference / @graphorin/workflow / / WorkflowState
Interface: WorkflowState<TState>
Defined in: packages/workflow/src/types.ts:271
Snapshot returned by Workflow.getState. Combines the most recent checkpoint state with the high-level run status / pending pause payload.
Stable
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:276 |
pendingPause? | readonly | PendingPauseRecord | Carries the value passed to pause(value) when status is suspended. | packages/workflow/src/types.ts:278 |
state | readonly | TState | - | packages/workflow/src/types.ts:275 |
status | readonly | "running" | "suspended" | "completed" | "failed" | - | packages/workflow/src/types.ts:274 |
stepNumber | readonly | number | - | packages/workflow/src/types.ts:273 |
threadId | readonly | string | - | packages/workflow/src/types.ts:272 |