Skip to main content

RateLimitConfig

Upgather SDK

Upgather SDK / RateLimitConfig

Interface: RateLimitConfig

Configuration options for rate limiting.

Extends​

Properties​

burstCapacity?​

optional burstCapacity: number

Burst capacity (default: same as requestsPerSecond)

Inherited from​

RateLimitOptions.burstCapacity

enabled​

enabled: boolean

endpointKeyExtractor()?​

optional endpointKeyExtractor: (request) => string

Function to extract endpoint key

Parameters​

request​

HttpRequest

Returns​

string

Inherited from​

RateLimitOptions.endpointKeyExtractor

logger?​

optional logger: LoggerInterface

Optional logger instance for rate limit events

Inherited from​

RateLimitOptions.logger

maxWaitTime?​

optional maxWaitTime: number

Maximum wait time in ms (default: 5000)

Inherited from​

RateLimitOptions.maxWaitTime

namespace?​

optional namespace: string

Namespace for isolation between different parts of app

Inherited from​

RateLimitOptions.namespace

requestsPerSecond​

requestsPerSecond: number

Maximum requests per second

Inherited from​

RateLimitOptions.requestsPerSecond

waitWhenLimited?​

optional waitWhenLimited: boolean

Whether to wait when rate limited (vs reject)

Inherited from​

RateLimitOptions.waitWhenLimited