rulvar API reference

---

rulvar API reference / @rulvar/core / RunHandle

Interface: RunHandle<R>

Defined in: packages/core/src/engine/run-handle.ts:60

Extended by

• ResumeHandle

Type Parameters

Type Parameter
R

Properties

Property	Type	Defined in
events	AsyncIterable<WorkflowEvent>	packages/core/src/engine/run-handle.ts:63
result	Promise<RunOutcome<R>>	packages/core/src/engine/run-handle.ts:62
runId	string	packages/core/src/engine/run-handle.ts:61

Methods

cancel()

cancel(reason?): Promise<void>;

Defined in: packages/core/src/engine/run-handle.ts:76

Cooperative cancellation; the run settles 'cancelled' with a complete CostReport.

Parameters

Parameter	Type
reason?	string

Returns

Promise<void>

---

on()

on<T>(type, cb): () => void;

Defined in: packages/core/src/engine/run-handle.ts:64

Type Parameters

Type Parameter

T extends | "agent:start" | "agent:error" | "log" | "agent:schema-retry" | "tool:end" | "tool:start" | "agent:stream" | "budget:update" | "run:start" | "run:end" | "phase:start" | "external:waiting" | "approval:pending" | "child:start" | "child:end" | "agent:queued" | "agent:end" | "plan:revised" | "node:parked" | "node:cancelled" | "node:linked" | "orchestrator:woke" | "orchestrator:budget" | "escalation:raised" | "escalation:decided" | "spawn:admitted" | "spawn:rejected" | "verify:failed" | "ledger:op" | "stall:detected" | "guard:oscillation" | "resolution:applied" | "resolution:superseded" | "termination:debit" | "termination:denied" | "termination:config-drift" | "journal:compat"

Parameters

Parameter	Type
type	T
cb	(e) => void

Returns

() => void

---

resolveExternal()

resolveExternal(key, value): Promise<ResolutionOutcome>;

Defined in: packages/core/src/engine/run-handle.ts:74

Resolves an open awaitExternal suspension (DEF-4 signature): applied when this attempt wins the first-closing-wins fold; repeated resolution is defined behavior, not an error. An invalid live payload throws InvalidResolutionError and journals nothing.

Parameters

Parameter	Type
key	string
value	Json

Returns

Promise<ResolutionOutcome>