ciorent 0.0.15 → 0.0.17

package/README.md

@@ -19,44 +19,8 @@ const task = semaphore.task(
   }
 );
 
-// Try to run 6 tasks with 4 tasks running concurrently
-cio.concurrent(6, task, 4);
-```
-
-## Pubsub
-A fast, simple publish-subscribe API.
-
-```ts
-import * as topic from 'ciorent/topic';
-import * as cio from 'ciorent';
-
-const messages = topic.init<number>();
-
-// A task that publish messages
-const publisher = async () => {
-  for (let i = 0; i < 5; i++) {
-    await cio.sleep(100);
-    topic.pub(messages, i);
-  }
-
-  // Resolve all waiting promises
-  // And clear the value queue
-  topic.flush(messages);
-}
-
-// Spawn 5 tasks that recieve messages
-cio.concurrent(5, async (id: number) => {
-  const sub = topic.sub(messages);
-
-  while (true) {
-    // Block until the value is sent
-    const x = await topic.recieve(sub);
-    if (x == null) break;
-    console.log(`Task ${id}: ${x}`);
-  }
-});
-
-publisher();
+// Try to run 6 tasks concurrently
+cio.concurrent(6, task);
 ```
 
 ## Channel
@@ -82,7 +46,7 @@ const run = async () => {
 
 const log = async () => {
   while (true) {
-    // Block until x is recieved
+    // Wait until a value is sent
     const x = await channel.recieve(c);
     if (x == null) break;
 
@@ -97,6 +61,42 @@ log();
 console.log('Starting...');
 ```
 
+## Pubsub
+A fast, simple publish-subscribe API.
+
+```ts
+import * as topic from 'ciorent/topic';
+import * as cio from 'ciorent';
+
+const messages = topic.init<number>();
+
+// A task that publish messages
+const publisher = async () => {
+  for (let i = 0; i < 5; i++) {
+    await cio.sleep(100);
+    topic.pub(messages, i);
+  }
+
+  // Resolve all waiting promises
+  // And clear the value queue
+  topic.flush(messages);
+}
+
+// Spawn 5 tasks that recieve messages
+cio.concurrent(5, async (id: number) => {
+  const sub = topic.sub(messages);
+
+  while (true) {
+    // Block until the value is sent
+    const x = await topic.recieve(sub);
+    if (x == null) break;
+    console.log(`Task ${id}: ${x}`);
+  }
+});
+
+publisher();
+```
+
 ## Latch
 Latch is a synchronization primitive that allows one process to wait until another completes an operation before continuing execution.
 
@@ -181,7 +181,7 @@ console.log('Hi');
 ```
 
 ### Spawning tasks
-Creating new tasks with controlled concurrency.
+Utilities to create and run tasks.
 ```ts
 import * as cio from 'ciorent';
 

package/channel.d.ts

@@ -1,7 +1,7 @@
 /**
  * @module Channels
  */
-import type { QueueNode } from './fixed-queue';
+import type { QueueNode } from './fixed-queue.js';
 /**
  * Describe a channel
  */

package/dropping-queue.d.ts

@@ -1,9 +1,9 @@
 /**
  * @module Dropping queues
  */
-import type { FixedQueue } from './fixed-queue';
-export { init } from './fixed-queue';
-export { pop } from './sliding-queue';
+import type { FixedQueue } from './fixed-queue.js';
+export { init } from './fixed-queue.js';
+export { pop } from './sliding-queue.js';
 /**
  * Push an item to a dropping queue
  * @param q - The queue to push to

package/dropping-queue.js

@@ -1 +1 @@
-export{init}from"./fixed-queue";export{pop}from"./sliding-queue";export let push=(q,item)=>{if(q[0][(q[2]+1)%q[1]]!=null)return false;q[0][q[2]=(q[2]+1)%q[1]]=item;return true};
+export{init}from"./fixed-queue.js";export{pop}from"./sliding-queue.js";export let push=(q,item)=>{if(q[0][(q[2]+1)%q[1]]!=null)return false;q[0][q[2]=(q[2]+1)%q[1]]=item;return true};

package/latch.js

@@ -1 +1 @@
-import{pause as endPromise}from".";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 reset=(latch)=>{if(latch[0]===endPromise){let r;latch[0]=new Promise((res)=>{r=res});latch[1]=r}};
+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 reset=(latch)=>{if(latch[0]===endPromise){let r;latch[0]=new Promise((res)=>{r=res});latch[1]=r}};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ciorent",
-  "version": "0.0.15",
+  "version": "0.0.17",
   "description": "A lightweight, low-overhead concurrency library",
   "homepage": "https://ciorent.netlify.app",
   "repository": {

package/semaphore.d.ts

@@ -1,7 +1,7 @@
 /**
  * @module Semaphores
  */
-import type { QueueNode } from './fixed-queue';
+import type { QueueNode } from './fixed-queue.js';
 /**
  * Describe a semaphore
  */
@@ -31,6 +31,10 @@ export declare const pause: (s: Semaphore) => Promise<void>;
  * Signal to the semaphore to release access
  */
 export declare const signal: (s: Semaphore) => void;
+/**
+ * Wrap a task to bind to a custom semaphore later
+ */
+export declare const wrap: <Args extends any[], Return extends Promise<any>>(f: (...args: Args) => Return) => (s: Semaphore, ...a: Args) => Return;
 /**
  * Create a task that acquire a semaphore and release the access when it's finished
  */

package/semaphore.js

@@ -1 +1 @@
-import{pause as resolvedPromise}from".";export let init=(n)=>{let root=[null,null];return[n,root,root]};export let pause=(s)=>{s[0]--;if(s[0]<0){let r;let p=new Promise((res)=>{r=res});s[1]=s[1][1]=[r,null];return p}return resolvedPromise};export let signal=(s)=>{if(s[0]<0)(s[2]=s[2][1])[0]();s[0]++};export let task=(s,f)=>async(...a)=>{s[0]--;if(s[0]<0){let r;let p=new Promise((res)=>{r=res});s[1]=s[1][1]=[r,null];await p}try{return await f(...a)}finally{signal(s)}};
+import{pause as resolvedPromise}from"./index.js";export let init=(n)=>{let root=[null,null];return[n,root,root]};export let pause=(s)=>{s[0]--;if(s[0]<0){let r;let p=new Promise((res)=>{r=res});s[1]=s[1][1]=[r,null];return p}return resolvedPromise};export let signal=(s)=>{if(s[0]<0)(s[2]=s[2][1])[0]();s[0]++};export let wrap=(f)=>async(s,...a)=>{s[0]--;if(s[0]<0){let r;let p=new Promise((res)=>{r=res});s[1]=s[1][1]=[r,null];await p}try{return await f(...a)}finally{signal(s)}};export let task=(s,f)=>{f=wrap(f);return(...a)=>f(s,...a)};

package/sliding-queue.d.ts

@@ -1,8 +1,8 @@
 /**
  * @module Sliding queues
  */
-import type { FixedQueue } from './fixed-queue';
-export { init } from './fixed-queue';
+import type { FixedQueue } from './fixed-queue.js';
+export { init } from './fixed-queue.js';
 /**
  * Push an item to a sliding queue
  * @param q - The queue to push to

package/sliding-queue.js

@@ -1 +1 @@
-export{init}from"./fixed-queue";export let push=(q,item)=>{q[0][q[2]=(q[2]+1)%q[1]]=item};export let pop=(q)=>{let val=q[0][(q[3]+1)%q[1]];if(val!=null){q[0][q[3]=(q[3]+1)%q[1]]=null;return val}};
+export{init}from"./fixed-queue.js";export let push=(q,item)=>{q[0][q[2]=(q[2]+1)%q[1]]=item};export let pop=(q)=>{let val=q[0][(q[3]+1)%q[1]];if(val!=null){q[0][q[3]=(q[3]+1)%q[1]]=null;return val}};

package/topic.d.ts

@@ -1,7 +1,7 @@
 /**
  * @module Pubsub
  */
-import type { QueueNode } from './fixed-queue';
+import type { QueueNode } from './fixed-queue.js';
 /**
  * Describe a topic
  */