Skip to content

RedisRateLimitStore

Defined in: packages/rest/src/redis.ts:287

Redis-backed implementation of RateLimitStore for distributed rate limit synchronization: workers sharing one Redis share every limit, reserve allowance atomically, and merge responses atomically.

new RedisRateLimitStore(options): RedisRateLimitStore

Defined in: packages/rest/src/redis.ts:308

RedisRateLimitStoreOptions

RedisRateLimitStore

optional extendGlobalReset?: (scope, waitMs) => Promise<void>

Defined in: packages/rest/src/redis.ts:581

Atomically extends a global limit, never shortening it.

string

number

Promise<void>

RateLimitStore.extendGlobalReset


optional reconcile?: (key, update) => Promise<void>

Defined in: packages/rest/src/redis.ts:579

Atomically merges a response into the bucket.

string

BucketUpdate

Promise<void>

RateLimitStore.reconcile


optional release?: (key, grant, refund) => Promise<void>

Defined in: packages/rest/src/redis.ts:583

Clears a probe placeholder or refunds an unsent request’s unit.

string

number

boolean

Promise<void>

RateLimitStore.release


optional reserve?: (key, options?) => Promise<Reservation>

Defined in: packages/rest/src/redis.ts:574

Atomically checks the global limit and consumes one unit of the bucket.

string

ReserveOptions

Promise<Reservation>

RateLimitStore.reserve


readonly optional reservesGlobal?: boolean

Defined in: packages/rest/src/redis.ts:589

Whether reserve checks the global limit itself.

RateLimitStore.reservesGlobal

get lastError(): unknown

Defined in: packages/rest/src/redis.ts:343

The most recent Redis error, if any.

unknown


get mode(): CoordinationMode

Defined in: packages/rest/src/redis.ts:353

How limits are being enforced right now.

CoordinationMode


get supportsReservation(): boolean

Defined in: packages/rest/src/redis.ts:358

Whether the backing client supports atomic reservations.

boolean

diagnostics(): RedisStoreDiagnostics

Defined in: packages/rest/src/redis.ts:363

The store’s current health.

RedisStoreDiagnostics


getBucket(key): Promise<BucketState | undefined>

Defined in: packages/rest/src/redis.ts:534

Gets the current state for a bucket key.

string

Promise<BucketState | undefined>

RateLimitStore.getBucket


getBucketHash(route): Promise<string | undefined>

Defined in: packages/rest/src/redis.ts:506

Gets the server bucket hash for a normalized route.

string

Promise<string | undefined>

RateLimitStore.getBucketHash


getGlobalReset(scope?): Promise<number>

Defined in: packages/rest/src/redis.ts:694

Gets the global reset timestamp (of scope, when the store keeps several).

string = ""

Promise<number>

RateLimitStore.getGlobalReset


isHealthy(): boolean

Defined in: packages/rest/src/redis.ts:348

Whether no Redis operation has failed since construction or the last successful one.

boolean


setBucketHash(route, hash): Promise<void>

Defined in: packages/rest/src/redis.ts:517

Associates a route with a server bucket hash.

string

string

Promise<void>

RateLimitStore.setBucketHash


setGlobalReset(resetAt, scope?): Promise<void>

Defined in: packages/rest/src/redis.ts:706

Sets the global reset timestamp (of scope, when the store keeps several).

number

string = ""

Promise<void>

RateLimitStore.setGlobalReset


updateBucket(key, state): Promise<void>

Defined in: packages/rest/src/redis.ts:551

Replaces the state for a bucket key.

string

BucketState

Promise<void>

RateLimitStore.updateBucket


verify(): Promise<void>

Defined in: packages/rest/src/redis.ts:387

Checks that the client can run the store’s scripts (some managed Redis services disable EVAL). Call it at startup to fail fast.

Promise<void>

If the client has no eval.

Of kind "coordination", if the script cannot run.