3.0.12

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@push.rocks/smartstream",
-  "version": "3.0.9",
+  "version": "3.0.12",
   "private": false,
   "description": "simplifies access to node streams",
   "main": "dist_ts/index.js",

test/test.streamfunction.ts

@@ -10,7 +10,7 @@ tap.test('should handle a read stream', async (tools) => {
   const streamWrapper = new smartstream.StreamWrapper([
     smartfile.fsStream.createReadStream('./test/assets/readabletext.txt'),
     new smartstream.SmartDuplex({
-      writeAndTransformFunction: async (chunkStringArg: Buffer, streamTools) => {
+      writeFunction: async (chunkStringArg: Buffer, streamTools) => {
         // do something with the stream here
         const result = chunkStringArg.toString().substr(0, 100);
         streamTools.push('wow =========== \n');
@@ -21,7 +21,7 @@ tap.test('should handle a read stream', async (tools) => {
       },
     }),
     new smartstream.SmartDuplex({
-      writeAndTransformFunction: async (chunkStringArg) => {
+      writeFunction: async (chunkStringArg) => {
         console.log(chunkStringArg.toString());
       },
       finalFunction: async (tools) => {
@@ -37,7 +37,7 @@ tap.test('should create a valid Intake', async (tools) => {
   testIntake.pipe(
       new smartstream.SmartDuplex({
         objectMode: true,
-        writeAndTransformFunction: async (chunkStringArg: string, streamTools) => {
+        writeFunction: async (chunkStringArg: string, streamTools) => {
           await tools.delayFor(100);
           console.log(chunkStringArg);
           return chunkStringArg;

ts/00_commitinfo_data.ts

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

ts/smartstream.classes.smartduplex.ts

@@ -6,18 +6,18 @@ export interface IStreamTools {
   push: (pipeObject: any) => void;
 }
 
-export interface IWriteAndTransformFunction<T, rT> {
+export interface IStreamWriteFunction<T, rT> {
   (chunkArg: T, toolsArg: IStreamTools): Promise<rT>;
 }
 
-export interface IStreamEndFunction<rT> {
+export interface IStreamFinalFunction<rT> {
   (toolsArg: IStreamTools): Promise<rT>;
 }
 
 export interface SmartStreamOptions<TInput, TOutput> extends DuplexOptions {
   readFunction?: () => Promise<void>;
-  writeAndTransformFunction?: IWriteAndTransformFunction<TInput, TOutput>;
+  writeFunction?: IStreamWriteFunction<TInput, TOutput>;
-  finalFunction?: IStreamEndFunction<TOutput>;
+  finalFunction?: IStreamFinalFunction<TOutput>;
   // Add other custom options if necessary
 }
 
@@ -109,15 +109,15 @@ export class SmartDuplex<TInput = any, TOutput = any> extends Duplex {
 
   // INSTANCE
   private readFunction?: () => Promise<void>;
-  private writeAndTransformFunction?: IWriteAndTransformFunction<TInput, TOutput>;
+  private writeFunction?: IStreamWriteFunction<TInput, TOutput>;
-  private streamEndFunction?: IStreamEndFunction<TOutput>;
+  private finalFunction?: IStreamFinalFunction<TOutput>;
   private observableSubscription?: plugins.smartrx.rxjs.Subscription;
 
   constructor(optionsArg?: SmartStreamOptions<TInput, TOutput>) {
     super(optionsArg);
     this.readFunction = optionsArg?.readFunction;
-    this.writeAndTransformFunction = optionsArg?.writeAndTransformFunction;
+    this.writeFunction = optionsArg?.writeFunction;
-    this.streamEndFunction = optionsArg?.finalFunction;
+    this.finalFunction = optionsArg?.finalFunction;
   }
 
   public async _read(size: number): Promise<void> {
@@ -128,7 +128,7 @@ export class SmartDuplex<TInput = any, TOutput = any> extends Duplex {
 
   // Ensure the _write method types the chunk as TInput and encodes TOutput
   public async _write(chunk: TInput, encoding: string, callback: (error?: Error | null) => void) {
-    if (!this.writeAndTransformFunction) {
+    if (!this.writeFunction) {
       return callback(new Error('No stream function provided'));
     }
 
@@ -141,7 +141,7 @@ export class SmartDuplex<TInput = any, TOutput = any> extends Duplex {
     };
 
     try {
-      const modifiedChunk = await this.writeAndTransformFunction(chunk, tools);
+      const modifiedChunk = await this.writeFunction(chunk, tools);
       if (modifiedChunk) {
         if (!this.push(modifiedChunk)) {
           // Handle backpressure if necessary
@@ -154,24 +154,24 @@ export class SmartDuplex<TInput = any, TOutput = any> extends Duplex {
   }
 
   public async _final(callback: (error?: Error | null) => void) {
-    if (this.streamEndFunction) {
+    if (this.finalFunction) {
       const tools: IStreamTools = {
         truncate: () => callback(),
         push: (pipeObject) => this.push(pipeObject),
       };
 
       try {
-        const finalChunk = await this.streamEndFunction(tools);
+        const finalChunk = await this.finalFunction(tools);
         if (finalChunk) {
           this.push(finalChunk);
         }
-        callback();
       } catch (err) {
         callback(err);
       }
     } else {
-      this.push(null),
+      // nothing here
+    }
+    this.push(null);
     callback();
   }
 }
-}