Skip to main content

Interface: HttpRateLimiterConfig

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

Configuration for HttpRateLimiter.

Properties​

maxConcurrent​

readonly maxConcurrent: number

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

Max number of concurrent operations globally.

maxWaitMs?​

readonly optional maxWaitMs: number

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

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

Default Value​

30_000;

minIntervalMs​

readonly minIntervalMs: number

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

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

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

Optional key derivation function.

Parameters​

url​

string

Returns​

string

Default Value​

(url) =\> new URL(url)