RedisAdapterConfig
Defined in: packages/gateway/src/adapters/redis.ts:41
Config accepted by redisAdapter() - client, prefix, setWithTTL override, store toggles.
Properties
Section titled “Properties”client
Section titled “client”client:
RedisClient
Defined in: packages/gateway/src/adapters/redis.ts:43
Redis client instance (ioredis, node-redis, etc.).
prefix?
Section titled “prefix?”
optionalprefix?:string
Defined in: packages/gateway/src/adapters/redis.ts:45
Key prefix for all Redis keys. Default: "stoma:".
setWithTTL?
Section titled “setWithTTL?”
optionalsetWithTTL?: (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)Parameters
Section titled “Parameters”client
Section titled “client”string
string
ttlSeconds
Section titled “ttlSeconds”number
Returns
Section titled “Returns”Promise<unknown>
stores?
Section titled “stores?”
optionalstores?:object
Defined in: packages/gateway/src/adapters/redis.ts:61
Selectively enable/disable individual stores. All enabled by default.
cache?
Section titled “cache?”
optionalcache?:boolean
circuitBreaker?
Section titled “circuitBreaker?”
optionalcircuitBreaker?:boolean
rateLimit?
Section titled “rateLimit?”
optionalrateLimit?:boolean
waitUntil?
Section titled “waitUntil?”
optionalwaitUntil?: (promise) =>void
Defined in: packages/gateway/src/adapters/redis.ts:67
Schedule background work that outlives the response.
Parameters
Section titled “Parameters”promise
Section titled “promise”Promise<unknown>
Returns
Section titled “Returns”void