Interface RateLimitStore

Store interface for rate limiting.

interface RateLimitStore {
increment(key: string, windowMs: number): Promise<RateLimitResult>;
reset(key: string): Promise<void>;
}

Implemented by

Index

Methods

increment reset

Methods

increment

increment(key: string, windowMs: number): Promise<RateLimitResult>
Increment the counter for the given key within its window. Creates the window if it does not exist.
Parameters
- key: string
- windowMs: number
Returns Promise<RateLimitResult>
- Defined in packages/auth-plugin/src/stores/rate-limit-store.ts:28

reset

reset(key: string): Promise<void>
Reset the counter for the given key.
Parameters
- key: string
Returns Promise<void>
- Defined in packages/auth-plugin/src/stores/rate-limit-store.ts:30