@nestjs-modules/ioredis

A ioredis module for the NestJS framework.

Installation

pnpm add @nestjs-modules/ioredis ioredis

Quick Start

import { Module } from '@nestjs/common';
import { RedisModule } from '@nestjs-modules/ioredis';

@Module({
  imports: [
    RedisModule.forRoot({
      type: 'single',
      url: 'redis://localhost:6379',
    }),
  ],
})
export class AppModule {}

import { Controller, Get } from '@nestjs/common';
import { InjectRedis } from '@nestjs-modules/ioredis';
import Redis from 'ioredis';

@Controller()
export class AppController {
  constructor(@InjectRedis() private readonly redis: Redis) {}

  @Get()
  async ping() {
    await this.redis.set('key', 'value');
    return this.redis.get('key');
  }
}

Documentation

Full documentation is available at nest-modules.github.io/ioredis.

• Getting Started
• Configuration
• Cluster
• Health Checks
• Testing

License

MIT