Getting Started

---

The Redis Library, based on ioredis, provides an opinionated Redis setup for the Softkit ecosystem, solving common configuration challenges in NestJS applications.

Installation

yarn add @softkit/redis

Basic Usage

To integrate Redis into your application:

Default Configuration

import { setupRedisModule } from '@softkit/redis';

@Module({
  imports: [setupRedisModule()],
})
export class YourAppModule {}

Update Root Configuration

import { RedisConfig } from '@softkit/redis';

export class RootConfig {
  @Type(() => RedisConfig)
  @ValidateNested()
  public readonly redis!: RedisConfig;
}

Environment Configuration

Define Redis configurations in your .env.yaml file:

redis:
  readyLog: true
  errorLog: true
  commonConfig:
    commandTimeout: 5000
    ...
  config:
    - url: 'redis://localhost'
      ...

Next Steps

• For a detailed breakdown of configuration options and defaults, proceed to the Configuration section.
• Explore advanced features and practical implementations in the Features section.