Interface RateLimiter

interface RateLimiter {
    available(): number;
    reset(): void;
    tryConsume(n?: number): boolean;
}

Index

Methods

available reset tryConsume

Methods

available

available(): number

Current available tokens (rounded).

Returns number

reset

reset(): void

Reset the bucket to full.

Returns void

tryConsume

tryConsume(n?: number): boolean
Try to consume n tokens. Returns true if allowed, false if the bucket is empty.
Parameters
- Optionaln: number
Returns boolean