Pacer Docs
API Reference
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
AI/LLM: This documentation page is available in plain markdown format at/pacer/latest/docs/reference/interfaces/ThrottlerState.md
Throttler API Reference
ThrottlerState
Defined in: throttler.ts:6
Type Parameters#
TFn#
TFn extends AnyFunction
Properties#
executionCount#
ts
executionCount: number;Defined in: throttler.ts:10
Number of function executions that have been completed
isPending#
ts
isPending: boolean;Defined in: throttler.ts:14
Whether the throttler is waiting for the timeout to trigger execution
lastArgs#
ts
lastArgs: Parameters<TFn> | undefined;Defined in: throttler.ts:18
The arguments from the most recent call to maybeExecute
lastExecutionTime#
ts
lastExecutionTime: number;Defined in: throttler.ts:22
Timestamp of the last function execution in milliseconds
maybeExecuteCount#
ts
maybeExecuteCount: number;Defined in: throttler.ts:26
Number of times maybeExecute has been called (for reduction calculations)
nextExecutionTime#
ts
nextExecutionTime: number | undefined;Defined in: throttler.ts:30
Timestamp when the next execution can occur in milliseconds
status#
ts
status: "disabled" | "idle" | "pending";Defined in: throttler.ts:34
Current execution status - 'idle' when not active, 'pending' when waiting for timeout