Beignet API reference
    Preparing search index...

    Interface CreateUpstashRateLimitProviderOptions

    Options for the Upstash rate limit provider factory.

    interface CreateUpstashRateLimitProviderOptions {
        algorithm?: UpstashRateLimitAlgorithm;
        prefix?: string;
        redisRestToken?: string;
        redisRestUrl?: string;
        timeoutMs?: number;
        timeoutPolicy?: UpstashRateLimitTimeoutPolicy;
    }
    Index
    algorithm? prefix? redisRestToken? redisRestUrl? timeoutMs? timeoutPolicy?
    algorithm?: UpstashRateLimitAlgorithm

    Rate limit algorithm. Overrides UPSTASH_ALGORITHM.

    prefix?: string

    Prefix for keys used by this rate limiter. Overrides UPSTASH_PREFIX.

    redisRestToken?: string

    Upstash Redis REST token. Overrides UPSTASH_REDIS_REST_TOKEN.

    redisRestUrl?: string

    Upstash Redis REST URL. Overrides UPSTASH_REDIS_REST_URL.

    timeoutMs?: number

    Maximum time to wait for an Upstash decision, from 1 through 2,147,483,647 milliseconds. Overrides UPSTASH_TIMEOUT_MS.

    timeoutPolicy?: UpstashRateLimitTimeoutPolicy

    Timeout behavior. Overrides UPSTASH_TIMEOUT_POLICY.

    Settings
    Member Visibility

    On This Page
    Properties