rulvar API reference

---

rulvar API reference / @rulvar/core / KeyedLimiter

Class: KeyedLimiter

Defined in: packages/core/src/model/concurrency.ts:16

Constructors

Constructor

new KeyedLimiter(caps?): KeyedLimiter;

Defined in: packages/core/src/model/concurrency.ts:19

Parameters

Parameter	Type
caps?	Record<string, number>

Returns

KeyedLimiter

Methods

pending()

pending(key): number;

Defined in: packages/core/src/model/concurrency.ts:26

Queue depth for one key (0 for unlimited keys); telemetry only.

Parameters

Parameter	Type
key	string

Returns

number

---

withSlot()

withSlot<T>(
   key, 
   fn, 
onQueued?): Promise<T>;

Defined in: packages/core/src/model/concurrency.ts:34

Runs fn under the key's semaphore; keys without a configured cap run unlimited (no queueing, no overhead).

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
key	string
fn	() => Promise<T>
onQueued?	() => void

Returns

Promise<T>