rulvar API reference

---

rulvar API reference / @rulvar/rulvar / Ctx

Interface: Ctx<P>

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

The canonical Ctx interface, M1 members.

Type Parameters

Type Parameter	Default type
P extends ErrorPolicy	"strict"

Properties

Property	Type	Defined in
budget	{ remaining: Spend | null; spent: Spend; }	packages/core/dist/index.d.ts
budget.remaining	Spend | null	packages/core/dist/index.d.ts
budget.spent	Spend	packages/core/dist/index.d.ts

Methods

agent()

Call Signature

agent(prompt): Promise<P extends "lenient" ? string | null : string>;

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

Parameters

Parameter	Type
prompt	string

Returns

Promise<P extends "lenient" ? string | null : string>

Call Signature

agent<S>(prompt, o): Promise<AgentResult<Out<S>>>;

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

Type Parameters

Type Parameter
S extends SchemaSpec<unknown>

Parameters

Parameter	Type
prompt	string
o	AgentOpts<S> & { result: "full"; }

Returns

Promise<AgentResult<Out<S>>>

Call Signature

agent<S>(prompt, o): Promise<Out<S>>;

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

Type Parameters

Type Parameter
S extends SchemaSpec<unknown>

Parameters

Parameter	Type
prompt	string
o	AgentOpts<S> & { onError: "throw"; }

Returns

Promise<Out<S>>

Call Signature

agent<S>(prompt, o?): Promise<P extends "lenient" ? Out<S> | null : Out<S>>;

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

Type Parameters

Type Parameter
S extends SchemaSpec<unknown>

Parameters

Parameter	Type
prompt	string
o?	AgentOpts<S>

Returns

Promise<P extends "lenient" ? Out<S> | null : Out<S>>

---

awaitExternal()

awaitExternal<T>(key, o?): Promise<T>;

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

Suspends this position on a journaled entry until an external resolution arrives. NO deadline in v1.

Type Parameters

Type Parameter	Default type
T	Json

Parameters

Parameter	Type
key	string
o?	{ prompt?: string; schema?: SchemaSpec<unknown>; }
o.prompt?	string
o.schema?	SchemaSpec<unknown>

Returns

Promise<T>

---

brief()

brief(o): Promise<string>;

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

A journaled summarize invocation for handing an inheritable brief to a child (M6-T10): one agent-kind entry under role 'summarize', therefore free on replay.

Parameters

Parameter	Type
o	BriefOpts

Returns

Promise<string>

---

log()

log(
   level, 
   msg, 
   data?): void;

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

Parameters

Parameter	Type
level	"debug" | "info" | "warn" | "error"
msg	string
data?	Json

Returns

void

---

now()

now(): number;

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

Returns

number

---

orchestrate()

orchestrate(goal, opts?): Promise<unknown>;

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

Nests a dynamic orchestrator under the AdmissionController (M6-T07): one implementation with the top-level orchestrate(engine, goal, opts) surface, clamped by maxDepth and the parent budget account through the ordinary ctx.workflow admission.

Parameters

Parameter	Type
goal	string
opts?	OrchestrateOptions

Returns

Promise<unknown>

---

parallel()

Call Signature

parallel<T>(tasks, o?): Promise<T[]>;

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

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
tasks	() => Promise<T>[]
o?	{ abortSiblings?: boolean; settle?: false; }
o.abortSiblings?	boolean
o.settle?	false

Returns

Promise<T[]>

Call Signature

parallel<T>(tasks, o): Promise<Settled<T>[]>;

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

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
tasks	() => Promise<T>[]
o	{ settle: true; }
o.settle	true

Returns

Promise<Settled<T>[]>

---

phase()

phase<T>(name, fn): Promise<T>;

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

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
name	string
fn	() => Promise<T>

Returns

Promise<T>

---

pipeline()

Call Signature

pipeline<I, A>(
   items, 
   s1, 
o): Promise<PipelineCollected<A>>;

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

Type Parameters

Type Parameter
I
A

Parameters

Parameter	Type
items	I[]
s1	Stage<I, A>
o	CollectOpts

Returns

Promise<PipelineCollected<A>>

Call Signature

pipeline<I, A>(
   items, 
   s1, 
o?): Promise<A[]>;

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

Type Parameters

Type Parameter
I
A

Parameters

Parameter	Type
items	I[]
s1	Stage<I, A>
o?	PipelineOpts

Returns

Promise<A[]>

Call Signature

pipeline<I, A, B>(
   items, 
   s1, 
   s2, 
o): Promise<PipelineCollected<B>>;

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

Type Parameters

Type Parameter
I
A
B

Parameters

Parameter	Type
items	I[]
s1	Stage<I, A>
s2	Stage<A, B>
o	CollectOpts

Returns

Promise<PipelineCollected<B>>

Call Signature

pipeline<I, A, B>(
   items, 
   s1, 
   s2, 
o?): Promise<B[]>;

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

Type Parameters

Type Parameter
I
A
B

Parameters

Parameter	Type
items	I[]
s1	Stage<I, A>
s2	Stage<A, B>
o?	PipelineOpts

Returns

Promise<B[]>

Call Signature

pipeline<I, A, B, C>(
   items, 
   s1, 
   s2, 
   s3, 
o): Promise<PipelineCollected<C>>;

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

Type Parameters

Type Parameter
I
A
B
C

Parameters

Parameter	Type
items	I[]
s1	Stage<I, A>
s2	Stage<A, B>
s3	Stage<B, C>
o	CollectOpts

Returns

Promise<PipelineCollected<C>>

Call Signature

pipeline<I, A, B, C>(
   items, 
   s1, 
   s2, 
   s3, 
o?): Promise<C[]>;

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

Type Parameters

Type Parameter
I
A
B
C

Parameters

Parameter	Type
items	I[]
s1	Stage<I, A>
s2	Stage<A, B>
s3	Stage<B, C>
o?	PipelineOpts

Returns

Promise<C[]>

Call Signature

pipeline<I, A, B, C, D>(
   items, 
   s1, 
   s2, 
   s3, 
   s4, 
o): Promise<PipelineCollected<D>>;

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

Type Parameters

Type Parameter
I
A
B
C
D

Parameters

Parameter	Type
items	I[]
s1	Stage<I, A>
s2	Stage<A, B>
s3	Stage<B, C>
s4	Stage<C, D>
o	CollectOpts

Returns

Promise<PipelineCollected<D>>

Call Signature

pipeline<I, A, B, C, D>(
   items, 
   s1, 
   s2, 
   s3, 
   s4, 
o?): Promise<D[]>;

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

Type Parameters

Type Parameter
I
A
B
C
D

Parameters

Parameter	Type
items	I[]
s1	Stage<I, A>
s2	Stage<A, B>
s3	Stage<B, C>
s4	Stage<C, D>
o?	PipelineOpts

Returns

Promise<D[]>

Call Signature

pipeline<I, A, B, C, D, E>(
   items, 
   s1, 
   s2, 
   s3, 
   s4, 
   s5, 
o): Promise<PipelineCollected<E>>;

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

Type Parameters

Type Parameter
I
A
B
C
D
E

Parameters

Parameter	Type
items	I[]
s1	Stage<I, A>
s2	Stage<A, B>
s3	Stage<B, C>
s4	Stage<C, D>
s5	Stage<D, E>
o	CollectOpts

Returns

Promise<PipelineCollected<E>>

Call Signature

pipeline<I, A, B, C, D, E>(
   items, 
   s1, 
   s2, 
   s3, 
   s4, 
   s5, 
o?): Promise<E[]>;

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

Type Parameters

Type Parameter
I
A
B
C
D
E

Parameters

Parameter	Type
items	I[]
s1	Stage<I, A>
s2	Stage<A, B>
s3	Stage<B, C>
s4	Stage<C, D>
s5	Stage<D, E>
o?	PipelineOpts

Returns

Promise<E[]>

Call Signature

pipeline<I, A, B, C, D, E, F>(
   items, 
   s1, 
   s2, 
   s3, 
   s4, 
   s5, 
   s6, 
o): Promise<PipelineCollected<F>>;

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

Type Parameters

Type Parameter
I
A
B
C
D
E
F

Parameters

Parameter	Type
items	I[]
s1	Stage<I, A>
s2	Stage<A, B>
s3	Stage<B, C>
s4	Stage<C, D>
s5	Stage<D, E>
s6	Stage<E, F>
o	CollectOpts

Returns

Promise<PipelineCollected<F>>

Call Signature

pipeline<I, A, B, C, D, E, F>(
   items, 
   s1, 
   s2, 
   s3, 
   s4, 
   s5, 
   s6, 
o?): Promise<F[]>;

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

Type Parameters

Type Parameter
I
A
B
C
D
E
F

Parameters

Parameter	Type
items	I[]
s1	Stage<I, A>
s2	Stage<A, B>
s3	Stage<B, C>
s4	Stage<C, D>
s5	Stage<D, E>
s6	Stage<E, F>
o?	PipelineOpts

Returns

Promise<F[]>

---

random()

random(key?): number;

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

Parameters

Parameter	Type
key?	string

Returns

number

---

step()

step<T>(
   label, 
   fn, 
o?): Promise<T>;

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

Type Parameters

Type Parameter
T extends Json

Parameters

Parameter	Type
label	string
fn	() => T | Promise<T>
o?	{ deps?: Json[]; key?: string; }
o.deps?	Json[]
o.key?	string

Returns

Promise<T>

---

uuid()

uuid(): string;

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

Returns

string

---

workflow()

Call Signature

workflow<A, R>(
   wf, 
   args, 
o?): Promise<R>;

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

Runs a child workflow under the AdmissionController (M6-T06). The child gets a nested journal scope (registered name plus ordinal) and a hierarchical budget sub-account whose spend propagates to every ancestor. Structural limit violations throw the typed AdmissionRejectedError and never tear the run down; budget rejections throw BudgetExhaustedError. The string form resolves against the per-engine workflow registry and is the only form available inside the worker sandbox.

Type Parameters

Type Parameter
A
R

Parameters

Parameter	Type
wf	Workflow<A, R>
args	A
o?	WorkflowCallOpts

Returns

Promise<R>

Call Signature

workflow(
   name, 
   args?, 
o?): Promise<unknown>;

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

Parameters

Parameter	Type
name	string
args?	Json
o?	WorkflowCallOpts

Returns

Promise<unknown>