@nest-boot/redis

Classes

RedisModule

Defined in: packages/redis/src/redis.module.ts:75

Module that provides Redis connection using ioredis.

The module automatically loads configuration from environment variables if not provided:

• REDIS_URL: Full Redis connection URL (e.g., redis://user:pass@host:6379/0)
• REDIS_HOST: Redis server hostname
• REDIS_PORT: Redis server port
• REDIS_DB or REDIS_DATABASE: Redis database number
• REDIS_USER or REDIS_USERNAME: Redis username
• REDIS_PASS or REDIS_PASSWORD: Redis password
• REDIS_TLS: Enable TLS connection

Examples

import { RedisModule } from '@nest-boot/redis';

@Module({
  imports: [
    RedisModule.register({
      host: 'localhost',
      port: 6379,
      isGlobal: true,
    }),
  ],
})
export class AppModule {}

// Inject Redis client in your service
import { Redis } from 'ioredis';

@Injectable()
export class CacheService {
  constructor(private readonly redis: Redis) {}

  async get(key: string): Promise<string | null> {
    return this.redis.get(key);
  }
}

Extends

• ConfigurableModuleClass

Implements

• OnApplicationShutdown

Indexable

[key: string]: any

Constructors

Constructor

new RedisModule(redis): RedisModule;

Defined in: packages/redis/src/redis.module.ts:103

Creates an instance of RedisModule.

Parameters

Parameter	Type	Description
redis	Redis	The Redis client instance

Returns

RedisModule

Overrides

ConfigurableModuleClass.constructor

Methods

onApplicationShutdown()

onApplicationShutdown(): Promise<void>;

Defined in: packages/redis/src/redis.module.ts:110

Gracefully closes the Redis connection when the application shuts down.

Returns

Promise<void>

Implementation of

OnApplicationShutdown.onApplicationShutdown

register()

static register(options): DynamicModule;

Defined in: packages/redis/src/redis.module.ts:84

Registers the RedisModule with the given options.

Parameters

Parameter	Type	Description
options	CommonRedisOptions & SentinelConnectionOptions & Partial<TcpOptions & IpcOptions> & { disconnectTimeout?: number; tls?: ConnectionOptions; } & Partial<{ }>	Redis connection options and isGlobal flag

Returns

DynamicModule

Dynamic module configuration

Overrides

ConfigurableModuleClass.register

registerAsync()

static registerAsync(options): DynamicModule;

Defined in: packages/redis/src/redis.module.ts:93

Registers the RedisModule asynchronously with factory functions.

Parameters

Parameter	Type	Description
options	ConfigurableModuleAsyncOptions<RedisOptions, "create"> & Partial<{ }>	Async configuration options

Returns

DynamicModule

Dynamic module configuration

Overrides

ConfigurableModuleClass.registerAsync

Functions

loadConfigFromEnv()

function loadConfigFromEnv(): RedisOptions;

Defined in: packages/redis/src/utils/load-config-from-env.util.ts:17

Loads Redis configuration from environment variables.

Supports the following environment variables:

• REDIS_URL: Full Redis connection URL (takes precedence over individual settings)
• REDIS_HOST: Redis server hostname
• REDIS_PORT: Redis server port
• REDIS_DB or REDIS_DATABASE: Redis database number
• REDIS_USER or REDIS_USERNAME: Redis username
• REDIS_PASS or REDIS_PASSWORD: Redis password
• REDIS_TLS: Enable TLS connection (any truthy value)

Returns

RedisOptions

Redis connection options parsed from environment variables