Rulvar API reference

---

Rulvar API reference / @rulvar/rulvar / OrchestratorRuntime

Interface: OrchestratorRuntime

Defined in: packages/core/dist/index.d.ts

The engine seam the spawn tools close over (never on ToolContext).

Methods

awaitAll()

awaitAll(handles): Promise<TaskDigest[]>;

Defined in: packages/core/dist/index.d.ts

Parameters

Parameter	Type
handles	number[]

Returns

Promise<TaskDigest[]>

---

awaitAny()

awaitAny(handles): Promise<TaskDigest>;

Defined in: packages/core/dist/index.d.ts

Parameters

Parameter	Type
handles	number[]

Returns

Promise<TaskDigest>

---

cancel()

cancel(handle, reason?): Promise<{
  cancelled: boolean;
  handle: number;
}>;

Defined in: packages/core/dist/index.d.ts

Parameters

Parameter	Type
handle	number
reason?	string

Returns

Promise<{ cancelled: boolean; handle: number; }>

---

getChildResult()

getChildResult(handle, opts?): Promise<ChildResultPage>;

Defined in: packages/core/dist/index.d.ts

A page of a settled child's full output; opt-in get_child_result (RV-201).

Parameters

Parameter	Type
handle	number
opts?	{ maxChars?: number; offset?: number; }
opts.maxChars?	number
opts.offset?	number

Returns

Promise&lt;ChildResultPage&gt;

---

getSettledChildResults()

getSettledChildResults(handles, opts?): Promise<ChildResultPage[]>;

Defined in: packages/core/dist/index.d.ts

First pages of SEVERAL settled children in one call; opt-in get_settled_child_results (RV1807). Refuses typed BEFORE any read when any named handle is unknown or still running, so consuming the exact settledHandles set of an await_any digest never probes by error.

Parameters

Parameter	Type
handles	number[]
opts?	{ maxCharsPerChild?: number; }
opts.maxCharsPerChild?	number

Returns

Promise&lt;ChildResultPage[]&gt;

---

readChildArtifact()

readChildArtifact(
   handle, 
   artifactId, 
opts?): Promise<ChildArtifactPage>;

Defined in: packages/core/dist/index.d.ts

A page of a settled child's artifact content; opt-in read_child_artifact (RV-201).

Parameters

Parameter	Type
handle	number
artifactId	string
opts?	{ maxChars?: number; offset?: number; }
opts.maxChars?	number
opts.offset?	number

Returns

Promise&lt;ChildArtifactPage&gt;

---

spawn()

spawn(params, origin?): Promise<{
  handle: number;
}>;

Defined in: packages/core/dist/index.d.ts

Parameters

Parameter	Type
params	{ agentType: string; approach?: string; budgetUsd?: number; lineage?: { causeRef: number; continues: string; relation?: string; }; model_hint?: { startTier?: number; }; outputSchemaRef?: string; prompt: string; taskClass?: string; toolsetRef?: string; }
params.agentType	string
params.approach?	string
params.budgetUsd?	number
params.lineage?	{ causeRef: number; continues: string; relation?: string; }
params.lineage.causeRef?	number
params.lineage.continues?	string
params.lineage.relation?	string
params.model_hint?	{ startTier?: number; }
params.model_hint.startTier?	number
params.outputSchemaRef?	string
params.prompt?	string
params.taskClass?	string
params.toolsetRef?	string
origin?	"spawn_agent" | "parallel_agents"

Returns

Promise<{ handle: number; }>

---

waitForEvents()

waitForEvents(triggers): Promise<unknown>;

Defined in: packages/core/dist/index.d.ts

Sleep until a coalesced WakeDigest (M6-T09).

Parameters

Parameter	Type
triggers	unknown

Returns

Promise&lt;unknown&gt;