Skip to content

Rulvar API reference


Rulvar API reference / @rulvar/executor / ToolEffectRecord

Interface: ToolEffectRecord

Defined in: packages/executor/src/spi.ts:86

One dispatch's side-effect facts, for the ledger.

Extends

Properties

PropertyTypeDescriptionInherited fromDefined in
argsHashstringsha256 of the canonical arguments: correlates without storing them.ToolEffectIntent.argsHashpackages/executor/src/spi.ts:69
attemptId?stringUnique id of this dispatch ATTEMPT (RV501): the reference executors mint one before the intent row is written and copy it verbatim onto the same attempt's outcome row, so the two phases pair exactly. Optional because rows written before v1.96.0 (and third-party ledgers) may omit it; loadEffectLedger then falls back to the legacy (idempotencyKey, startedAt) join.ToolEffectIntent.attemptIdpackages/executor/src/spi.ts:82
durationMsnumber--packages/executor/src/spi.ts:87
executorIsolatedExecutorTag-ToolEffectIntent.executorpackages/executor/src/spi.ts:70
exitCodenumber | nullChild exit code, or null when terminated by a signal.-packages/executor/src/spi.ts:90
idempotencyKeystringThe stable per-call idempotency key (createEngine derives it).ToolEffectIntent.idempotencyKeypackages/executor/src/spi.ts:64
outcome"timeout" | "error" | "ok"--packages/executor/src/spi.ts:88
runIdstring-ToolEffectIntent.runIdpackages/executor/src/spi.ts:65
signalstring | nullThe terminating signal, when any.-packages/executor/src/spi.ts:92
spanIdstring-ToolEffectIntent.spanIdpackages/executor/src/spi.ts:66
startedAtnumber-ToolEffectIntent.startedAtpackages/executor/src/spi.ts:73
toolstring-ToolEffectIntent.toolpackages/executor/src/spi.ts:67
workdirstringThe ephemeral working directory the dispatch runs in.ToolEffectIntent.workdirpackages/executor/src/spi.ts:72