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

AsyncRateLimiterState

Interface: AsyncRateLimiterState<TFn>

Defined in: async-rate-limiter.ts:6

Type Parameters

TFn extends AnyAsyncFunction

Properties

errorCount

ts
errorCount: number;
errorCount: number;

Defined in: async-rate-limiter.ts:10

Number of function executions that have resulted in errors


executionTimes

ts
executionTimes: number[];
executionTimes: number[];

Defined in: async-rate-limiter.ts:14

Array of timestamps when executions occurred for rate limiting calculations


isExceeded

ts
isExceeded: boolean;
isExceeded: boolean;

Defined in: async-rate-limiter.ts:18

Whether the rate limiter has exceeded the limit


isExecuting

ts
isExecuting: boolean;
isExecuting: boolean;

Defined in: async-rate-limiter.ts:22

Whether the rate-limited function is currently executing asynchronously


lastResult

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

Defined in: async-rate-limiter.ts:26

The result from the most recent successful function execution


maybeExecuteCount

ts
maybeExecuteCount: number;
maybeExecuteCount: number;

Defined in: async-rate-limiter.ts:46

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


rejectionCount

ts
rejectionCount: number;
rejectionCount: number;

Defined in: async-rate-limiter.ts:30

Number of function executions that have been rejected due to rate limiting


settleCount

ts
settleCount: number;
settleCount: number;

Defined in: async-rate-limiter.ts:34

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


status

ts
status: "disabled" | "idle" | "executing" | "exceeded";
status: "disabled" | "idle" | "executing" | "exceeded";

Defined in: async-rate-limiter.ts:38

Current execution status - 'disabled' when not active, 'executing' when executing, 'idle' when not executing, 'exceeded' when rate limit is exceeded


successCount

ts
successCount: number;
successCount: number;

Defined in: async-rate-limiter.ts:42

Number of function executions that have completed successfully