Stone.js API
    Preparing search index...

    Options for the Redis driver.

    interface RedisLimiterConfig {
        client?: unknown;
        driver?: RateLimitDriver;
        factory?: RateLimiterFactory;
        name: string;
        prefix?: string;
        [key: string]: unknown;
    }

    Hierarchy (View Summary)

    Indexable

    • [key: string]: unknown

      Anything the driver needs.

    Index
    client?: unknown

    An ioredis client, or the options to build one.

    Which driver builds it. Defaults to memory, and ignored when factory is given.

    Build the limiter yourself, instead of naming a driver this package ships.

    This is how a deployment counts in the store it already runs on. It is declared here, next to the other limiters, rather than registered on the manager from a provider: the container is rebuilt for every event, so anything registered imperatively during one event is gone for the next, and an application should not have to know that to plug in a driver.

    name: string

    The name it is resolved under.

    prefix?: string

    Key prefix, so several applications can share one Redis. Defaults to ratelimit:.