Class RateLimiter

Rate limiter using the Sliding Window Log algorithm.

Index

Constructors

Methods

check destroy getUsage reset

Constructors

constructor

new RateLimiter(config?: Partial<RateLimiterConfig>): RateLimiter
Parameters
- config: Partial<RateLimiterConfig> = {}
Returns RateLimiter
- Defined in src/rate-limiter.ts:37

Methods

check

check(key: string, options?: RateLimitCheckOptions): RateLimitResult
Check if request is allowed under the rate limit
Parameters
- key: string
- options: RateLimitCheckOptions = {}
Returns RateLimitResult
- Defined in src/rate-limiter.ts:51

destroy

destroy(): void
Destroy the rate limiter

Returns void
- Defined in src/rate-limiter.ts:178

getUsage

getUsage(
key: string,
options?: RateLimitCheckOptions,
): { count: number; remaining: number; resetIn: number } | null
Get current usage for a key
Parameters
- key: string
- options: RateLimitCheckOptions = {}
Returns { count: number; remaining: number; resetIn: number } | null
- Defined in src/rate-limiter.ts:124

reset

reset(key: string): void
Reset rate limit for a specific key
Parameters
- key: string
Returns void
- Defined in src/rate-limiter.ts:115