@nxtedition/shared 0.0.1 → 0.0.4

package/README.md

@@ -25,13 +25,12 @@ const worker = new Worker(new URL('worker.js', import.meta.url), {
 
 const writeToWorker = shared.writer(reader)
 
-shared.reader(writer, async (buffer) => {
+writeToWorker(Buffer.from('ping'))
+
+for await (const buffer of shared.reader(writer)) {
   console.log(`From worker ${buffer}`)
   await tp.setTimeout(1e3) // Backpressure
-})
-
-while (true) {
-  await writeToParent(Buffer.from('Hello from parent')
+  writeToWorker(Buffer.from('pong'))
 }
 ```
 
@@ -43,12 +42,9 @@ import tp from 'timers/promise'
 
 const writeToParent = shared.writer(workerData.writer)
 
-shared.reader(workerData.reader, (buffer) => {
+for await (const buffer of shared.reader(workerData.reader)) {
   console.log(`From parent ${buffer}`)
   await tp.setTimeout(1e3) // Backpressure
-})
-
-while (true) {
-  await writeToParent(Buffer.from('Hello from worker')
+  writeToWorker(Buffer.from('pong'))
 }
 ```

package/index.js

@@ -1,5 +1,6 @@
 const WRITE_INDEX = 0
 const READ_INDEX = 1
+const END_OF_PACKET = -1
 
 export function alloc(size) {
   return {
@@ -8,7 +9,7 @@ export function alloc(size) {
   }
 }
 
-export async function reader({ sharedState, sharedBuffer }, cb) {
+async function* _reader({ sharedState, sharedBuffer }, cb) {
   const state = new Int32Array(sharedState)
   const buffer = Buffer.from(sharedBuffer)
 
@@ -25,13 +26,16 @@ export async function reader({ sharedState, sharedBuffer }, cb) {
     while (readPos !== writePos) {
       const len = buffer.readInt32LE(readPos)
 
-      if (len === -1) {
+      if (len === END_OF_PACKET) {
         readPos = 0
       } else {
         const raw = buffer.slice(readPos + 4, readPos + len)
         readPos += len
-
-        await cb(raw)
+        if (cb) {
+          cb()
+        } else {
+          yield raw
+        }
       }
 
       Atomics.store(state, READ_INDEX, readPos)
@@ -41,6 +45,14 @@ export async function reader({ sharedState, sharedBuffer }, cb) {
   }
 }
 
+export function reader(options, cb) {
+  if (cb) {
+    _reader(options, cb).next()
+  } else {
+    return _reader(options)
+  }
+}
+
 export function writer({ sharedState, sharedBuffer }) {
   const state = new Int32Array(sharedState)
   const buffer = Buffer.from(sharedBuffer)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nxtedition/shared",
-  "version": "0.0.1",
+  "version": "0.0.4",
   "description": "Ring Buffer for NodeJS cross Worker communication",
   "main": "index.js",
   "repository": {
@@ -12,6 +12,7 @@
   "bugs": {
     "url": "https://github.com/nxtedition/shared/issues"
   },
+  "type": "module",
   "homepage": "https://github.com/nxtedition/shared#readme",
   "lint-staged": {
     "*.{js,jsx,ts}": [