rulvar API reference / @rulvar/rulvar / BudgetHooks
Interface: BudgetHooks
Defined in: packages/core/dist/index.d.ts
Budget hooks bound by the three-layer budget.
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
signal? | AbortSignal | Layer 3: the ceiling AbortSignal. | packages/core/dist/index.d.ts |
Methods
beforeTurn()
ts
beforeTurn(): void;Defined in: packages/core/dist/index.d.ts
Layer 2: before every turn; throws BudgetExhaustedError to block dispatch.
Returns
void
onUsage()
ts
onUsage(usage, servedBy): void;Defined in: packages/core/dist/index.d.ts
Live usage accounting; layer 3 may respond by aborting signal.
Parameters
| Parameter | Type |
|---|---|
usage | Usage |
servedBy | `${string}:${string}` |
Returns
void