3.0.31

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@push.rocks/smartstream",
-  "version": "3.0.27",
+  "version": "3.0.31",
   "private": false,
   "description": "simplifies access to node streams",
   "main": "dist_ts/index.js",
@@ -22,15 +22,15 @@
   },
   "homepage": "https://gitlab.com/push.rocks/smartstream#readme",
   "devDependencies": {
-    "@git.zone/tsbuild": "^2.1.66",
+    "@git.zone/tsbuild": "^2.1.72",
     "@git.zone/tsrun": "^1.2.44",
-    "@git.zone/tstest": "^1.0.84",
-    "@push.rocks/smartfile": "^11.0.0",
+    "@git.zone/tstest": "^1.0.86",
+    "@push.rocks/smartfile": "^11.0.4",
     "@push.rocks/tapbundle": "^5.0.15",
-    "@types/node": "^20.9.0"
+    "@types/node": "^20.11.20"
   },
   "dependencies": {
-    "@push.rocks/lik": "^6.0.12",
+    "@push.rocks/lik": "^6.0.14",
     "@push.rocks/smartpromise": "^4.0.3",
     "@push.rocks/smartrx": "^3.0.7"
   },

test/test.backpressure.ts

@@ -20,7 +20,7 @@ tap.test('should run backpressure test', async (toolsArg) => {
         await new Promise((resolve) => setTimeout(resolve, 20)); // Slow processing
         console.log(`processed chunk ${chunk} in stream 2`);
         await tools.push(chunk);
-        // return chunk;
+        // return chunk, optionally return ;
       },
     }); // This stream processes data more slowly
     const stream3 = new SmartDuplex({

ts/00_commitinfo_data.ts

@@ -3,6 +3,6 @@
  */
 export const commitinfo = {
   name: '@push.rocks/smartstream',
-  version: '3.0.27',
+  version: '3.0.31',
   description: 'simplifies access to node streams'
 }

ts/smartstream.classes.smartduplex.ts

@@ -15,10 +15,28 @@ export interface IStreamFinalFunction<rT> {
 }
 
 export interface ISmartDuplexOptions<TInput, TOutput> extends DuplexOptions {
+  /**
+   * wether to print debug logs
+   */
   debug?: boolean;
+  /**
+   * the name of the stream
+   */
   name?: string;
+  /**
+   * a function that is being called to read more stuff from whereever to be processed by the stream
+   * @returns
+   */
   readFunction?: () => Promise<void>;
+
+  /**
+   * the write function is called for every chunk that is being written to the stream
+   * it can push or return chunks (but does not have to) to be written to the readable side of the stream
+   */
   writeFunction?: IStreamWriteFunction<TInput, TOutput>;
+  /**
+   * a final function that is being sent to the end of the stream 
+   */
   finalFunction?: IStreamFinalFunction<TOutput>;
   // Add other custom options if necessary
 }
@@ -66,6 +84,15 @@ export class SmartDuplex<TInput = any, TOutput = any> extends Duplex {
     }
   }
 
+  public async backpressuredPush (pushArg: TOutput) {
+    const canPushMore = this.backpressuredArray.push(pushArg);
+    if (!canPushMore) {
+      this.debugLog(`${this.options.name}: cannot push more`);
+      await this.backpressuredArray.waitForSpace();
+      this.debugLog(`${this.options.name}: can push more again`);
+    }
+  };
+
   private asyncWritePromiseObjectmap = new plugins.lik.ObjectMap<Promise<any>>();
   // Ensure the _write method types the chunk as TInput and encodes TOutput
   public async _write(chunk: TInput, encoding: string, callback: (error?: Error | null) => void) {
@@ -81,13 +108,8 @@ export class SmartDuplex<TInput = any, TOutput = any> extends Duplex {
         callback();
       },
       push: async (pushArg: TOutput) => {
-        const canPushMore = this.backpressuredArray.push(pushArg);
-        if (!canPushMore) {
-          this.debugLog(`${this.options.name}: cannot push more`);
-          await this.backpressuredArray.waitForSpace();
-          this.debugLog(`${this.options.name}: can push more again`);
-        }
-      },
+        await this.backpressuredPush(pushArg);
+      }
     };
 
     try {