Class RateLimiter

Index

Constructors

Methods

create initDatabase checkLimit getStats reset resetIdentifier getResetTime

Constructors

constructor

new RateLimiter(prorm: Prorm, options?: RateLimiterOptions): RateLimiter
Parameters
- prorm: Prorm
- options: RateLimiterOptions = {}
Returns RateLimiter
- Defined in compliance/rate-limiter.ts:179

Methods

`Static`create

create(prorm: Prorm, options?: RateLimiterOptions): RateLimiter
Factory method to create a RateLimiter instance
Parameters
- prorm: Prorm
- options: RateLimiterOptions = {}
Returns RateLimiter
- Defined in compliance/rate-limiter.ts:201

initDatabase

initDatabase(): Promise<void>
Initialize database storage (optional)

Returns Promise<void>
- Defined in compliance/rate-limiter.ts:208

checkLimit

checkLimit(
    userId: string | null,
    ip: string,
    endpoint: string,
    role?: string,
): RateLimitResult
Check if a request is within rate limits
Parameters
- userId: string | null
- ip: string
- endpoint: string
- Optionalrole: string
Returns RateLimitResult
- Defined in compliance/rate-limiter.ts:279

getStats

getStats(): RateLimitStats
Get rate limit statistics

Returns RateLimitStats
- Defined in compliance/rate-limiter.ts:538

reset

reset(): void
Reset all rate limit counters

Returns void
- Defined in compliance/rate-limiter.ts:590

resetIdentifier

resetIdentifier(identifier: string, type: string, endpoint?: string): void
Reset specific user/IP
Parameters
- identifier: string
- type: string
- Optionalendpoint: string
Returns void
- Defined in compliance/rate-limiter.ts:604

getResetTime

getResetTime(): number
Get current window reset time

Returns number
- Defined in compliance/rate-limiter.ts:616