Skip to content

rulvar API reference


rulvar API reference / @rulvar/rulvar / OrchestratorBudgetSpec

Interface: OrchestratorBudgetSpec

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

Budget contract: https://docs.rulvar.com/guide/budgets; the cap machinery (reserves, freeze) completes in M7 (DEF-7).

Properties

PropertyTypeDescriptionDefined in
atCap?"finish-with-partial" | "fail-run"-packages/core/dist/index.d.ts
capFraction?numberdefault 0.2; effectiveCap = min of the given boundspackages/core/dist/index.d.ts
capUsd?number-packages/core/dist/index.d.ts
finalizeReserveUsd?number-packages/core/dist/index.d.ts
finalizeTurns?number-packages/core/dist/index.d.ts