@shinijs/rate-limit

Appearance

@shinijs/rate-limitFlexible Rate Limiting for NestJS

Protect your APIs with distributed rate limiting powered by Redis

Get Started
View on GitHub
🚀

Redis-Powered

Distributed rate limiting with Redis support and automatic memory-based fallback

🎨

TypeScript First

Full type safety and IntelliSense support for an excellent developer experience

🔧

Flexible Configuration

Per-route rate limits with customizable time windows (seconds, minutes, hours, days)

📦

NestJS Native

Seamless integration using decorators, guards, and interceptors

🧪

Battle Tested

Comprehensive test coverage with 33 passing tests

🌐

Production Ready

Built for distributed systems with horizontal scaling support

Quick Start ​

bash
pnpm add @shinijs/rate-limit
typescript
import { Controller, Get, UseGuards } from '@nestjs/common';
import { RateLimit, RateLimitGuard } from '@shinijs/rate-limit';

@Controller('api')
@UseGuards(RateLimitGuard)
export class ApiController {
  @Get('users')
  @RateLimit({ requests: 100, window: '1m' }) // 100 requests per minute
  getUsers() {
    return { users: [] };
  }

  @Get('sensitive')
  @RateLimit({ requests: 5, window: '1h' }) // Stricter limit for sensitive endpoints
  getSensitiveData() {
    return { data: 'secret' };
  }
}

Installation ​

See the Installation Guide for detailed setup instructions.

Key Features ​

  • ✅ Distributed Rate Limiting - Redis-backed rate limiting for multi-instance deployments
  • ✅ Automatic Fallback - Gracefully falls back to memory-based limiting when Redis is unavailable
  • ✅ Multiple Integration Patterns - Use decorators, guards, interceptors, or service directly
  • ✅ Flexible Time Windows - Support for seconds, minutes, hours, and days
  • ✅ TypeScript Support - Full type definitions and IntelliSense
  • ✅ Health Monitoring - Built-in health check for Redis connectivity

Documentation ​