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:6

Properties

executionCount

ts
executionCount: number;
executionCount: number;

Defined in: rate-limiter.ts:10

Number of function executions that have been completed


executionTimes

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

Defined in: rate-limiter.ts:14

Array of timestamps when executions occurred for rate limiting calculations


isExceeded

ts
isExceeded: boolean;
isExceeded: boolean;

Defined in: rate-limiter.ts:18

Whether the rate limiter has exceeded the limit


maybeExecuteCount

ts
maybeExecuteCount: number;
maybeExecuteCount: number;

Defined in: rate-limiter.ts:22

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


rejectionCount

ts
rejectionCount: number;
rejectionCount: number;

Defined in: rate-limiter.ts:26

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


status

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

Defined in: rate-limiter.ts:30

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