ciorent 0.0.15 → 0.0.16

package/README.md

@@ -19,8 +19,51 @@ const task = semaphore.task(
   }
 );
 
-// Try to run 6 tasks with 4 tasks running concurrently
-cio.concurrent(6, task, 4);
+// Try to run 6 tasks concurrently
+cio.concurrent(6, task);
+```
+
+## Latch
+Latch is a synchronization primitive that allows one process to wait until another completes an operation before continuing execution.
+
+```ts
+import * as latch from 'ciorent/latch';
+import * as cio from 'ciorent';
+
+const fetchLatch = latch.init();
+
+const task = async () => {
+  // Blocks until the latch is open
+  await latch.pause(fetchLatch);
+
+  const res = await fetch('http://example.com');
+  console.log('Fetch status:', res.status);
+}
+
+const prepare = () => {
+  console.log('Run before fetch:', performance.now().toFixed(2));
+}
+
+const main = async () => {
+  const p = task();
+  await cio.sleep(500);
+  prepare();
+
+  // Allows all previously blocked tasks to run
+  latch.open(fetchLatch);
+
+  // Reclose the latch
+  // Tasks that aren't blocked yet will be blocked
+  latch.reset(fetchLatch);
+
+  return p;
+}
+
+// Run fetch after 500ms
+await main();
+
+// Run fetch after another 500ms
+await main();
 ```
 
 ## Pubsub
@@ -82,7 +125,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,49 +140,6 @@ log();
 console.log('Starting...');
 ```
 
-## Latch
-Latch is a synchronization primitive that allows one process to wait until another completes an operation before continuing execution.
-
-```ts
-import * as latch from 'ciorent/latch';
-import * as cio from 'ciorent';
-
-const fetchLatch = latch.init();
-
-const task = async () => {
-  // Blocks until the latch is open
-  await latch.pause(fetchLatch);
-
-  const res = await fetch('http://example.com');
-  console.log('Fetch status:', res.status);
-}
-
-const prepare = () => {
-  console.log('Run before fetch:', performance.now().toFixed(2));
-}
-
-const main = async () => {
-  const p = task();
-  await cio.sleep(500);
-  prepare();
-
-  // Allows all previously blocked tasks to run
-  latch.open(fetchLatch);
-
-  // Reclose the latch
-  // Tasks that aren't blocked yet will be blocked
-  latch.reset(fetchLatch);
-
-  return p;
-}
-
-// Run fetch after 500ms
-await main();
-
-// Run fetch after another 500ms
-await main();
-```
-
 ## Utilities
 ### Pausing
 Delay the execution of a function for other asynchronous tasks to run.
@@ -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/package.json

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

package/semaphore.d.ts

@@ -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".";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)};