Skip to content
Stoma

RedisAdapterConfig

Defined in: 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: src/adapters/redis.ts:43

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

prefix?

Section titled “prefix?”

optional prefix: string

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

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

setWithTTL()?

Section titled “setWithTTL()?”

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

Defined in: 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”

RedisClient

key
Section titled “key”

string

value
Section titled “value”

string

ttlSeconds
Section titled “ttlSeconds”

number

Returns

Section titled “Returns”

Promise<unknown>

stores?

Section titled “stores?”

optional stores: object

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

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

cache?

Section titled “cache?”

optional cache: boolean

circuitBreaker?

Section titled “circuitBreaker?”

optional circuitBreaker: boolean

rateLimit?

Section titled “rateLimit?”

optional rateLimit: boolean

waitUntil()?

Section titled “waitUntil()?”

optional waitUntil: (promise) => void

Defined in: 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