Docs
Code Rabbit
Cloudflare
AG Grid
Netlify
Neon
WorkOS
Clerk
Convex
Electric
Sentry
Prisma
Strapi
Unkey
UI.dev
Code Rabbit
Cloudflare
AG Grid
Netlify
Neon
WorkOS
Clerk
Convex
Electric
Sentry
Prisma
Strapi
Unkey
UI.dev
Debouncer API Reference
Throttler API Reference
Rate Limiter API Reference
Queue API Reference
Batcher API Reference
Rate Limiter API Reference

AsyncRateLimiterState

Interface: AsyncRateLimiterState<TFn>

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

Type Parameters

TFn

TFn extends AnyAsyncFunction

Properties

errorCount

ts
errorCount: number;
errorCount: number;

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

Number of function executions that have resulted in errors


executionTimes

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

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

Array of timestamps when executions occurred for rate limiting calculations


isExceeded

ts
isExceeded: boolean;
isExceeded: boolean;

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

Whether the rate limiter has exceeded the limit


isExecuting

ts
isExecuting: boolean;
isExecuting: boolean;

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

Whether the rate-limited function is currently executing asynchronously


lastResult

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

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

The result from the most recent successful function execution


maybeExecuteCount

ts
maybeExecuteCount: number;
maybeExecuteCount: number;

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

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


rejectionCount

ts
rejectionCount: number;
rejectionCount: number;

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

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


settleCount

ts
settleCount: number;
settleCount: number;

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

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

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

Number of function executions that have completed successfully