Interface Config

Configuration options for creating a rate limit token bucket.

interface Config {
    capacity: number;
    initialState?: RateLimitTokenBucket.State;
    load?: RateLimitTokenBucket.LoadFn;
    refillIntervalMs: number;
    save?: RateLimitTokenBucket.SaveFn;
}

Index

Properties

capacity initialState? load? refillIntervalMs save?

Properties

capacity

capacity: number

Maximum number of tokens in the bucket

`Optional`initialState

initialState?: RateLimitTokenBucket.State

Initial state to restore from (for persistence)

`Optional`load

load?: RateLimitTokenBucket.LoadFn

Function to load the state (for persistence)

refillIntervalMs

refillIntervalMs: number

Time in milliseconds required to generate one token

`Optional`save

save?: RateLimitTokenBucket.SaveFn

Function to save the current state (for persistence)