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

    Interface RateLimitMiddlewareConfig

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

    Hierarchy

    • IdentityScopedMiddlewareConfig
      • RateLimitMiddlewareConfig
    Index

    Properties

    identityScope? keyBuilder? max maxKeys? windowMs

    Properties

    identityScope?: IdentityScopeConfig

    Controls identity partitioning for middleware-managed state.

    Omit this option to keep the shared cross-identity keyspace.

    keyBuilder?: MiddlewareKeyBuilder

    Builds the partition key used to isolate fixed-window counters. Defaults to storageTaskId + ":" + serialized input. 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