Skip to content
English

RedisCacheOptionsType

RedisCacheOptionsType = object

Defined in: src/cache/RedisCacheOptions.ts:6

Plain options-object shape accepted by a RedisCache.

readonly optional client?: RedisClientLike

Defined in: src/cache/RedisCacheOptions.ts:25

Pre-built ioredis client — bypass internal construction (advanced usage: connection sharing, custom retry strategies, Redis Cluster).


readonly optional db?: number

Defined in: src/cache/RedisCacheOptions.ts:15


readonly optional host?: string

Defined in: src/cache/RedisCacheOptions.ts:12


readonly optional keyPrefix?: string

Defined in: src/cache/RedisCacheOptions.ts:20

Optional key prefix prepended to every key. Useful when a single Redis instance is shared by multiple actor systems / environments.


readonly optional password?: string

Defined in: src/cache/RedisCacheOptions.ts:14


readonly optional port?: number

Defined in: src/cache/RedisCacheOptions.ts:13


readonly optional url?: string

Defined in: src/cache/RedisCacheOptions.ts:11

Redis URL (e.g. redis://localhost:6379) — passed straight to the ioredis constructor. Mutually exclusive with host/port.