https://github.com/muradisazade777/ts-rate-limiter
A modular, scalable, and production-ready API rate limiter built with TypeScript and Redis. Designed for Express and Fastify, this package provides plug-and-play middleware, CLI tools, and branded configuration for managing request limits across endpoints and IPs.
https://github.com/muradisazade777/ts-rate-limiter
api backend backend-api config configuration javascript js json redis testing token ts typescript
Last synced: 9 months ago
JSON representation
A modular, scalable, and production-ready API rate limiter built with TypeScript and Redis. Designed for Express and Fastify, this package provides plug-and-play middleware, CLI tools, and branded configuration for managing request limits across endpoints and IPs.
- Host: GitHub
- URL: https://github.com/muradisazade777/ts-rate-limiter
- Owner: MuradIsazade777
- License: other
- Created: 2025-11-06T15:55:29.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-11-06T16:24:52.000Z (9 months ago)
- Last Synced: 2025-11-06T18:16:56.600Z (9 months ago)
- Topics: api, backend, backend-api, config, configuration, javascript, js, json, redis, testing, token, ts, typescript
- Language: TypeScript
- Homepage:
- Size: 13.9 MB
- Stars: 3
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🚦 TS Rate Limiter
A modular, scalable, and production-ready API rate limiter built with TypeScript and Redis. Designed for Express and Fastify, this package provides plug-and-play middleware, CLI tools, and branded configuration for managing request limits across endpoints and IPs.
---
## ✨ Features
- 🔧 Token Bucket / Sliding Window algorithm
- 🧠 Redis-based usage tracking
- 🧩 Express & Fastify middleware support
- 🛠️ CLI tools for stats and reset
- 📦 Modular architecture with clean separation of concerns
- 📊 Configurable via JSON or YAML
- 🧪 Fully tested with Jest
---
## 📦 Installation
```bash
npm install ts-rate-limiter
```
## 🚀 Usage
### Express Integration
```ts
import express from 'express';
import { expressLimiter } from 'ts-rate-limiter';
import { RateLimiter, RedisAdapter, loadConfig } from 'ts-rate-limiter';
const app = express();
const config = loadConfig();
const adapter = new RedisAdapter(process.env.REDIS_URL || 'redis://localhost:6379');
const limiter = new RateLimiter(config, adapter);
app.use(expressLimiter(limiter));
app.get('/api', (req, res) => res
```
CLI Commands
```bash
# Show usage stats
npm run cli stats 127.0.0.1:/api
# Reset usage for a key
npm run cli reset 127.0.0.1:/api
```
🧪 Testing
```bash
npm test
```
Each folder is modular and purpose-driven:
- **core/** – Implements the rate limiting logic and exposes the public API.
- **adapters/** – Contains pluggable storage backends (e.g., Redis, in-memory).
- **middleware/** – Provides ready-to-use integrations for Express and Fastify.
- **config/** – Loads default configurations and limit presets.
- **cli/** – CLI interface with commands and branding banner.
- **utils/** – Shared utilities like logging and time calculations.
- **tests/** – Comprehensive Jest test coverage for all modules.
📜 License
This project is licensed under the MIT License. See the LICENSE file for details.
💡 Author
Murad — Backend Architect & Full Stack Developer Crafted with precision, modularity, and branded elegance ✨