RateLimiter
Defined in: rate-limiter.ts:17
Rate limiter class
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new RateLimiter(
options):RateLimiter
Defined in: rate-limiter.ts:22
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”RateLimiter
Methods
Section titled “Methods”check()
Section titled “check()”check(
req,res):Promise<boolean>
Defined in: rate-limiter.ts:53
Check if request should be rate limited
Parameters
Section titled “Parameters”IncomingMessage
ServerResponse
Returns
Section titled “Returns”Promise<boolean>
dispose()
Section titled “dispose()”dispose():
void
Defined in: rate-limiter.ts:42
Dispose of the rate limiter and clean up resources. Call this when the rate limiter is no longer needed to prevent memory leaks.
Returns
Section titled “Returns”void
getState()
Section titled “getState()”getState(
key):RateLimitState|undefined
Defined in: rate-limiter.ts:131
Get current state for a key
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”RateLimitState | undefined
reset()
Section titled “reset()”reset(
key):void
Defined in: rate-limiter.ts:117
Reset rate limit for a specific key
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
resetAll()
Section titled “resetAll()”resetAll():
void
Defined in: rate-limiter.ts:124
Reset all rate limits
Returns
Section titled “Returns”void