Skip to content

rulvar API reference


rulvar API reference / @rulvar/core / BudgetHooks

Interface: BudgetHooks

Defined in: packages/core/src/runtime/agent-loop.ts:147

Budget hooks bound by the three-layer budget.

Properties

PropertyTypeDescriptionDefined in
signal?AbortSignalLayer 3: the ceiling AbortSignal.packages/core/src/runtime/agent-loop.ts:153

Methods

beforeTurn()

ts
beforeTurn(): void;

Defined in: packages/core/src/runtime/agent-loop.ts:149

Layer 2: before every turn; throws BudgetExhaustedError to block dispatch.

Returns

void


onUsage()

ts
onUsage(usage, servedBy): void;

Defined in: packages/core/src/runtime/agent-loop.ts:151

Live usage accounting; layer 3 may respond by aborting signal.

Parameters

ParameterType
usageUsage
servedBy`${string}:${string}`

Returns

void