ciorent 0.0.25 → 0.0.26

package/README.md

@@ -243,7 +243,7 @@ cio.concurrent(5, task);
 ```
 
 ### Debounce
-Dropping tasks for a period of time.
+Postpones execution until after an idle period.
 ```ts
 import * as cio from 'ciorent';
 
@@ -256,11 +256,12 @@ await cio.sleep(100);
 fn(2); // fn(2) gets executed
 ```
 
-### Rate limit
-Limit function calls for a specific period of time.
+### Rate Limit
+Limits the number of calls within a time window.
 ```ts
 import * as cio from 'ciorent';
 
+// Allow 1 call in 500ms
 const fn = cio.rateLimit((id: number) => {
   console.log('ID:', id);
 }, 500, 1);
@@ -272,3 +273,17 @@ await cio.sleep(500);
 fn(3); // fn(3) gets executed
 ```
 
+### Throttle
+Executes a function at a regular interval.
+```ts
+import * as cio from 'ciorent';
+
+// Allow 2 calls in 500ms
+const fn = cio.throttle((id: number) => {
+  console.log(id + ': ' + Math.floor(performance.now()) + 'ms');
+}, 500, 2);
+
+for (let i = 0; i < 8; i++)
+  fn(i);
+```
+

package/index.d.ts

@@ -41,8 +41,15 @@ export declare const concurrent: <const T extends any[], const R>(n: number, tas
 export declare const debounce: <const Args extends any[]>(f: (...args: Args) => any, ms: number) => ((...args: Args) => void);
 /**
  * Drop function calls for a specific period
- * @param f - The target function to throttle
+ * @param f - The target function to rate limit
  * @param ms - The time period in milliseconds
  * @param limit - The call limit in the time period
  */
 export declare const rateLimit: <const Args extends any[]>(f: (...args: Args) => any, ms: number, limit: number) => ((...args: Args) => void);
+/**
+ * Throttle function execution for a time period
+ * @param f - The function to throttle
+ * @param ms - The time in milliseconds
+ * @param limit - The call limit in the time period
+ */
+export declare const throttle: <const Args extends any[], const R>(f: (...args: Args) => R, ms: number, limit: number) => ((...args: Args) => Promise<Awaited<R>>);

package/index.js

@@ -1 +1 @@
-export let pause=Promise.resolve();export let sleep=globalThis.Bun?.sleep??globalThis.process?.getBuiltinModule?.("timers/promises").setTimeout??((ms)=>new Promise((res)=>{setTimeout(res,ms)}));let sharedBuf=new Int32Array(new SharedArrayBuffer(4));export let sleepSync=globalThis.Bun?.sleepSync??((ms)=>{Atomics.wait(sharedBuf,0,0,ms)});export let sequential=async(n,task,...args)=>{for(let i=0;i<n;i++)await task(...args,i)};export let concurrent=(n,task,...args)=>{let arr=new Array(n);for(let i=0;i<n;i++)arr[i]=task(...args,i);return Promise.all(arr)};export let debounce=(f,ms)=>{let id;return(...a)=>{clearTimeout(id);id=setTimeout(f,ms,...a)}};export let rateLimit=(f,ms,limit)=>{let cur=limit;let call=()=>{cur++};return(...a)=>{if(cur>0){cur--;f(...a);setTimeout(call,ms)}}};
+export let pause=Promise.resolve();export let sleep=globalThis.Bun?.sleep??globalThis.process?.getBuiltinModule?.("timers/promises").setTimeout??((ms)=>new Promise((res)=>{setTimeout(res,ms)}));let sharedBuf=new Int32Array(new SharedArrayBuffer(4));export let sleepSync=globalThis.Bun?.sleepSync??((ms)=>{Atomics.wait(sharedBuf,0,0,ms)});export let sequential=async(n,task,...args)=>{for(let i=0;i<n;i++)await task(...args,i)};export let concurrent=(n,task,...args)=>{let arr=new Array(n);for(let i=0;i<n;i++)arr[i]=task(...args,i);return Promise.all(arr)};export let debounce=(f,ms)=>{let id;return(...a)=>{clearTimeout(id);id=setTimeout(f,ms,...a)}};export let rateLimit=(f,ms,limit)=>{let call=()=>{limit++};return(...a)=>{if(limit>0){limit--;try{f(...a)}finally{setTimeout(call,ms)}}}};export let throttle=(f,ms,limit)=>{let head=[null,null,null];let tail=head;let unlock=()=>{if(tail!==head){tail=tail[2];tail[0](f(...tail[1]));setTimeout(unlock,ms)}else limit++};return(...a)=>{if(limit===0){let r;let p=new Promise((res)=>{r=res});head=head[2]=[r,a,null];return p}limit--;setTimeout(unlock,ms);return f(...a)}};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ciorent",
-  "version": "0.0.25",
+  "version": "0.0.26",
   "description": "A lightweight, low-overhead concurrency library",
   "homepage": "https://ciorent.netlify.app",
   "repository": {
@@ -18,14 +18,14 @@
   "main": "./index.js",
   "types": "./index.d.ts",
   "exports": {
+    "./fixed-queue": "./fixed-queue.js",
     "./latch": "./latch.js",
     "./sliding-queue": "./sliding-queue.js",
-    "./channel": "./channel.js",
-    "./fixed-queue": "./fixed-queue.js",
     ".": "./index.js",
-    "./dropping-queue": "./dropping-queue.js",
-    "./topic": "./topic.js",
     "./semaphore": "./semaphore.js",
+    "./topic": "./topic.js",
+    "./channel": "./channel.js",
+    "./dropping-queue": "./dropping-queue.js",
     "./fiber": "./fiber.js"
   }
 }