Class RateLimiter

Rate limiter using token bucket algorithm

Index

Constructors

Methods

getTokens getTtl tryAcquire

Constructors

constructor

new RateLimiter(capacity: number, refillRate?: number): RateLimiter
Parameters
- capacity: number
- refillRate: number = capacity
Returns RateLimiter
- Defined in domain/types/queue.ts:37

Methods

getTokens

getTokens(): number
Get current token count

Returns number
- Defined in domain/types/queue.ts:65

getTtl

getTtl(maxJobs?: number): number
Milliseconds until the bucket can admit another job. When maxJobs is provided, report 0 until at least that many tokens have been consumed.
Parameters
- OptionalmaxJobs: number
Returns number
- Defined in domain/types/queue.ts:74

tryAcquire

tryAcquire(): boolean
Try to acquire a token

Returns boolean
- Defined in domain/types/queue.ts:46