Class Semaphore

A semaphore that limits the number of concurrent operations. Used to prevent connection pool exhaustion by limiting concurrent database operations to the pool size.

Index

Constructors

Methods

acquire dispose getAvailablePermits getMaxPermits getMetrics getWaitingCount isDisposed on once release withPermit

Constructors

constructor

new Semaphore(maxPermits: number): Semaphore
Parameters
- maxPermits: number
Returns Semaphore
- Defined in src/models/Semaphore.ts:72

Methods

acquire

acquire(options?: { signal?: AbortSignal; timeout?: number }): Promise<void>
Acquire a permit. If no permits are available, waits until one becomes available.
Parameters
- Optionaloptions: { signal?: AbortSignal; timeout?: number }
Returns Promise<void>
- Defined in src/models/Semaphore.ts:86

dispose

dispose(): void
Dispose the semaphore, rejecting all waiting operations and preventing new ones.

Returns void
- Defined in src/models/Semaphore.ts:228

getAvailablePermits

getAvailablePermits(): number
Get current number of available permits (for debugging)

Returns number
- Defined in src/models/Semaphore.ts:259

getMaxPermits

getMaxPermits(): number
Get maximum number of permits

Returns number
- Defined in src/models/Semaphore.ts:273

getMetrics

getMetrics(): {
    availablePermits: number;
    disposed: boolean;
    maxPermits: number;
    utilization: number;
    waitingCount: number;
}
Get metrics about the current state of the semaphore

Returns {
    availablePermits: number;
    disposed: boolean;
    maxPermits: number;
    utilization: number;
    waitingCount: number;
}
- Defined in src/models/Semaphore.ts:287

getWaitingCount

getWaitingCount(): number
Get current number of waiting operations (for debugging)

Returns number
- Defined in src/models/Semaphore.ts:266

isDisposed

isDisposed(): boolean
Check if the semaphore has been disposed

Returns boolean
- Defined in src/models/Semaphore.ts:280

on

on(
type: SemaphoreEventType,
handler: (event: SemaphoreEvent) => any,
): () => void
Parameters
- type: SemaphoreEventType
- handler: (event: SemaphoreEvent) => any
Returns () => void
- Defined in src/models/Semaphore.ts:303

once

once(
type: SemaphoreEventType,
handler: (event: SemaphoreEvent) => any,
): () => void
Parameters
- type: SemaphoreEventType
- handler: (event: SemaphoreEvent) => any
Returns () => void
- Defined in src/models/Semaphore.ts:331

release

release(): void
Release a permit, allowing waiting operations to proceed.

Returns void
- Defined in src/models/Semaphore.ts:161

withPermit

withPermit<T>(
fn: () => Promise<T>,
options?: { signal?: AbortSignal; timeout?: number },
): Promise<T>
Execute a function with a permit, automatically releasing it afterwards.
Type Parameters
- T
Parameters
- fn: () => Promise<T>
- Optionaloptions: { signal?: AbortSignal; timeout?: number }
Returns Promise<T>
- Defined in src/models/Semaphore.ts:213