Skip to main content

Interface: HttpRateLimiterConfig

Defined in: shared/utils/httpRateLimiter.ts:70

Configuration for HttpRateLimiter.

Properties​

maxConcurrent​

readonly maxConcurrent: number;

Defined in: shared/utils/httpRateLimiter.ts:72

Max number of concurrent operations globally.

maxWaitMs?​

readonly optional maxWaitMs?: number;

Defined in: shared/utils/httpRateLimiter.ts:79

Maximum time to wait for a slot before failing (ms).

Default Value​

30_000;

minIntervalMs​

readonly minIntervalMs: number;

Defined in: shared/utils/httpRateLimiter.ts:82

Minimum interval between requests to the same key (ms).

onMaxWaitExceeded?​

readonly optional onMaxWaitExceeded?: (context: {
  key: string;
  waitedMs: number;
}) => void;

Defined in: shared/utils/httpRateLimiter.ts:90

Optional callback invoked when a caller waited longer than maxWaitMs.

Parameters​

context​
key​

string

waitedMs​

number

Returns​

void

Remarks​

This is useful for logging/telemetry in environment-specific wrappers.

toKey?​

readonly optional toKey?: (url: string) => string;

Defined in: shared/utils/httpRateLimiter.ts:100

Optional key derivation function.

Parameters​

url​

string

Returns​

string

Default Value​

(URL) =\> new URL(URL)