RateLimiter

Tracks per-key usage windows and reports when a key is limited and when it frees up.

Each key holds a sliding window of hit expiry times, and is limited once its live-hit count reaches the window's limitlimit. Expired hits are dropped on the next read, and a background sweep drops fully-expired keys so the map does not grow without bound.

class RateLimiter

class RateLimiter

Member visibility

Filter class members by access level.

constructor

Constructs a new instance of the RateLimiterRateLimiter class

RateLimiter()

RateLimiter()

Showing members with Protected visibility and higher.

Properties

size

accessor

size

Number of keys currently tracked.

public get size(): number

public get size(): number

hit()

Records a hit for keykey and reports whether the key is now limited.

public hit(
    key: string,
    window: RateLimitWindow
): RateLimitResult

public hit(
    key: string,
    window: RateLimitWindow
): RateLimitResult

Parameter: key

The bucket to record against. The caller builds it from its own scope.

Parameter: window

The usage window to apply for this hit.

peek()

Reports whether keykey is limited right now without recording a hit.

The read half of a peek-then-commit. A gate calls peekpeek to decide whether to refuse, and hithit to charge the slot only once it is the gate that let the request through.

public peek(
    key: string,
    window: RateLimitWindow
): RateLimitResult

public peek(
    key: string,
    window: RateLimitWindow
): RateLimitResult