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

AsyncDebouncerState

Interface: AsyncDebouncerState<TFn>

Defined in: async-debouncer.ts:5

Type Parameters

TFn extends AnyAsyncFunction

Properties

canLeadingExecute

ts
canLeadingExecute: boolean;
canLeadingExecute: boolean;

Defined in: async-debouncer.ts:9

Whether the debouncer can execute on the leading edge of the timeout


errorCount

ts
errorCount: number;
errorCount: number;

Defined in: async-debouncer.ts:13

Number of function executions that have resulted in errors


isExecuting

ts
isExecuting: boolean;
isExecuting: boolean;

Defined in: async-debouncer.ts:17

Whether the debounced function is currently executing asynchronously


isPending

ts
isPending: boolean;
isPending: boolean;

Defined in: async-debouncer.ts:21

Whether the debouncer is waiting for the timeout to trigger execution


lastArgs

ts
lastArgs: undefined | Parameters<TFn>;
lastArgs: undefined | Parameters<TFn>;

Defined in: async-debouncer.ts:25

The arguments from the most recent call to maybeExecute


lastResult

ts
lastResult: undefined | ReturnType<TFn>;
lastResult: undefined | ReturnType<TFn>;

Defined in: async-debouncer.ts:29

The result from the most recent successful function execution


settleCount

ts
settleCount: number;
settleCount: number;

Defined in: async-debouncer.ts:33

Number of function executions that have completed (either successfully or with errors)


status

ts
status: "idle" | "pending" | "executing" | "disabled" | "settled";
status: "idle" | "pending" | "executing" | "disabled" | "settled";

Defined in: async-debouncer.ts:37

Current execution status - 'idle' when not active, 'pending' when waiting, 'executing' when running, 'settled' when completed


successCount

ts
successCount: number;
successCount: number;

Defined in: async-debouncer.ts:41

Number of function executions that have completed successfully