Class: TokenBucketRateLimiter

Constructors

Constructor

new TokenBucketRateLimiter(options?: RateLimiterOptions): TokenBucketRateLimiter;

Parameters

Parameter	Type
options	RateLimiterOptions

Returns

TokenBucketRateLimiter

Accessors

currentRatePerSecond

Get Signature

get currentRatePerSecond(): number;

returns current effective rate in requests per second

Returns

number

Methods

acquire()

acquire(): Promise<void>;

resolves once a token is available in FIFO order, consuming it

Returns

Promise<void>

---

onRateLimited()

onRateLimited(): void;

halves the rate and drains the bucket on 429 responses. automatically ramps back up after recoveryCooldownMs without subsequent 429s.

Returns

void