Member Junction
    Preparing search index...

    Interface RateLimiterOptions

    Construction options for RateLimiter. All fields optional; sensible defaults applied.

    interface RateLimiterOptions {
        Burst?: number;
        MinTokensPerSec?: number;
        now?: NowFn;
        sleep?: SleepFn;
        SuccessRampPerCall?: number;
        ThrottleBackoffFactor?: number;
        TokensPerSec?: number;
    }
    Index

    Properties

    Burst? MinTokensPerSec? now? sleep? SuccessRampPerCall? ThrottleBackoffFactor? TokensPerSec?

    Properties

    Burst?: number

    Bucket capacity (max tokens that can accumulate) — the allowed burst size. Default: TokensPerSec.

    MinTokensPerSec?: number

    Floor the effective rate can be cut to by repeated throttles, so a key never fully stalls (tokens/sec). Default: TokensPerSec / 20. Clamped to be > 0.

    now?: NowFn

    Time source. Default: Date.now.

    sleep?: SleepFn

    Wait primitive. Default: a real setTimeout-based sleep.

    SuccessRampPerCall?: number

    Additive-increase amount (tokens/sec) added to the effective rate on each success, clamped to TokensPerSec. Default: TokensPerSec / 10 (≈10 successes to fully recover).

    ThrottleBackoffFactor?: number

    Multiplicative-decrease factor applied to the effective rate on each throttle signal (0 < f < 1). Default: 0.5 (halve the rate, like TCP).

    TokensPerSec?: number

    Ceiling refill rate in tokens per second — the steady-state target a key ramps back toward and never exceeds. Also the rate a fresh key starts at. Default: 10.

    Settings

    Member Visibility

    On This Page

    Properties