@bluelibs/runner - v6.8.0
    Preparing search index...

    Interface RateLimitMiddlewareConfig

    Optional state-placement override for resilience middleware.

    interface RateLimitMiddlewareConfig {
        coordination?: MiddlewareCoordination;
        identityScope?: IdentityScopeConfig;
        keyBuilder?: MiddlewareKeyBuilder;
        max: number;
        maxKeys?: number;
        windowMs: number;
    }

    Hierarchy (View Summary)

    Index
    coordination? identityScope? keyBuilder? max maxKeys? windowMs
    coordination?: MiddlewareCoordination

    Omitted adopts registered resilience, otherwise uses memory. Local always uses memory; distributed requires resilience.

    identityScope?: IdentityScopeConfig

    Controls identity partitioning for middleware-managed state.

    Omit this option to use automatic tenant partitioning when identity exists.

    keyBuilder?: MiddlewareKeyBuilder

    Builds the partition key used to isolate fixed-window counters. Defaults to storageTaskId. Provide an explicit key when you want broader grouping, such as per user or per identity admission limits.

    max: number

    Maximum number of requests within the window

    maxKeys?: number

    Maximum number of distinct live keys tracked for this middleware config.

    windowMs: number

    Time window in milliseconds

    Settings
    Member Visibility

    On This Page
    Properties