redis-client

Description

Redis library for NestJS built in Nx.

Installation

$ npm i @argotools/redis-client

Quick start

1. Register RedisClientModule in root module:

@Module({
    imports: [
        RedisClientModule.forRoot({
          config: {
            host: 'localhost',
            port: 6379,
          },
        }),
    ]
})
export class AppModule {}

2. Declare your redis entity:

@RedisEntity({
  keyPrefix: 'test',
  ttlMilliseconds: 3600,
})
export class MyRedisEntity {
  @PrimaryKey()
  id: string;
  value: string;
}

3. Register redis entities in feature modules to use redis repositories:

@Module({
    imports: [
        RedisClientModule.forFeature([MyRedisEntity]),
    ]
})
export class FeatureModule {}

HINT: Do above if you want to use provided redis repository by library for redis entities.

You can create your custom redis repository. If you are using custom repository just skip providing entities in feature modules.

Here is example of creating custom repository: here

Custom repositories

1. Declare your repository class:

@Injectable()
export class MyRedisRepository extends Repository<MyRedisEntity> {
  constructor(@InjectRedis() private readonly redis: Redis) {
    super(redis, {
      baseClass: MyRedisEntity,
    });
  }
}

2. Register repository in your feature module:

@Module({
    providers: [
       MyRedisRepository
    ]
})
export class FeatureModule {}