rulvar API reference

---

rulvar API reference / @rulvar/rulvar / Semaphore

Class: Semaphore

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

Constructors

Constructor

new Semaphore(limit): Semaphore;

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

Parameters

Parameter	Type
limit	number

Returns

Semaphore

Accessors

pending

Get Signature

get pending(): number;

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

Returns

number

Methods

acquire()

acquire(onQueued?): Promise<() => void>;

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

Acquires a slot, resolving in FIFO order. onQueued fires only when the caller actually has to wait (feeds the agent:queued event).

Parameters

Parameter	Type
onQueued?	() => void

Returns

Promise<() => void>

---

withSlot()

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

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

Type Parameters

Type Parameter
T

Parameters

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

Returns

Promise<T>