Debouncer API Reference
- DebouncerOptions
- DebouncerState
- AsyncDebouncerOptions
- AsyncDebouncerState
- debounce
- asyncDebounce
- Debouncer
- AsyncDebouncer
- ReactDebouncerOptions
- ReactAsyncDebouncerOptions
- ReactDebouncer
- ReactAsyncDebouncer
- useDebouncer
- useDebouncedCallback
- useDebouncedState
- useDebouncedValue
- useAsyncDebouncer
- useAsyncDebouncedCallback
Throttler API Reference
- ThrottlerOptions
- ThrottlerState
- AsyncThrottlerOptions
- AsyncThrottlerState
- throttle
- asyncThrottle
- Throttler
- AsyncThrottler
- ReactThrottlerOptions
- ReactAsyncThrottlerOptions
- ReactThrottler
- ReactAsyncThrottler
- useThrottler
- useThrottledCallback
- useThrottledState
- useThrottledValue
- useAsyncThrottler
- useAsyncThrottledCallback
Rate Limiter API Reference
Queue API Reference
AsyncQueuerState
Defined in: async-queuer.ts:9
Type Parameters#
TValue#
TValue
Properties#
activeItems#
activeItems: TValue[];Defined in: async-queuer.ts:13
Items currently being processed by the queuer
addItemCount#
addItemCount: number;Defined in: async-queuer.ts:17
Number of times addItem has been called (for reduction calculations)
errorCount#
errorCount: number;Defined in: async-queuer.ts:21
Number of task executions that have resulted in errors
executionCount#
executionCount: number;Defined in: async-queuer.ts:25
Number of times execute has been called
expirationCount#
expirationCount: number;Defined in: async-queuer.ts:29
Number of items that have been removed from the queue due to expiration
isEmpty#
isEmpty: boolean;Defined in: async-queuer.ts:33
Whether the queuer has no items to process (items array is empty)
isExecuting#
isExecuting: boolean;Defined in: async-queuer.ts:37
Whether the queuer is currently executing
isFull#
isFull: boolean;Defined in: async-queuer.ts:41
Whether the queuer has reached its maximum capacity
isIdle#
isIdle: boolean;Defined in: async-queuer.ts:45
Whether the queuer is not currently processing any items
isRunning#
isRunning: boolean;Defined in: async-queuer.ts:49
Whether the queuer is active and will process items automatically
items#
items: TValue[];Defined in: async-queuer.ts:53
Array of items currently waiting to be processed
itemTimestamps#
itemTimestamps: number[];Defined in: async-queuer.ts:57
Timestamps when items were added to the queue for expiration tracking
lastResult#
lastResult: any;Defined in: async-queuer.ts:61
The result from the most recent task execution
pendingTick#
pendingTick: boolean;Defined in: async-queuer.ts:65
Whether the queuer has a pending timeout for processing the next item
rejectionCount#
rejectionCount: number;Defined in: async-queuer.ts:69
Number of items that have been rejected from being added to the queue
settleCount#
settleCount: number;Defined in: async-queuer.ts:73
Number of task executions that have completed (either successfully or with errors)
size#
size: number;Defined in: async-queuer.ts:77
Number of items currently in the queue
status#
status: "idle" | "running" | "stopped";Defined in: async-queuer.ts:81
Current processing status - 'idle' when not processing, 'running' when active, 'stopped' when paused
successCount#
successCount: number;Defined in: async-queuer.ts:85
Number of task executions that have completed successfully