ciorent 0.3.0 → 0.3.1

package/README.md

@@ -74,8 +74,8 @@ co.spawn(8, async (id) => {
 });
 ```
 
-#### Pausing
-Delay the execution of a function for other asynchronous tasks to run.
+#### Yield
+Continue the execution on next tick, allowing other asynchronous tasks to run.
 ```ts
 import * as co from 'ciorent';
 
@@ -85,7 +85,7 @@ const task1 = async () => {
 
   // Yield control back to the runtime, allowing it to
   // schedule other tasks
-  await co.pause;
+  await co.nextTick;
 
   // Simulate heavy operation
   for (let i = 0; i < (Math.random() + 15) * 1e6; i++)
@@ -159,7 +159,7 @@ const task = async (id: number) => {
   console.log('Task', id, 'started');
 
   // Let the main thread schedules other tasks
-  for (let i = 1; i <= 5; i++) await co.pause;
+  for (let i = 1; i <= 5; i++) await co.nextTick;
 
   console.log('Task', id, 'end');
 

package/index.d.ts

@@ -8,7 +8,7 @@
  *
  * blocking the main thread and let other asynchronous task to run.
  */
-export declare const pause: Promise<void>;
+export declare const nextTick: Promise<void>;
 /**
  * Sleep for a duration.
  * @param ms - Sleep duration in milliseconds

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 spawn=(n,task,...args)=>{let arr=new Array(n);for(let i=0;i<n;i++)arr[i]=task(...args,i);return arr};export let debounce=(f,ms)=>{let id;return(...a)=>{clearTimeout(id);id=setTimeout(f,ms,...a)}};export let throttle=(ms,limit)=>{let head=[null];let tail=head;let cur=limit;let scheduled=false;let unlock=()=>{cur=limit;if(tail===head){scheduled=false;return}do{cur--;(tail=tail[0])[1]()}while(cur>0&&tail!==head);setTimeout(unlock,ms)};return()=>{if(cur===0){return new Promise((res)=>{head=head[0]=[null,res]})}if(!scheduled){scheduled=true;setTimeout(unlock,ms)}cur--;return pause}};
+export let nextTick=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 spawn=(n,task,...args)=>{let arr=new Array(n);for(let i=0;i<n;i++)arr[i]=task(...args,i);return arr};export let debounce=(f,ms)=>{let id;return(...a)=>{clearTimeout(id);id=setTimeout(f,ms,...a)}};export let throttle=(ms,limit)=>{let head=[null];let tail=head;let cur=limit;let scheduled=false;let unlock=()=>{cur=limit;if(tail===head){scheduled=false;return}do{cur--;(tail=tail[0])[1]()}while(cur>0&&tail!==head);setTimeout(unlock,ms)};return()=>{if(cur===0){return new Promise((res)=>{head=head[0]=[null,res]})}if(!scheduled){scheduled=true;setTimeout(unlock,ms)}cur--;return nextTick}};

package/latch.js

@@ -1 +1 @@
-import{pause as endPromise}from"./index.js";export let init=()=>{let r;return[new Promise((res)=>{r=res}),r]};export let pause=(latch)=>latch[0];export let open=(latch)=>{latch[1]();latch[0]=endPromise};export let close=(latch)=>{if(latch[0]===endPromise){let r;latch[0]=new Promise((res)=>{r=res});latch[1]=r}};
+import{nextTick as endPromise}from"./index.js";export let init=()=>{let r;return[new Promise((res)=>{r=res}),r]};export let pause=(latch)=>latch[0];export let open=(latch)=>{latch[1]();latch[0]=endPromise};export let close=(latch)=>{if(latch[0]===endPromise){let r;latch[0]=new Promise((res)=>{r=res});latch[1]=r}};

package/lock.d.ts

@@ -1,3 +1,6 @@
+/**
+ * @module Lock utilities
+ */
 import type { Node as QueueNode } from './queue.js';
 /**
  * Describe a lock
@@ -15,7 +18,6 @@ export interface Lock<T = any> {
 /**
  * Acquire an item
  * @param lock
- * @param value
  */
 export declare const acquire: <T>(lock: Lock<T>) => Promise<T | undefined>;
 /**

package/package.json

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

package/queue.d.ts

@@ -1,5 +1,4 @@
 /**
- * @private
  * @module Queue utilities
  */
 /**

package/semaphore.js

@@ -1 +1 @@
-import{pause as resolvedPromise}from"./index.js";import{acquire as lockAcquire,release as lockRelease}from"./lock.js";export let init=(n)=>{let root=[null];return[root,root,n]};export let acquire=(s)=>{s[2]--;return s[2]>=0?resolvedPromise:lockAcquire(s)};export let release=(s)=>{if(s[2]<0)lockRelease(s);s[2]++};export let bind=(f,s)=>async(...a)=>{s[2]--;if(s[2]<0)await acquire(s);try{return await f(...a)}finally{if(s[2]<0)release(s);s[2]++}};
+import{nextTick as resolvedPromise}from"./index.js";import{acquire as lockAcquire,release as lockRelease}from"./lock.js";export let init=(n)=>{let root=[null];return[root,root,n]};export let acquire=(s)=>{s[2]--;return s[2]>=0?resolvedPromise:lockAcquire(s)};export let release=(s)=>{if(s[2]<0)lockRelease(s);s[2]++};export let bind=(f,s)=>async(...a)=>{s[2]--;if(s[2]<0)await acquire(s);try{return await f(...a)}finally{if(s[2]<0)release(s);s[2]++}};