Skip to content

Graphorin API reference v0.7.0


Graphorin API reference / @graphorin/core / / ReadonlyRunState

Interface: ReadonlyRunState

Defined in: packages/core/src/types/run.ts:178

Read-only projection of RunState handed to tools and hooks via RunContext.state (W-047). Structurally identical to RunState - RunState is assignable to it - but every property is readonly and every array a ReadonlyArray, so typed tool code cannot corrupt run bookkeeping (splice pendingApprovals, flip status, ...). This is a compile-time contract only: there is no runtime freeze. A hand-written mirror (not a generic DeepReadonly): the nested types are already readonly-typed, and keyof-parity with RunState is pinned by type tests.

Stable

Properties

PropertyModifierTypeDescriptionDefined in
agentIdreadonlystring-packages/core/src/types/run.ts:180
currentAgentIdreadonlystring-packages/core/src/types/run.ts:181
error?readonlyRunError-packages/core/src/types/run.ts:202
finishedAt?readonlystring-packages/core/src/types/run.ts:201
handoffsreadonlyreadonly HandoffRecord[]-packages/core/src/types/run.ts:188
idreadonlystring-packages/core/src/types/run.ts:179
messagesreadonlyreadonly Message[]-packages/core/src/types/run.ts:186
pendingApprovalsreadonlyreadonly ToolApproval[]-packages/core/src/types/run.ts:187
pendingSubRuns?readonlyreadonly PendingSubRun[]See RunState.pendingSubRuns.packages/core/src/types/run.ts:199
promotedTools?readonlyreadonly string[]See RunState.promotedTools.packages/core/src/types/run.ts:195
sessionIdreadonlystring-packages/core/src/types/run.ts:182
startedAtreadonlystring-packages/core/src/types/run.ts:200
statusreadonlyRunStatus-packages/core/src/types/run.ts:184
stepsreadonlyreadonly RunStep[]-packages/core/src/types/run.ts:185
taintSummary?readonlyRunTaintSummarySee RunState.taintSummary.packages/core/src/types/run.ts:193
todos?readonlyreadonly TodoItem[]See RunState.todos.packages/core/src/types/run.ts:197
usagereadonlyUsage-packages/core/src/types/run.ts:189
usageByModel?readonlyRunStateUsageByModelSee RunState.usageByModel.packages/core/src/types/run.ts:191
userId?readonlystring-packages/core/src/types/run.ts:183