Skip to main content
Version: v2.10.2 (current)

Interface: RedisConfig

Redis connection configuration used by the manager when StateStorageType is set to redis.

RedisConfig extends ioredis RedisOptions directly, so the full ioredis configuration surface is available. The only field added on top is prefix.

Property Type Description Optional
prefixstringPrefix applied to all Redis keys written by MagmaStream.
...all ioredis RedisOptionshost, port, password, db, TLS, cluster config, etc. are inherited.

Example:

stateStorage: {
type: StateStorageType.Redis,
redisConfig: {
host: "localhost",
port: 6379,
password: "secret",
db: 0,
prefix: "magmastream:",
},
}