AsyncRateLimiterState

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

Type Parameters#

TFn#

TFn extends AnyAsyncFunction

Properties#

errorCount#

errorCount: number;

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

Number of function executions that have resulted in errors

executionTimes#

executionTimes: number[];

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

Array of timestamps when executions occurred for rate limiting calculations

isExceeded#

isExceeded: boolean;

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

Whether the rate limiter has exceeded the limit

isExecuting#

isExecuting: boolean;

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

Whether the rate-limited function is currently executing asynchronously

lastResult#

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

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

The result from the most recent successful function execution

maybeExecuteCount#

maybeExecuteCount: number;

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

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

rejectionCount#

rejectionCount: number;

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

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

settleCount#

settleCount: number;

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

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

status#

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#

successCount: number;

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

Number of function executions that have completed successfully