Graphorin API reference v0.7.0
Graphorin API reference / @graphorin/workflow / / CheckpointMetadata
Interface: CheckpointMetadata
Defined in: packages/core/dist/contracts/checkpoint-store.d.ts
Metadata associated with a checkpoint write. Adapters store this in a sidecar table for efficient listing.
Stable
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
nodeName? | readonly | string | - | packages/core/dist/contracts/checkpoint-store.d.ts |
sessionId? | readonly | string | Session this checkpoint's state belongs to, when known (W-005). The agent runtime stamps it on every HITL-suspend write so a session hard-delete can cascade into workflow_checkpoints / workflow_pending_writes without parsing the opaque state blob. Optional and additive: third-party stores may ignore it, but any store that also implements SessionStoreExt.deleteSession should use it to honour the full erasure contract. | packages/core/dist/contracts/checkpoint-store.d.ts |
source | readonly | "sync" | "exit" | Durability mode that produced this write. The legacy 'async' value was removed (workflow-14 / WF-7 - it was byte-identical to 'sync'); adapters normalize legacy persisted rows to 'sync' at read time. | packages/core/dist/contracts/checkpoint-store.d.ts |
status | readonly | "running" | "suspended" | "completed" | "failed" | "aborted" | - | packages/core/dist/contracts/checkpoint-store.d.ts |
tags? | readonly | readonly string[] | - | packages/core/dist/contracts/checkpoint-store.d.ts |
wakeAt? | readonly | number | W-032: earliest due durable timer among this checkpoint's frontier pauses (epoch ms). The workflow engine stamps it on every suspended write whose frontier holds a timer, so a store's CheckpointStore.listSuspended can enumerate due threads without parsing the opaque tags. Absent on non-timer suspends and on checkpoints written before the field existed - such threads need one manual tick (or a resume) to become driver-visible. | packages/core/dist/contracts/checkpoint-store.d.ts |