ciorent 0.0.3 → 0.0.4

package/README.md

@@ -1,7 +1,6 @@
-# Ciorent
 A low-overhead, cross-runtime concurrency library.
 
-## Example usage
+# Usage
 Pausing to prioritize an asynchronous task:
 ```ts
 import * as cio from 'ciorent';
@@ -77,11 +76,54 @@ log();
 console.log('Starting...');
 ```
 
-Latches:
+## Latch
+Latch is a synchronization tool that works like a gate, pausing tasks until the latch is opened.
+
+```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));
+
+  // Unblock the latch
+  latch.open(fetchLatch);
+}
+
+const main = async () => {
+  const p = task();
+  await cio.sleep(500);
+  prepare();
+
+  return p;
+}
+
+// Run fetch after 500ms
+await main();
+
+// Re-close the latch
+latch.close(fetchLatch);
+
+// Run fetch after another 500ms
+await main();
+```
+
+If you don't need to close the latch again:
 ```ts
-import latch from 'ciorent/latch';
+import * as latch from 'ciorent/latch';
+import * as cio from 'ciorent';
 
-const [startFetch, pauseFetch] = latch();
+const [pauseFetch, startFetch] = latch.init();
 
 const task = async () => {
   // Blocks until the latch is open
@@ -92,12 +134,20 @@ const task = async () => {
 }
 
 const prepare = () => {
-  console.log('Run before fetch');
+  console.log('Run before fetch:', performance.now().toFixed(2));
 
   // Unblock the latch
   startFetch();
 }
 
-task();
-setTimeout(prepare, 500);
+const main = async () => {
+  const p = task();
+  await cio.sleep(500);
+  prepare();
+
+  return p;
+}
+
+// Run fetch after 500ms
+await main();
 ```

package/latch.d.ts

@@ -2,8 +2,26 @@
  * @module
  * Latches
  */
+/**
+ * Describe a latch
+ */
+export interface Latch {
+    0: Promise<void>;
+    1: () => void;
+}
 /**
  * Create a latch
  */
-declare const _default: () => [resolve: () => void, promise: Promise<void>];
-export default _default;
+export declare const init: () => Latch;
+/**
+ * Pause until a latch is opened
+ */
+export declare const pause: (latch: Latch) => Promise<void>;
+/**
+ * Open a latch
+ */
+export declare const open: (latch: Latch) => void;
+/**
+ * Close a latch
+ */
+export declare const close: (latch: Latch) => void;

package/latch.js

@@ -1 +1 @@
-export default ()=>{let r;let p=new Promise((res)=>{r=res});return[r,p]};
+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 close=(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.3",
+  "version": "0.0.4",
   "description": "A concurrency library",
   "keywords": [],
   "license": "MIT",