Class RedisService<M, F, S>

The redis connection manager (single instance or cluster).

Type Parameters

M extends RedisModules = RedisModules
F extends RedisFunctions = RedisFunctions
S extends RedisScripts = RedisScripts

Implements

OnModuleDestroy

Index

Constructors

Methods

getClient getClientType getCluster getClusterInfo getClusterOrThrow healthCheck isClusterMode isConnected onModuleDestroy waitForReady

Constructors

constructor

new RedisService<
    M extends RedisModules = RedisModules,
    F extends RedisFunctions = RedisFunctions,
    S extends RedisScripts = RedisScripts,
>(
    client: RedisClientType<M, F, S> | RedisClusterType<M, F, S>,
): RedisService<M, F, S>
Type Parameters
- M extends RedisModules = RedisModules
- F extends RedisFunctions = RedisFunctions
- S extends RedisScripts = RedisScripts
Parameters
- client: RedisClientType<M, F, S> | RedisClusterType<M, F, S>
Returns RedisService<M, F, S>
- Defined in packages/node-redis/lib/redis.service.ts:17

Methods

getClient

getClient(): RedisClientType<M, F, S> | RedisClusterType<M, F, S>
Get the redis client instance.

Returns RedisClientType<M, F, S> | RedisClusterType<M, F, S>
- Defined in packages/node-redis/lib/redis.service.ts:22

getClientType

getClientType(): "single" | "cluster"
Get client type information.

Returns "single" | "cluster"
- Defined in packages/node-redis/lib/redis.service.ts:101

getCluster

getCluster(): null | RedisClusterType<M, F, S>
Get the redis cluster client instance. Returns null if the client is not in cluster mode.

Returns null | RedisClusterType<M, F, S>
- Defined in packages/node-redis/lib/redis.service.ts:69

getClusterInfo

getClusterInfo(): | "single"
| { masters: number; nodes: string[]; type: "cluster" }
Get cluster information if in cluster mode.

Returns "single" | { masters: number; nodes: string[]; type: "cluster" }
- Defined in packages/node-redis/lib/redis.service.ts:108

getClusterOrThrow

getClusterOrThrow(): RedisClusterType<M, F, S>
Get the redis cluster client instance. Throws an error if the client is not in cluster mode.

Returns RedisClusterType<M, F, S>
- Defined in packages/node-redis/lib/redis.service.ts:82

healthCheck

healthCheck(): Promise<{ message?: string; status: "up" | "down" }>
Health check for the Redis connection.

Returns Promise<{ message?: string; status: "up" | "down" }>
- Defined in packages/node-redis/lib/redis.service.ts:45

isClusterMode

isClusterMode(): boolean
Check if the client is in cluster mode.

Returns boolean
- Defined in packages/node-redis/lib/redis.service.ts:93

isConnected

isConnected(): boolean
Check if the client is connected.

Returns boolean
- Defined in packages/node-redis/lib/redis.service.ts:29

onModuleDestroy

onModuleDestroy(): Promise<void>
Quit the redis client instance.

Returns Promise<void>
Implementation of OnModuleDestroy.onModuleDestroy
- Defined in packages/node-redis/lib/redis.service.ts:135

waitForReady

waitForReady(): Promise<void>
Wait for the client to be ready.

Returns Promise<void>
- Defined in packages/node-redis/lib/redis.service.ts:36