Classrate-limiterv0.1.0-next.3

MemoryRateLimiter

The in-memory IRateLimiter with an exact sliding window per key. The gateway default behind core.rateLimitercore.rateLimiter.

Each key holds its live uses' expiry times. State is per-process and lost on restart. Expired keys are dropped on the first access at least a minute after the previous sweep.

class MemoryRateLimiter implements Store<"charge">

class MemoryRateLimiter implements Store<"charge">

Member visibility

Filter class members by access level.

Showing members with Protected visibility and higher.

Properties

size

accessor

size

Number of keys currently tracked.

public get size(): number

public get size(): number

charge()

public async charge(
    key: string,
    window: RateLimitWindow
): Promise<RateLimitResult>

public async charge(
    key: string,
    window: RateLimitWindow
): Promise<RateLimitResult>

peek()

public async peek(
    key: string,
    window: RateLimitWindow
): Promise<RateLimitResult>

public async peek(
    key: string,
    window: RateLimitWindow
): Promise<RateLimitResult>

reset()

public async reset(key: string): Promise<void>

public async reset(key: string): Promise<void>