@alxia/rate-limit 0.4.0 → 0.4.1

package/README.md

@@ -63,12 +63,12 @@ app.use(rateLimit({ limit: 100, windowMs: 60_000, store: redisStore(redis, { nam
 
 A store that counts by a rate of its own declares it as `policy: { limit,
 windowMs }`, and `rateLimit({ store })` reads both from it, headers included:
-the numbers are written once. `redisStore(handle.limits.api, api)` does, from
-the definition `api`. A `limit` or `windowMs` given beside it that differs
+the numbers are written once. `redisStore(handle.limits.api)` does, from
+the bound limit's definition. A `limit` or `windowMs` given beside it that differs
 throws at declaration.
 
 ```ts
-app.use(rateLimit({ store: redisStore(handle.limits.api, api) }));
+app.use(rateLimit({ store: redisStore(handle.limits.api) }));
 ```
 
 A store of your own implements `RateLimitStore` (and, to count by a rate of

package/docs/guide.md

@@ -80,7 +80,7 @@ written once. Without one they are required, and a type error says so.
 import { redisStore } from '@alxia/redis';
 
 // `api` is the defineRateLimit definition the handle wired.
-app.use(rateLimit({ store: redisStore(handle.limits.api, api) })); // 100 per 60 s, from `api`
+app.use(rateLimit({ store: redisStore(handle.limits.api) })); // 100 per 60 s, from `api`
 ```
 
 A `limit` or a `windowMs` given beside a policy must equal it, or

package/docs/roadmap.md

@@ -39,7 +39,7 @@ Nothing scheduled yet.
   reads `limit` and `windowMs` from it, both optional in the type, headers
   included; without a policy they stay required. A `limit` or `windowMs` that
   differs from the policy throws at declaration. `@alxia/redis`'s
-  `redisStore(handle.limits.api, api)` is such a store. Every existing form
+  `redisStore(handle.limits.api)` is such a store. Every existing form
   works as before.
 
 ### 0.1.0

package/docs/troubleshooting.md

@@ -132,7 +132,7 @@ app.use(rateLimit({ limit: Number(Bun.env.RATE_LIMIT ?? 100), windowMs: 60_000 }
 ### `TypeError: rateLimit: limit … differs from the store's policy of …`
 
 **When:** `rateLimit()` is given a `store` that declares its own `policy`
-(`redisStore(handle.limits.api, api)`) and a `limit` or a `windowMs` that is
+(`redisStore(handle.limits.api)`) and a `limit` or a `windowMs` that is
 not the store's. It throws at declaration, so the app fails at startup:
 
 ```text
@@ -147,7 +147,7 @@ say what the store does not enforce. (`windowMs` reads the same way.)
 the rate, change the definition the store reads it from:
 
 ```ts
-app.use(rateLimit({ store: redisStore(handle.limits.api, api) }));
+app.use(rateLimit({ store: redisStore(handle.limits.api) }));
 ```
 
 ## Responses

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@alxia/rate-limit",
-	"version": "0.4.0",
+	"version": "0.4.1",
 	"description": "Rate limiting for alxia: a 429 with Retry-After past the limit, the remaining allowance typed in the context, pluggable stores",
 	"license": "MIT",
 	"type": "module",
@@ -41,12 +41,12 @@
 		]
 	},
 	"devDependencies": {
-		"@alxia/core": "^0.5.0",
+		"@alxia/core": "^0.5.1",
 		"@types/bun": "^1.4.2",
 		"zod": "^4.2.0"
 	},
 	"peerDependencies": {
-		"@alxia/core": "^0.5.0",
+		"@alxia/core": "^0.5.1",
 		"typescript": "^6.0.3 || ^7.0.0"
 	}
 }