Interface RateLimitedFunction<ArgsType, ReturnType>

A function wrapper returned by rateLimited enforcing a minimum delay between calls.

interface RateLimitedFunction<ArgsType extends unknown[], ReturnType> {
    get limit_duration_ms(): number;
    get processing_count(): number;
    get wait_count(): number;
    (...args: ArgsType): Promise<ReturnType>;
}

Type Parameters

ArgsType extends unknown[]
Tuple of the wrapped function's parameter types.
ReturnType
The resolved return type.

RateLimitedFunction(...args: ArgsType): Promise<ReturnType>
Invokes the function; queued if rate limit is active (FIFO order).
Parameters
- ...args: ArgsType
Returns Promise<ReturnType>
- Defined in src/function/rate-limit.ts:11

Index

Accessors

limit_duration_ms processing_count wait_count

Accessors

limit_duration_ms

get limit_duration_ms(): number
Current delay (ms) between calls.

Returns number
- Defined in src/function/rate-limit.ts:14

processing_count

get processing_count(): number
Number of calls currently being processed.

Returns number
- Defined in src/function/rate-limit.ts:20

wait_count

get wait_count(): number
Number of queued calls awaiting execution.

Returns number
- Defined in src/function/rate-limit.ts:17