@canmertinyo/rate-limit-express 1.3.4 → 1.3.6

package/README.md

@@ -1,15 +1,15 @@
 # Express Rate Limiter
+
 ### A simple in-memory rate-limiting middleware for Express.js to restrict the number of requests a client can make within a given time. Ideal for lightweight use cases
 
+To install :
 
-To install : 
 ```typescript
 npm i @canmertinyo/rate-limit-express
 ```
 
+# Example usage :
 
-
-# Example usage : 
 ```typescript
 import express from "express";
 import { rateLimiter } from "@canmertinyo/rate-limit-express";
@@ -21,6 +21,7 @@ app.use(
   rateLimiter({
     ms: 60000, // Time in milliseconds
     maxRequest: 5, // Maximum requests allowed within the time
+    //DEFAULT IS IN MEMORY
   })
 );
 
@@ -31,5 +32,64 @@ app.get("/", (req, res) => {
 app.listen(3000, () => {
   console.log("Server is running on http://localhost:3000");
 });
+```
+
+# Using Redis As A Store Manager
+
+```typescript
+import express from "express";
+import { rateLimiter, RedisStorage } from "@canmertinyo/rate-limit-express";
+
+const app = express();
+const port = 3001;
+
+// Configure the rate limiter with Redis storage
+app.use(
+  rateLimiter({
+    ms: 5000, // Time window in milliseconds
+    maxRequest: 2, // Maximum requests allowed in the time window
+    storage: new RedisStorage({ host: "127.0.0.1", port: 6379 }), // Redis configuration
+  })
+);
+
+// Sample route
+app.get("/", (req, res) => {
+  res.send("Hello World!");
+});
+
+// Start the server
+app.listen(port, () => {
+  console.log(`Server listening on port ${port}`);
+});
+```
+
+# Using Mongo As A Store Manager
+
+```typescript
+import express from "express";
+import { MongoStorage, rateLimiter } from "@canmertinyo/rate-limit-express";
+
+const app = express();
+const port = 3001;
+
+// MongoDB connection string (replace with your MongoDB URL)
+const mongoUrl = "mongodb://your-mongodb-url";
+
+app.use(
+  rateLimiter({
+    ms: 5000, // Time window in milliseconds
+    maxRequest: 2, // Maximum requests allowed in the time window
+    storage: new MongoStorage(mongoUrl), // MongoDB configuration
+  })
+);
+
+// Sample route
+app.get("/", (req, res) => {
+  res.send("Hello World!");
+});
 
+// Start the server
+app.listen(port, () => {
+  console.log(`Server listening on port ${port}`);
+});
 ```

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@canmertinyo/rate-limit-express",
   "description": "A simple rate-limiting middleware for Express.js",
-  "version": "1.3.4",
+  "version": "1.3.6",
   "main": "dist/index.js",
   "license": "MIT",
   "types": "dist/index.d.ts",
@@ -18,8 +18,10 @@
   "author": "c4nzin",
   "devDependencies": {
     "@types/express": "^5.0.0",
-    "typescript": "^5.7.2",
+    "@types/mongoose": "^5.11.97",
     "ioredis": "^5.4.1",
-    "mongoose": "^8.8.3"
+    "lerna": "^8.1.9",
+    "mongoose": "^8.8.3",
+    "typescript": "^5.7.2"
   }
 }

package/src/storages/mongo.storage.ts

@@ -5,8 +5,6 @@ import { RateLimitModel } from "./schemas/rate-limit.schema";
 export class MongoStorage implements RateLimiter {
   private model: mongoose.Model<RateLimitRecord>;
 
-  //DEFAULT DB URI VERRIRSEK PATLICAZ GİBİ AMA BAKARIZ, AZ KÖTÜ🤨
-  //connect-mongo kütüphanesini kullanarak yapsak?
   constructor(public mongoDbUrl: string = "mongodb://127.0.0.1:27017") {
     mongoose
       .connect(mongoDbUrl)

package/src/storages/redis.storage.ts

@@ -28,6 +28,7 @@ export class RedisStorage implements RateLimiter {
   public async createRateLimitRecord(
     record: RateLimitRecord
   ): Promise<RateLimitRecord> {
+    //json objesine döndürmeden başka bir yol gibi..
     await this.redis.set(record.key, JSON.stringify(record));
     return record;
   }