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
AsyncDebouncerState
Defined in: async-debouncer.ts:8
Type Parameters#
TFn#
TFn extends AnyAsyncFunction
Properties#
canLeadingExecute#
canLeadingExecute: boolean;Defined in: async-debouncer.ts:12
Whether the debouncer can execute on the leading edge of the timeout
errorCount#
errorCount: number;Defined in: async-debouncer.ts:16
Number of function executions that have resulted in errors
isExecuting#
isExecuting: boolean;Defined in: async-debouncer.ts:20
Whether the debounced function is currently executing asynchronously
isPending#
isPending: boolean;Defined in: async-debouncer.ts:24
Whether the debouncer is waiting for the timeout to trigger execution
lastArgs#
lastArgs: Parameters<TFn> | undefined;Defined in: async-debouncer.ts:28
The arguments from the most recent call to maybeExecute
lastResult#
lastResult: Awaited<ReturnType<TFn>> | undefined;Defined in: async-debouncer.ts:32
The result from the most recent successful function execution
maybeExecuteCount#
maybeExecuteCount: number;Defined in: async-debouncer.ts:36
Number of times maybeExecute has been called (for reduction calculations)
settleCount#
settleCount: number;Defined in: async-debouncer.ts:40
Number of function executions that have completed (either successfully or with errors)
status#
status: "disabled" | "idle" | "executing" | "pending" | "settled";Defined in: async-debouncer.ts:44
Current execution status - 'idle' when not active, 'pending' when waiting, 'executing' when running, 'settled' when completed
successCount#
successCount: number;Defined in: async-debouncer.ts:48
Number of function executions that have completed successfully