NestJS Throttler Redis Storage

Redis storage provider for the @nestjs/throttler package.

Installation

Yarn

• yarn add @nest-lab/throttler-storage-redis ioredis

NPM

• npm install --save @nest-lab/throttler-storage-redis ioredis

Usage

Basic usage:

1import { ThrottlerModule, seconds } from '@nestjs/throttler';
2import { ThrottlerStorageRedisService } from '@nest-lab/throttler-storage-redis';
3import Redis from 'ioredis';
4
5@Module({
6  imports: [
7    ThrottlerModule.forRoot({
8      throttlers: [{ limit: 5, ttl: seconds(60) }],
9
10      // Below are possible options on how to configure the storage service.
11
12      // default config (host = localhost, port = 6379)
13      storage: new ThrottlerStorageRedisService(),
14
15      // connection url
16      storage: new ThrottlerStorageRedisService('redis://'),
17
18      // redis object
19      storage: new ThrottlerStorageRedisService(new Redis()),
20
21      // redis clusters
22      storage: new ThrottlerStorageRedisService(
23        new Redis.Cluster(nodes, options)
24      ),
25    }),
26  ],
27})
28export class AppModule {}

Inject another config module and service:

1import { ThrottlerModule } from '@nestjs/throttler';
2import { ThrottlerStorageRedisService } from '@nest-lab/throttler-storage-redis';
3
4@Module({
5  imports: [
6    ThrottlerModule.forRootAsync({
7      imports: [ConfigModule],
8      inject: [ConfigService],
9      useFactory: (config: ConfigService) => ({
10        throttlers: [
11          {
12            ttl: config.get('THROTTLE_TTL'),
13            limit: config.get('THROTTLE_LIMIT'),
14          },
15        ],
16        storage: new ThrottlerStorageRedisService(),
17      }),
18    }),
19  ],
20})
21export class AppModule {}

Issues

Bugs and features related to the redis implementation are welcome in this repository.

License

NestJS Throttler Redis Storage is licensed under the MIT license.