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

ThrottlerState

Interface: ThrottlerState<TFn>

Defined in: throttler.ts:6

Type Parameters

TFn extends AnyFunction

Properties

executionCount

ts
executionCount: number;
executionCount: number;

Defined in: throttler.ts:10

Number of function executions that have been completed


isPending

ts
isPending: boolean;
isPending: boolean;

Defined in: throttler.ts:14

Whether the throttler is waiting for the timeout to trigger execution


lastArgs

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

Defined in: throttler.ts:18

The arguments from the most recent call to maybeExecute


lastExecutionTime

ts
lastExecutionTime: number;
lastExecutionTime: number;

Defined in: throttler.ts:22

Timestamp of the last function execution in milliseconds


maybeExecuteCount

ts
maybeExecuteCount: number;
maybeExecuteCount: number;

Defined in: throttler.ts:26

Number of times maybeExecute has been called (for reduction calculations)


nextExecutionTime

ts
nextExecutionTime: undefined | number;
nextExecutionTime: undefined | number;

Defined in: throttler.ts:30

Timestamp when the next execution can occur in milliseconds


status

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

Defined in: throttler.ts:34

Current execution status - 'idle' when not active, 'pending' when waiting for timeout