@spoosh/plugin-throttle 0.1.10 → 0.1.11

package/README.md

@@ -16,7 +16,7 @@ npm install @spoosh/plugin-throttle
 import { Spoosh } from "@spoosh/core";
 import { throttlePlugin } from "@spoosh/plugin-throttle";
 
-const client = new Spoosh<ApiSchema, Error>("/api").use([
+const spoosh = new Spoosh<ApiSchema, Error>("/api").use([
   // ...otherPlugins,
   throttlePlugin(),
 ]);
@@ -34,6 +34,6 @@ const { data } = useRead((api) => api("expensive").GET(), { throttle: 1000 });
 
 ## Notes
 
-- Register this plugin at the end of your plugin list, to make sure it block even force fetch requests.
+- This plugin runs with priority 100, automatically executing last in the middleware chain to block all requests (including force fetches) that exceed the throttle limit
 - Unlike debounce (which delays), throttle immediately returns cached data for extra requests
 - Useful for rate-limiting expensive endpoints

package/dist/index.d.mts

@@ -15,16 +15,19 @@ type ThrottleWriteResult = object;
  * Limits how frequently a query can be executed, returning cached data
  * if the throttle window hasn't elapsed.
  *
+ * This plugin runs with priority 100, meaning it executes last in the middleware chain
+ * to block all requests (including force fetches) that exceed the throttle limit.
+ *
  * @see {@link https://spoosh.dev/docs/react/plugins/throttle | Throttle Plugin Documentation}
  *
  * @example
  * ```ts
  * import { Spoosh } from "@spoosh/core";
  *
- * const client = new Spoosh<ApiSchema, Error>("/api")
+ * const spoosh = new Spoosh<ApiSchema, Error>("/api")
  *   .use([
- *     // ... other plugins
  *     throttlePlugin(),
+ *     // ... other plugins
  *   ]);
  *
  * // Throttle to max once per second

package/dist/index.d.ts

@@ -15,16 +15,19 @@ type ThrottleWriteResult = object;
  * Limits how frequently a query can be executed, returning cached data
  * if the throttle window hasn't elapsed.
  *
+ * This plugin runs with priority 100, meaning it executes last in the middleware chain
+ * to block all requests (including force fetches) that exceed the throttle limit.
+ *
  * @see {@link https://spoosh.dev/docs/react/plugins/throttle | Throttle Plugin Documentation}
  *
  * @example
  * ```ts
  * import { Spoosh } from "@spoosh/core";
  *
- * const client = new Spoosh<ApiSchema, Error>("/api")
+ * const spoosh = new Spoosh<ApiSchema, Error>("/api")
  *   .use([
- *     // ... other plugins
  *     throttlePlugin(),
+ *     // ... other plugins
  *   ]);
  *
  * // Throttle to max once per second

package/dist/index.js

@@ -30,6 +30,7 @@ function throttlePlugin() {
   return {
     name: "spoosh:throttle",
     operations: ["read", "infiniteRead"],
+    priority: 100,
     middleware: async (context, next) => {
       const pluginOptions = context.pluginOptions;
       const throttleMs = pluginOptions?.throttle;

package/dist/index.mjs

@@ -4,6 +4,7 @@ function throttlePlugin() {
   return {
     name: "spoosh:throttle",
     operations: ["read", "infiniteRead"],
+    priority: 100,
     middleware: async (context, next) => {
       const pluginOptions = context.pluginOptions;
       const throttleMs = pluginOptions?.throttle;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spoosh/plugin-throttle",
-  "version": "0.1.10",
+  "version": "0.1.11",
   "description": "Request throttling plugin for Spoosh - limits request frequency",
   "license": "MIT",
   "repository": {
@@ -33,11 +33,11 @@
     }
   },
   "peerDependencies": {
-    "@spoosh/core": ">=0.12.0"
+    "@spoosh/core": ">=0.12.1"
   },
   "devDependencies": {
-    "@spoosh/test-utils": "0.1.8",
-    "@spoosh/core": "0.12.0"
+    "@spoosh/core": "0.12.1",
+    "@spoosh/test-utils": "0.1.8"
   },
   "scripts": {
     "dev": "tsup --watch",