ciorent 0.0.17 → 0.0.20

package/README.md

@@ -23,42 +23,38 @@ const task = semaphore.task(
 cio.concurrent(6, task);
 ```
 
-## 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.
+## Fibers
+Virtual threads with more controlled execution.
 
 ```ts
-import * as channel from 'ciorent/channel';
 import * as cio from 'ciorent';
+import * as fiber from 'ciorent/fiber';
 
-const c = channel.init<number>();
+const thread1 = fiber.fn(function* () {
+  console.log('Fiber 1 started');
 
-const run = async () => {
-  for (let i = 0; i < 10; i++) {
-    await cio.sleep(10);
-    channel.send(c, i);
-    console.log('Sent', i);
-  }
+  // Thread1 will be interrupted by thread2
+  // As thread2 will end first
+  yield cio.sleep(1000);
 
-  // Resolve all waiting promises with `undefined`
-  // This is a way to tell the reciever to not listen to more data
-  channel.flush(c);
-};
+  console.log('Fiber 1 done');
+})
 
-const log = async () => {
-  while (true) {
-    // Wait until a value is sent
-    const x = await channel.recieve(c);
-    if (x == null) break;
+const thread2 = fiber.fn(function* (thread) {
+  console.log('Fiber 2 started');
 
-    console.log('Recieved', x);
-  };
-}
+  yield;
+  console.log('Fiber 2 resumed');
 
-run();
-log();
+  // Start thread 1 and make thread1
+  // lifetime depends on thread2
+  fiber.mount(fiber.start(thread1), thread);
 
-// This runs first
-console.log('Starting...');
+  console.log('Fiber 2 done');
+});
+
+// Start running the thread
+fiber.start(thread2);
 ```
 
 ## Pubsub
@@ -140,6 +136,44 @@ await main();
 await main();
 ```
 
+## 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.
+
+```ts
+import * as channel from 'ciorent/channel';
+import * as cio from 'ciorent';
+
+const c = channel.init<number>();
+
+const run = async () => {
+  for (let i = 0; i < 10; i++) {
+    await cio.sleep(10);
+    channel.send(c, i);
+    console.log('Sent', i);
+  }
+
+  // Resolve all waiting promises with `undefined`
+  // This is a way to tell the reciever to not listen to more data
+  channel.flush(c);
+};
+
+const log = async () => {
+  while (true) {
+    // Wait until a value is sent
+    const x = await channel.recieve(c);
+    if (x == null) break;
+
+    console.log('Recieved', x);
+  };
+}
+
+run();
+log();
+
+// This runs first
+console.log('Starting...');
+```
+
 ## Utilities
 ### Pausing
 Delay the execution of a function for other asynchronous tasks to run.
@@ -172,12 +206,17 @@ task2();
 ```
 
 ### Sleep
-A cross-runtime sleep function.
+Cross-runtime synchronous and asynchronous sleep functions.
 ```ts
-import { sleep } from 'ciorent';
+import { sleep, sleepSync } from 'ciorent';
 
 await sleep(500);
 console.log('Hi');
+
+// This blocks the current thread
+// On the browser this only works in workers
+sleepSync(500);
+console.log('Hi');
 ```
 
 ### Spawning tasks

package/fiber.d.ts

@@ -0,0 +1,85 @@
+/**
+ * @module Fibers
+ */
+/**
+ * Check whether the fiber is paused
+ */
+export declare const paused: (t: Thread) => boolean;
+/**
+ * Check whether the fiber is running
+ */
+export declare const running: (t: Thread) => boolean;
+/**
+ * Check whether the fiber is done
+ */
+export declare const done: (t: Thread) => boolean;
+/**
+ * Describe a fiber
+ */
+export interface Thread<T = unknown, TReturn = unknown> {
+    /**
+     * The waiting promise
+     */
+    0: Promise<T | TReturn>;
+    /**
+     * Fiber status
+     */
+    1: 0 | 1 | 2;
+    /**
+     * Callback to continue running the fiber
+     */
+    2: null | (() => void);
+    /**
+     * Bounded threads
+     */
+    3: Thread[];
+}
+/**
+ * Describe a fiber runtime
+ */
+export type Runtime = <const T, const TReturn, const Args extends any[]>(gen: (thread: Thread<T, TReturn>, ...args: Args) => Generator<T, TReturn>, ...args: Args) => Thread<T, TReturn>;
+/**
+ * Create a fiber function
+ * @param f
+ */
+export declare const fn: <const Fn extends (thread: Thread, ...args: any[]) => Generator>(f: Fn) => Fn;
+/**
+ * A basic fiber runtime
+ * @param g
+ */
+export declare const start: Runtime;
+/**
+ * Pause the execution of a fiber
+ * @param t
+ */
+export declare const pause: (t: Thread) => void;
+/**
+ * Resume the execution of a fiber
+ * @param t
+ */
+export declare const resume: (t: Thread) => void;
+/**
+ * Stop the execution of a fiber
+ * @param t
+ */
+export declare const stop: (t: Thread) => void;
+/**
+ * Wait for a fiber and retrieve its result
+ * @param t
+ */
+export declare function join<T extends Thread>(t: T): Generator<Awaited<T[1]>, Awaited<T[1]>>;
+/**
+ * Wait for a fiber to finish and retrieve its result
+ * @param t
+ */
+export declare const finish: <T extends Thread>(t: T) => T[1];
+/**
+ * Mount child fiber lifetime to parent lifetime
+ * @param child
+ * @param parent
+ */
+export declare const mount: (child: Thread, parent: Thread) => void;
+/**
+ * Unwrap a promise result
+ */
+export declare function unwrap<T extends Promise<any>>(t: T): Generator<Awaited<T>, Awaited<T>>;

package/fiber.js

@@ -0,0 +1 @@
+export let paused=(t)=>t[1]===0;export let running=(t)=>t[1]===1;export let done=(t)=>t[1]===2;let invoke=async(g,thread)=>{let t=g.next();while(!t.done){let v=await t.value;if(thread[1]===0){let r;let p=new Promise((res)=>{r=res});thread[2]=r;await p}if(thread[1]===2){thread[3].forEach(stop);return v}t=g.next(v)}thread[1]=2;thread[3].forEach(stop);return t.value};export let fn=(f)=>f;export let start=(f,...args)=>{let thread=[null,1,null,[]];thread[0]=invoke(f(thread,...args),thread);return thread};export let pause=(t)=>{if(t[1]===1)t[1]=0};export let resume=(t)=>{if(t[1]===0){t[1]=1;t[2]?.()}};export let stop=(t)=>{if(t[1]===0){t[1]=2;t[2]()}else t[1]=2};export function*join(t){return yield t[1]}export let finish=(t)=>t[1];export let mount=(child,parent)=>{parent[3].push(child)};export function*unwrap(t){return yield t}

package/fixed-queue.d.ts

@@ -26,10 +26,7 @@ export interface FixedQueue<T extends {}> {
 /**
  * Describe a queue node (singly linked list node)
  */
-export type QueueNode<T> = [
-    value: T,
-    next: QueueNode<T> | null
-];
+export type QueueNode<T> = [value: T, next: QueueNode<T> | null];
 /**
  * Create a fixed queue.
  * @param n - The queue size

package/index.d.ts

@@ -14,6 +14,13 @@ export declare const pause: Promise<void>;
  * @param ms - Sleep duration in milliseconds
  */
 export declare const sleep: (ms: number) => Promise<void>;
+/**
+ * Sleep for a duration synchronously.
+ *
+ * On the browser it only works in workers.
+ * @param ms - Sleep duration in milliseconds
+ */
+export declare const sleepSync: (ms: number) => void;
 /**
  * Spawn n tasks that runs sequentially
  * @param n

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)}));export let sequential=async(n,task)=>{for(let i=0;i<n;i++)await task(i)};export let concurrent=(n,task)=>{let arr=new Array(n);for(let i=0;i<n;i++)arr[i]=task(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)=>{for(let i=0;i<n;i++)await task(i)};export let concurrent=(n,task)=>{let arr=new Array(n);for(let i=0;i<n;i++)arr[i]=task(i);return Promise.all(arr)};

package/latch.d.ts

@@ -4,10 +4,7 @@
 /**
  * Describe a latch
  */
-export type Latch = [
-    pause: Promise<void>,
-    open: () => void
-];
+export type Latch = [pause: Promise<void>, open: () => void];
 /**
  * Create a latch
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ciorent",
-  "version": "0.0.17",
+  "version": "0.0.20",
   "description": "A lightweight, low-overhead concurrency library",
   "homepage": "https://ciorent.netlify.app",
   "repository": {
@@ -17,27 +17,15 @@
   "type": "module",
   "main": "./index.js",
   "types": "./index.d.ts",
-  "scripts": {
-    "task": "bun scripts/task.ts",
-    "build:test": "bun task build && bun docs && bun test",
-    "build:publish": "bun build:test && bun task report-size && bun task publish",
-    "lint": "eslint ./src",
-    "lint:fix": "eslint ./src --fix",
-    "docs": "typedoc"
-  },
-  "devDependencies": {
-    "@stylistic/eslint-plugin": "latest",
-    "@types/bun": "latest",
-    "@types/uglify-js": "latest",
-    "eslint": "latest",
-    "eslint-plugin-jsdoc": "latest",
-    "mitata": "latest",
-    "terser": "^5.39.0",
-    "tsx": "latest",
-    "typedoc": "^0.27.9",
-    "typedoc-material-theme": "^1.3.0",
-    "typedoc-plugin-inline-sources": "^1.2.1",
-    "typescript": "latest",
-    "typescript-eslint": "latest"
+  "exports": {
+    "./fixed-queue": "./fixed-queue.js",
+    "./sliding-queue": "./sliding-queue.js",
+    "./fiber": "./fiber.js",
+    "./channel": "./channel.js",
+    "./dropping-queue": "./dropping-queue.js",
+    "./topic": "./topic.js",
+    ".": "./index.js",
+    "./semaphore": "./semaphore.js",
+    "./latch": "./latch.js"
   }
-}
+}

package/semaphore.d.ts

@@ -34,7 +34,7 @@ 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;
+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/concurrent.d.ts

@@ -1,11 +0,0 @@
-/**
- * @module Concurrency controls
- */
-/**
- * Describe an async task
- */
-export type Task<T = unknown> = () => Promise<T>;
-/**
- * Describe a concurrency controller
- */
-export type Controller = <T>(task: Task<T>) => Promise<T>;