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

RateLimiterState

Interface: RateLimiterState

Defined in: rate-limiter.ts:5

Properties

executionCount

ts
executionCount: number;
executionCount: number;

Defined in: rate-limiter.ts:9

Number of function executions that have been completed


executionTimes

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

Defined in: rate-limiter.ts:13

Array of timestamps when executions occurred for rate limiting calculations


isExceeded

ts
isExceeded: boolean;
isExceeded: boolean;

Defined in: rate-limiter.ts:17

Whether the rate limiter has exceeded the limit


rejectionCount

ts
rejectionCount: number;
rejectionCount: number;

Defined in: rate-limiter.ts:21

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


status

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

Defined in: rate-limiter.ts:25

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