updated types

Author: jondeweydev

src/@types/rateLimit.d.ts

@@ -45,7 +45,19 @@ export interface TokenBucketOptions {
     refillRate: number;
 }
 
+/**
+ * @type {number} windowSize - Size of each fixed window and the rolling window
+ * @type {number} capacity - Number of tokens a window can hold
+ */
+export interface SlidingWindowCounterOptions {
+    windowSize: number;
+    capacity: number;
+}
+
 // TODO: This will be a union type where we can specify Option types for other Rate Limiters
 // Record<string, never> represents the empty object for alogorithms that don't require settings
 // and might be able to be removed in the future.
-export type RateLimiterOptions = TokenBucketOptions | Record<string, never>;
+export type RateLimiterOptions =
+    | TokenBucketOptions
+    | SlidingWindowCounterOptions
+    | Record<string, never>;

src/rateLimiters/slidingWindowCounter.ts

@@ -166,7 +166,10 @@ class SlidingWindowCounter implements RateLimiter {
 
         // if request is blocked
         await this.client.setex(uuid, keyExpiry, JSON.stringify(updatedUserWindow));
-        return { success: false, tokens: this.capacity - updatedUserWindow.currentTokens };
+        return {
+            success: false,
+            tokens: this.capacity - (updatedUserWindow.currentTokens + previousRollingTokens),
+        };
     }
 
     /**