Skip to main content

initRedis

function initRedis(config: Object = {})
async

Initializes a Redis client using the redis package.

Returns: Promise<Object>

  • Resolves to a connected Redis client instance.
PARAMETERTYPEOPTIONALDEFAULTDESCRIPTION
configObject✔️Redis configuration options.
See the official redis package documentation for more details:
config.urlstringRedis connection URL.
config.redisConfigObject✔️Additional redis client configuration options.

Throws: Error

Rejects if config.url is missing or the connection fails.
See:

const redisClient = await initRedis({ url: "redis://localhost:6379" });