magiclogger - v0.1.0
    Preparing search index...

    Interface RateLimiterOptions

    Rate limiter configuration options.

    interface RateLimiterOptions {
        capacity?: number;
        keyFn?: (entry: LogEntry) => string;
        max: number;
        onLimit?: (key: string, dropped: number) => void;
        refillRate?: number;
        strategy?: RateLimitStrategy;
        window: number;
    }
    Index

    Properties

    capacity? keyFn? max onLimit? refillRate? strategy? window

    Properties

    capacity?: number

    Token bucket specific: bucket capacity.

    keyFn?: (entry: LogEntry) => string

    Key function for per-key rate limiting.

    max: number

    Maximum number of logs allowed.

    onLimit?: (key: string, dropped: number) => void

    Callback when rate limit is exceeded.

    refillRate?: number

    Token bucket specific: refill rate (tokens per second).

    strategy?: RateLimitStrategy

    Rate limiting strategy.

    'sliding'
    window: number

    Time window in milliseconds.

    Settings

    Member Visibility

    On This Page

    Properties