Rulvar API reference

---

Rulvar API reference / @rulvar/rulvar / MemoryQuotaLimiter

Interface: MemoryQuotaLimiter

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

The in-process reference QuotaLimiter returned by memoryQuotaLimiter.

Extends

• QuotaLimiter

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>

Inherited from

QuotaLimiter.reconcile

---

release()

release(reservationId): Promise<void>;

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

The reference limiter always implements release (RV1013).

Parameters

Parameter	Type
reservationId	string

Returns

Promise<void>

Overrides

QuotaLimiter.release

---

reserve()

reserve(request): Promise<QuotaDecision>;

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

Parameters

Parameter	Type
request	QuotaReservationRequest

Returns

Promise<QuotaDecision>

Inherited from

QuotaLimiter.reserve

---

snapshot()

snapshot(): QuotaWindowSnapshot[];

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

Current-window counters per rule; rolled-over windows read as zero.

Returns

QuotaWindowSnapshot[]