Redis storage provider for the @nestjs/throttler package
npm install @nest-lab/throttler-storage-redisRedis storage provider for the
@nestjs/throttler package.
- yarn add @nest-lab/throttler-storage-redis ioredis
- npm install --save @nest-lab/throttler-storage-redis ioredis
Basic usage:
``ts
import { ThrottlerModule, seconds } from '@nestjs/throttler';
import { ThrottlerStorageRedisService } from '@nest-lab/throttler-storage-redis';
import Redis from 'ioredis';
@Module({
imports: [
ThrottlerModule.forRoot({
throttlers: [{ limit: 5, ttl: seconds(60) }],
// Below are possible options on how to configure the storage service.
// default config (host = localhost, port = 6379)
storage: new ThrottlerStorageRedisService(),
// connection url
storage: new ThrottlerStorageRedisService('redis://'),
// redis object
storage: new ThrottlerStorageRedisService(new Redis()),
// redis clusters
storage: new ThrottlerStorageRedisService(
new Redis.Cluster(nodes, options)
),
}),
],
})
export class AppModule {}
`
Inject another config module and service:
`ts
import { ThrottlerModule } from '@nestjs/throttler';
import { ThrottlerStorageRedisService } from '@nest-lab/throttler-storage-redis';
@Module({
imports: [
ThrottlerModule.forRootAsync({
imports: [ConfigModule],
inject: [ConfigService],
useFactory: (config: ConfigService) => ({
throttlers: [
{
ttl: config.get('THROTTLE_TTL'),
limit: config.get('THROTTLE_LIMIT'),
},
],
storage: new ThrottlerStorageRedisService(),
}),
}),
],
})
export class AppModule {}
``
Bugs and features related to the redis implementation are welcome in this
repository.
NestJS Throttler Redis Storage is licensed under the MIT license.