bucketflow 1.0.0 → 1.0.1

package/README.md

@@ -31,12 +31,12 @@ optional rejection message.
 ```ts
 import { FixedWindow } from "bucketflow";
 
-const limiter = new FixedWindow("api", "Too many requests", 100, 60_000);
+const limiter = new FixedWindow(100, 60_000);
 const result = limiter.checkLimit("user-123");
 ```
 
-The constructor accepts a limiter key, optional rejection message, maximum
-requests, and window duration in milliseconds.
+The constructor accepts the maximum number of requests, the window duration
+in milliseconds, and an optional rejection message.
 
 ### Sliding window
 
@@ -48,7 +48,16 @@ const result = limiter.checkLimit("user-123");
 ```
 
 The constructor accepts the window duration, refresh rate, maximum requests,
-and an optional rejection message. Durations are in milliseconds.
+and an optional rejection message. Durations and rates are in milliseconds.
+
+## Return values
+
+Each limiter returns an object with an `allowed` boolean and a message. The
+additional field depends on the limiter:
+
+- `TokenBucket`: `tokens` is the number of tokens remaining.
+- `FixedWindow`: `reqRemaining` is the reported number of requests remaining.
+- `SlidingWindow`: `counter` is the current request counter.
 
 ## Framework integrations
 
@@ -133,14 +142,15 @@ same pattern into a NestJS guard when route-level control is preferred.
 
 ## API
 
-The package currently exports:
+The package currently exports these classes:
 
 - `TokenBucket`
 - `FixedWindow`
 - `SlidingWindow`
 
-All limiters are in-memory and local to the running process. They are not
-intended to coordinate limits across multiple Node.js processes or servers.
+All limiters are in-memory and local to the running process. They do not share
+state across multiple Node.js processes or servers, and state is lost when the
+process restarts.
 
 ## License
 

package/dist/fixed-window.d.ts

@@ -1,11 +1,10 @@
-import { FixedWindowProps, FixedWindowResponse } from "../types";
+import type { FixedWindowProps, FixedWindowResponse } from "../types";
 export declare class FixedWindow implements FixedWindowProps {
-    key: string;
     private store;
     message: string;
     maxNum: number;
     window: number;
-    constructor(key: string, message: string | undefined, maxNum: number, window: number);
+    constructor(maxNum: number, window: number, message?: string);
     checkLimit(key: string): FixedWindowResponse;
 }
 //# sourceMappingURL=fixed-window.d.ts.map

package/dist/fixed-window.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fixed-window.d.ts","sourceRoot":"","sources":["../src/fixed-window.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAS,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAExE,qBAAa,WAAY,YAAW,gBAAgB;IAClD,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,CAAC,KAAK,CAAiC;IAC9C,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IAEf,YACE,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,MAAM,YAAsB,EACrC,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EAMf;IAED,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,mBAAmB,CA0C3C;CACF"}
+{"version":3,"file":"fixed-window.d.ts","sourceRoot":"","sources":["../src/fixed-window.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAS,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAE7E,qBAAa,WAAY,YAAW,gBAAgB;IAClD,OAAO,CAAC,KAAK,CAAiC;IAC9C,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IAEf,YACE,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,OAAO,GAAE,MAA4B,EAKtC;IACD,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,mBAAmB,CA0C3C;CACF"}

package/dist/index.js

@@ -28,9 +28,8 @@ module.exports = __toCommonJS(index_exports);
 
 // src/fixed-window.ts
 var FixedWindow = class {
-  constructor(key, message = "Too many requests", maxNum, window) {
+  constructor(maxNum, window, message = "Too many requests") {
     this.store = /* @__PURE__ */ new Map();
-    this.key = key;
     this.message = message;
     this.maxNum = maxNum;
     this.window = window;

package/dist/index.mjs

@@ -1,8 +1,7 @@
 // src/fixed-window.ts
 var FixedWindow = class {
-  constructor(key, message = "Too many requests", maxNum, window) {
+  constructor(maxNum, window, message = "Too many requests") {
     this.store = /* @__PURE__ */ new Map();
-    this.key = key;
     this.message = message;
     this.maxNum = maxNum;
     this.window = window;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bucketflow",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Rate limiting for Node.js with token bucket, fixed window, and leaky bucket algorithms",
   "main": "dist/index.js",
   "keywords": [