ciorent 0.0.22 → 0.0.24

package/README.md

@@ -24,6 +24,40 @@ const sem = semaphore.init(2);
 cio.concurrent(6, (sem, id) => task(sem, id), sem);
 ```
 
+## Fibers
+Virtual threads with more controlled execution.
+
+```ts
+import * as cio from 'ciorent';
+import * as fiber from 'ciorent/fiber';
+
+const thread1 = fiber.fn(function* () {
+  console.log('Fiber 1 started');
+
+  // Thread1 will be interrupted by thread2
+  // As thread2 will end first
+  yield cio.sleep(1000);
+
+  console.log('Fiber 1 done');
+});
+
+const thread2 = fiber.fn(function* (thread) {
+  console.log('Fiber 2 started');
+
+  yield;
+  console.log('Fiber 2 resumed');
+
+  // Start thread 1 and make thread1
+  // lifetime depends on thread2
+  fiber.mount(fiber.spawn(thread1), thread);
+
+  console.log('Fiber 2 done');
+});
+
+// Start running the thread
+fiber.spawn(thread2);
+```
+
 ## Latch
 Latch is a synchronization primitive that allows one process to wait until another completes an operation before continuing execution.
 
@@ -103,40 +137,6 @@ cio.concurrent(5, async (id: number) => {
 publisher();
 ```
 
-## Fibers
-Virtual threads with more controlled execution.
-
-```ts
-import * as cio from 'ciorent';
-import * as fiber from 'ciorent/fiber';
-
-const thread1 = fiber.fn(function* () {
-  console.log('Fiber 1 started');
-
-  // Thread1 will be interrupted by thread2
-  // As thread2 will end first
-  yield cio.sleep(1000);
-
-  console.log('Fiber 1 done');
-});
-
-const thread2 = fiber.fn(function* (thread) {
-  console.log('Fiber 2 started');
-
-  yield;
-  console.log('Fiber 2 resumed');
-
-  // Start thread 1 and make thread1
-  // lifetime depends on thread2
-  fiber.mount(fiber.spawn(thread1), thread);
-
-  console.log('Fiber 2 done');
-});
-
-// Start running the thread
-fiber.spawn(thread2);
-```
-
 ## Channel
 Channel is a synchronization primitive via message passing. A message may be sent over a channel, and another process is able to receive messages sent over a channel it has a reference to.
 
@@ -242,3 +242,33 @@ console.log('Running 5 tasks concurrently:');
 cio.concurrent(5, task);
 ```
 
+### Debounce
+Dropping tasks for a period of time.
+```ts
+import * as cio from 'ciorent';
+
+const fn = cio.debounce((id: number) => {
+  console.log('ID:', id);
+}, 500);
+
+fn(1); // fn(1) gets skipped
+await cio.sleep(100);
+fn(2); // fn(2) gets executed
+```
+
+### Throttle
+Limit function calls for a specific period of time.
+```ts
+import * as cio from 'ciorent';
+
+const fn = cio.throttle((id: number) => {
+  console.log('ID:', id);
+}, 500, 1);
+
+fn(1); // fn(1) gets executed
+await cio.sleep(100);
+fn(2); // fn(2) gets skipped
+await cio.sleep(500);
+fn(3); // fn(3) gets executed
+```
+

package/index.d.ts

@@ -32,4 +32,17 @@ export declare const sequential: <const T extends any[]>(n: number, task: (...ar
  * @param n
  * @param task - The function to run
  */
-export declare const concurrent: <const T extends any[]>(n: number, task: (...args: [...T, id: number]) => Promise<any>, ...args: T) => Promise<any>;
+export declare const concurrent: <const T extends any[], const R>(n: number, task: (...args: [...T, id: number]) => Promise<R>, ...args: T) => Promise<R[]>;
+/**
+ * Drop function calls until it doesn't get called for a specific period.
+ * @param f - The target function to debounce
+ * @param ms - The time period in milliseconds
+ */
+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 ms - The time period in milliseconds
+ * @param limit - The call limit in the time period
+ */
+export declare const throttle: <const Args extends any[]>(f: (...args: Args) => any, ms: number, limit: number) => ((...args: Args) => void);

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 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 throttle=(f,ms,limit)=>{let cur=limit;let call=(...a)=>{cur++;f(...a)};return(...a)=>{if(cur>0){cur--;setTimeout(call,ms,...a)}}};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ciorent",
-  "version": "0.0.22",
+  "version": "0.0.24",
   "description": "A lightweight, low-overhead concurrency library",
   "homepage": "https://ciorent.netlify.app",
   "repository": {
@@ -20,12 +20,12 @@
   "exports": {
     "./sliding-queue": "./sliding-queue.js",
     "./fixed-queue": "./fixed-queue.js",
-    "./latch": "./latch.js",
     "./dropping-queue": "./dropping-queue.js",
-    "./channel": "./channel.js",
+    "./latch": "./latch.js",
+    "./semaphore": "./semaphore.js",
     ".": "./index.js",
     "./topic": "./topic.js",
-    "./semaphore": "./semaphore.js",
+    "./channel": "./channel.js",
     "./fiber": "./fiber.js"
   }
 }

package/sliding-queue.d.ts

@@ -11,6 +11,6 @@ export { init } from './fixed-queue.js';
 export declare const push: <T extends {}>(q: FixedQueue<T>, item: T) => void;
 /**
  * Pop an item from the queue
- * @param q - The queue to pull from
+ * @param q - The queue to pop from
  */
 export declare const pop: <T extends {}>(q: FixedQueue<T>) => T | undefined;