TokenBucketConfig

TokenBucketConfig

@commandkit/ratelimittoken-bucket.ts

Signature

interface TokenBucketConfig {
    capacity: number;
    refillRate: number;
    scope: RateLimitResult['scope'];
}

capacity

property

number

Maximum tokens available when the bucket is full.

refillRate

property

number

Tokens added per second during refill.

scope

property

RateLimitResult['scope']

Scope reported in rate-limit results.