Framework
Version
Debouncer API Reference
Throttler API Reference
Rate Limiter API Reference
Queue API Reference
Batcher API Reference

QueuerState

Interface: QueuerState<TValue>

Defined in: queuer.ts:4

Type Parameters

TValue

Properties

executionCount

ts
executionCount: number;
executionCount: number;

Defined in: queuer.ts:8

Number of items that have been processed by the queuer


expirationCount

ts
expirationCount: number;
expirationCount: number;

Defined in: queuer.ts:12

Number of items that have been removed from the queue due to expiration


isEmpty

ts
isEmpty: boolean;
isEmpty: boolean;

Defined in: queuer.ts:16

Whether the queuer has no items to process (items array is empty)


isFull

ts
isFull: boolean;
isFull: boolean;

Defined in: queuer.ts:20

Whether the queuer has reached its maximum capacity


isIdle

ts
isIdle: boolean;
isIdle: boolean;

Defined in: queuer.ts:24

Whether the queuer is not currently processing any items


isRunning

ts
isRunning: boolean;
isRunning: boolean;

Defined in: queuer.ts:28

Whether the queuer is active and will process items automatically


items

ts
items: TValue[];
items: TValue[];

Defined in: queuer.ts:32

Array of items currently waiting to be processed


itemTimestamps

ts
itemTimestamps: number[];
itemTimestamps: number[];

Defined in: queuer.ts:36

Timestamps when items were added to the queue for expiration tracking


pendingTick

ts
pendingTick: boolean;
pendingTick: boolean;

Defined in: queuer.ts:40

Whether the queuer has a pending timeout for processing the next item


rejectionCount

ts
rejectionCount: number;
rejectionCount: number;

Defined in: queuer.ts:44

Number of items that have been rejected from being added to the queue


size

ts
size: number;
size: number;

Defined in: queuer.ts:48

Number of items currently in the queue


status

ts
status: "idle" | "running" | "stopped";
status: "idle" | "running" | "stopped";

Defined in: queuer.ts:52

Current processing status - 'idle' when not processing, 'running' when active, 'stopped' when paused