initRedis
function initRedis(config: Object = {})
async
Initializes a Redis client using the redis package.
Returns: Promise<Object>
- Resolves to a connected Redis client instance.
| PARAMETER | TYPE | OPTIONAL | DEFAULT | DESCRIPTION |
|---|---|---|---|---|
| config | Object | ✔️ | Redis configuration options. See the official redis package documentation for more details: | |
| config.url | string | Redis connection URL. | ||
| config.redisConfig | Object | ✔️ | 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" });