Rulvar API reference

---

Rulvar API reference / @rulvar/rulvar / QuotaLimiter

Interface: QuotaLimiter

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

The shared rate/quota limiter seam; see the module contract above.

Extended by

• MemoryQuotaLimiter

Methods

reconcile()

reconcile(
   reservationId, 
   usage, 
actual?): Promise<void>;

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

Settles a reservation against the attempt's actual usage. The optional actual.requests is the TRUE number of wire requests the reservation ended up covering (RV905: an adapter absorbing provider-side continuations makes several wire calls inside one reserved dispatch); implementations add the difference over the single request the reservation admitted into the same window, so the request cap reflects what the provider actually metered. A settlement never denies retroactively: the wire calls already happened. Implementations written against the two-argument form remain valid; they merely keep the historical undercount.

Parameters

Parameter	Type
reservationId	string
usage	Usage
actual?	{ requests?: number; }
actual.requests?	number

Returns

Promise<void>

---

release()?

optional release(reservationId): Promise<void>;

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

Cancels an UNUSED admission (RV1013): the reserved wire never left, so the admitted request and its token estimate return to the window. This is NOT reconcile: a settlement only ever adds (the calls already happened), while a release gives back exactly what admission consumed for a wire that was never sent (the engine calls it for pre-wire continuation reservations whose segment never flew). MUST be idempotent and tolerate unknown or expired ids as no-ops, like reconcile; a released id settles nothing afterwards. Optional: implementations without it keep the conservative window age-out for unused admissions.

Parameters

Parameter	Type
reservationId	string

Returns

Promise<void>

---

reserve()

reserve(request): Promise<QuotaDecision>;

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

Parameters

Parameter	Type
request	QuotaReservationRequest

Returns

Promise<QuotaDecision>