@spoosh/plugin-throttle 0.1.1 → 0.1.3

package/README.md

@@ -13,14 +13,14 @@ npm install @spoosh/plugin-throttle
 ## Usage
 
 ```typescript
+import { Spoosh } from "@spoosh/core";
 import { throttlePlugin } from "@spoosh/plugin-throttle";
 
-const plugins = [
+const client = new Spoosh<ApiSchema, Error>("/api").use([
   // ...otherPlugins,
-  throttlePlugin(), // register at end to block even force fetches
-] as const;
+  throttlePlugin(),
+]);
 
-// Max 1 request per second - extras return cached data
 const { data } = useRead((api) => api.expensive.$get(), { throttle: 1000 });
 ```
 

package/dist/index.d.mts

@@ -19,7 +19,13 @@ type ThrottleWriteResult = object;
  *
  * @example
  * ```ts
- * const plugins = [throttlePlugin()];
+ * import { Spoosh } from "@spoosh/core";
+ *
+ * const client = new Spoosh<ApiSchema, Error>("/api")
+ *   .use([
+ *     // ... other plugins
+ *     throttlePlugin(),
+ *   ]);
  *
  * // Throttle to max once per second
  * useRead((api) => api.posts.$get(), {

package/dist/index.d.ts

@@ -19,7 +19,13 @@ type ThrottleWriteResult = object;
  *
  * @example
  * ```ts
- * const plugins = [throttlePlugin()];
+ * import { Spoosh } from "@spoosh/core";
+ *
+ * const client = new Spoosh<ApiSchema, Error>("/api")
+ *   .use([
+ *     // ... other plugins
+ *     throttlePlugin(),
+ *   ]);
  *
  * // Throttle to max once per second
  * useRead((api) => api.posts.$get(), {

package/dist/index.js

@@ -36,24 +36,16 @@ function throttlePlugin() {
       if (!throttleMs || throttleMs <= 0) {
         return next();
       }
-      const { queryKey } = context;
+      const { path, method } = context;
+      const stableKey = `${path.join("/")}:${method}`;
       const now = Date.now();
-      const lastTime = lastFetchTime.get(queryKey) ?? 0;
+      const lastTime = lastFetchTime.get(stableKey) ?? 0;
       const elapsed = now - lastTime;
       if (elapsed < throttleMs) {
-        const cached = context.stateManager.getCache(queryKey);
-        if (cached?.state?.data !== void 0) {
-          return { data: cached.state.data, status: 200 };
-        }
         return { data: void 0, status: 0 };
       }
-      lastFetchTime.set(queryKey, now);
+      lastFetchTime.set(stableKey, now);
       return next();
-    },
-    lifecycle: {
-      onUnmount(context) {
-        lastFetchTime.delete(context.queryKey);
-      }
     }
   };
 }

package/dist/index.mjs

@@ -10,24 +10,16 @@ function throttlePlugin() {
       if (!throttleMs || throttleMs <= 0) {
         return next();
       }
-      const { queryKey } = context;
+      const { path, method } = context;
+      const stableKey = `${path.join("/")}:${method}`;
       const now = Date.now();
-      const lastTime = lastFetchTime.get(queryKey) ?? 0;
+      const lastTime = lastFetchTime.get(stableKey) ?? 0;
       const elapsed = now - lastTime;
       if (elapsed < throttleMs) {
-        const cached = context.stateManager.getCache(queryKey);
-        if (cached?.state?.data !== void 0) {
-          return { data: cached.state.data, status: 200 };
-        }
         return { data: void 0, status: 0 };
       }
-      lastFetchTime.set(queryKey, now);
+      lastFetchTime.set(stableKey, now);
       return next();
-    },
-    lifecycle: {
-      onUnmount(context) {
-        lastFetchTime.delete(context.queryKey);
-      }
     }
   };
 }

package/package.json

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