API reference › @evolu/common › Task › SemaphoreSnapshot

Defined in: packages/common/src/Task.ts:2409

Snapshot returned by Semaphore.snapshot.

Properties

available

readonly available: number & Brand<"Int"> & Brand<"NonNegative">;

Defined in: packages/common/src/Task.ts:2420

Currently available permits.

disposed

readonly disposed: boolean;

Defined in: packages/common/src/Task.ts:2426

Whether the semaphore has been disposed.

isIdle

readonly isIdle: boolean;

Defined in: packages/common/src/Task.ts:2423

Whether no permits are taken and no Tasks are waiting.

permits

readonly permits: Concurrency;

Defined in: packages/common/src/Task.ts:2411

Total permits configured at creation.

taken

readonly taken: number & Brand<"Int"> & Brand<"NonNegative">;

Defined in: packages/common/src/Task.ts:2414

Currently held permits.

waiting

readonly waiting: number & Brand<"Int"> & Brand<"NonNegative">;

Defined in: packages/common/src/Task.ts:2417

Number of currently waiting Tasks.