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
AsyncBatcherState
Defined in: async-batcher.ts:8
Type Parameters#
TValue#
TValue
Properties#
errorCount#
errorCount: number;Defined in: async-batcher.ts:12
Number of batch executions that have resulted in errors
executionCount#
executionCount: number;Defined in: async-batcher.ts:16
Number of batch executions that have been started
failedItems#
failedItems: TValue[];Defined in: async-batcher.ts:20
Array of items that failed during batch processing
isEmpty#
isEmpty: boolean;Defined in: async-batcher.ts:24
Whether the batcher has no items to process (items array is empty)
isExecuting#
isExecuting: boolean;Defined in: async-batcher.ts:28
Whether a batch is currently being processed asynchronously
isPending#
isPending: boolean;Defined in: async-batcher.ts:32
Whether the batcher is waiting for the timeout to trigger batch processing
items#
items: TValue[];Defined in: async-batcher.ts:36
Array of items currently queued for batch processing
lastResult#
lastResult: any;Defined in: async-batcher.ts:40
The result from the most recent batch execution
settleCount#
settleCount: number;Defined in: async-batcher.ts:44
Number of batch executions that have completed (either successfully or with errors)
size#
size: number;Defined in: async-batcher.ts:48
Number of items currently in the batch queue
status#
status: "idle" | "executing" | "pending" | "populated";Defined in: async-batcher.ts:52
Current processing status - 'idle' when not processing, 'pending' when waiting for timeout, 'executing' when processing, 'populated' when items are present, but no wait is configured
successCount#
successCount: number;Defined in: async-batcher.ts:56
Number of batch executions that have completed successfully
totalItemsFailed#
totalItemsFailed: number;Defined in: async-batcher.ts:60
Total number of items that have failed processing across all batches
totalItemsProcessed#
totalItemsProcessed: number;Defined in: async-batcher.ts:64
Total number of items that have been processed across all batches