Skip to content

RedisAdapterConfig

Defined in: packages/gateway/src/adapters/redis.ts:41

Config accepted by redisAdapter() - client, prefix, setWithTTL override, store toggles.

client: RedisClient

Defined in: packages/gateway/src/adapters/redis.ts:43

Redis client instance (ioredis, node-redis, etc.).


optional prefix?: string

Defined in: packages/gateway/src/adapters/redis.ts:45

Key prefix for all Redis keys. Default: "stoma:".


optional setWithTTL?: (client, key, value, ttlSeconds) => Promise<unknown>

Defined in: packages/gateway/src/adapters/redis.ts:54

Override for SET-with-TTL. Default uses ioredis-style client.set(key, value, "EX", ttl).

For node-redis v4:

(c, k, v, ttl) => c.set(k, v, { EX: ttl } as any)

RedisClient

string

string

number

Promise<unknown>


optional stores?: object

Defined in: packages/gateway/src/adapters/redis.ts:61

Selectively enable/disable individual stores. All enabled by default.

optional cache?: boolean

optional circuitBreaker?: boolean

optional rateLimit?: boolean


optional waitUntil?: (promise) => void

Defined in: packages/gateway/src/adapters/redis.ts:67

Schedule background work that outlives the response.

Promise<unknown>

void