fixup! fixup! Replace tslint with eslint

iurisilvio · iurisilvio · commit 5dbe9fefa6de · 2025-12-03T14:22:27.000+01:00
diff --git a/src/index.ts b/src/index.ts
@@ -1,2 +1,2 @@
-export { FeatureType, TFRecordsBuilder, ITFRecordsFileWriter, TransformStreamOptions } from "./tensorFlowBuilder";
+export { FeatureType, TFRecordsBuilder, TFRecordsTransform, TransformStreamOptions } from "./tensorFlowBuilder";
 export { TFRecordsReader } from "./tensorFlowReader";
diff --git a/src/tensorFlowBuilder.js b/src/tensorFlowBuilder.js
@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TFRecordsBuilder = exports.FeatureType = void 0;
+exports.TFRecordsBuilder = exports.FeatureType = exports.TFRecordsTransform = void 0;
 const tensorFlowRecordsProtoBuf_pb_1 = require("./tensorFlowRecordsProtoBuf_pb");
 const tensorFlowHelpers_1 = require("./tensorFlowHelpers");
 const stream_1 = require("stream");
@@ -12,6 +12,26 @@ try {
 catch (_a) {
     // Not available in browser
 }
+/**
+ * A Transform stream for TFRecords with an optional `finished` promise
+ * that resolves when the stream (and any piped file) is complete.
+ */
+class TFRecordsTransform extends stream_1.Transform {
+    constructor(options, fileStream) {
+        super(options);
+        // If there's a file stream, wait for it to finish; otherwise wait for this transform
+        const streamToWatch = fileStream || this;
+        this.finished = new Promise((resolve, reject) => {
+            (0, stream_1.finished)(streamToWatch, (err) => {
+                if (err)
+                    reject(err);
+                else
+                    resolve();
+            });
+        });
+    }
+}
+exports.TFRecordsTransform = TFRecordsTransform;
 /**
  * @name - TFRecords Feature Type
  * @description - Defines the type of TFRecords Feature
@@ -59,11 +79,27 @@ class TFRecordsBuilder {
         records.forEach((r) => transformer.write(r));
         return transformer;
     }
+    /**
+     * @description - Create a Transform stream for TFRecords.
+     *                Optionally pipes output directly to disk when filePath is provided.
+     * @param optionsOrHighWaterMark - Stream buffer size (number) or options object
+     * @param options.highWaterMark - Stream buffer size
+     * @param options.filePath - When provided, pipes output to this file (Node.js only).
+     *                           Use stream.finished promise to know when done.
+     * @returns - TFRecordsTransform stream with a `finished` promise
+     */
     static transformStream(optionsOrHighWaterMark) {
         const options = typeof optionsOrHighWaterMark === "number"
             ? { highWaterMark: optionsOrHighWaterMark }
             : optionsOrHighWaterMark;
-        const transformer = new stream_1.Transform({
+        let fileStream;
+        if (options === null || options === void 0 ? void 0 : options.filePath) {
+            if (!fs) {
+                throw new Error("File output is only available in Node.js. Use transformStream() without filePath in the browser.");
+            }
+            fileStream = fs.createWriteStream(options.filePath);
+        }
+        const transformer = new TFRecordsTransform({
             transform: (record, encoding, callback) => {
                 const length = record.length;
                 // Get TFRecords CRCs for TFRecords Header and Footer
@@ -73,30 +109,11 @@ class TFRecordsBuilder {
                 callback(undefined, Buffer.concat([bufferLength, bufferLengthMaskedCRC, record, bufferDataMaskedCRC]));
             },
             highWaterMark: options === null || options === void 0 ? void 0 : options.highWaterMark,
-        });
-        if (!(options === null || options === void 0 ? void 0 : options.filePath)) {
-            return transformer;
+        }, fileStream);
+        if (fileStream) {
+            transformer.pipe(fileStream);
         }
-        // File output mode
-        if (!fs) {
-            throw new Error("File output is only available in Node.js. Use transformStream() without filePath in the browser.");
-        }
-        const fileStream = fs.createWriteStream(options.filePath);
-        transformer.pipe(fileStream);
-        return {
-            write: (record) => transformer.write(record),
-            end: () => new Promise((resolve, reject) => {
-                transformer.end();
-                (0, stream_1.finished)(fileStream, (err) => {
-                    if (err) {
-                        reject(err);
-                    }
-                    else {
-                        resolve();
-                    }
-                });
-            }),
-        };
+        return transformer;
     }
     constructor() {
         this.features = new tensorFlowRecordsProtoBuf_pb_1.Features();
diff --git a/src/tensorFlowBuilder.test.js b/src/tensorFlowBuilder.test.js
@@ -126,18 +126,19 @@ describe("TFRecords Builder Functions", function () {
             });
         }); });
         it("writes records to disk without holding them in memory", function () { return __awaiter(void 0, void 0, void 0, function () {
-            var writer, i, builder, stats;
+            var stream, i, builder, stats;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        writer = tensorFlowBuilder_1.TFRecordsBuilder.transformStream({ filePath: tempFile });
+                        stream = tensorFlowBuilder_1.TFRecordsBuilder.transformStream({ filePath: tempFile });
                         // Create and write multiple records
                         for (i = 0; i < 3; i++) {
                             builder = new tensorFlowBuilder_1.TFRecordsBuilder();
                             builder.addFeature("index", tensorFlowBuilder_1.FeatureType.Int64, i);
-                            writer.write(builder.build());
+                            stream.write(builder.build());
                         }
-                        return [4 /*yield*/, writer.end()];
+                        stream.end();
+                        return [4 /*yield*/, stream.finished];
                     case 1:
                         _a.sent();
                         return [4 /*yield*/, fs.promises.stat(tempFile)];
@@ -149,7 +150,7 @@ describe("TFRecords Builder Functions", function () {
             });
         }); });
         it("produces same output as in-memory buildTFRecords", function () { return __awaiter(void 0, void 0, void 0, function () {
-            var builder, record, inMemoryResult, writer, diskResult;
+            var builder, record, inMemoryResult, stream, diskResult;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
@@ -159,9 +160,10 @@ describe("TFRecords Builder Functions", function () {
                         builder.addArrayFeature("image/height", tensorFlowBuilder_1.FeatureType.String, ["1", "2"]);
                         record = builder.build();
                         inMemoryResult = tensorFlowBuilder_1.TFRecordsBuilder.buildTFRecords([record]);
-                        writer = tensorFlowBuilder_1.TFRecordsBuilder.transformStream({ filePath: tempFile });
-                        writer.write(record);
-                        return [4 /*yield*/, writer.end()];
+                        stream = tensorFlowBuilder_1.TFRecordsBuilder.transformStream({ filePath: tempFile });
+                        stream.write(record);
+                        stream.end();
+                        return [4 /*yield*/, stream.finished];
                     case 1:
                         _a.sent();
                         return [4 /*yield*/, fs.promises.readFile(tempFile)];
diff --git a/src/tensorFlowBuilder.test.ts b/src/tensorFlowBuilder.test.ts
@@ -89,16 +89,17 @@ describe("TFRecords Builder Functions", () => {
         });
 
         it("writes records to disk without holding them in memory", async () => {
-            const writer = TFRecordsBuilder.transformStream({ filePath: tempFile });
+            const stream = TFRecordsBuilder.transformStream({ filePath: tempFile });
 
             // Create and write multiple records
             for (let i = 0; i < 3; i++) {
                 const builder = new TFRecordsBuilder();
                 builder.addFeature("index", FeatureType.Int64, i);
-                writer.write(builder.build());
+                stream.write(builder.build());
             }
 
-            await writer.end();
+            stream.end();
+            await stream.finished;
 
             // Verify file exists and has content
             const stats = await fs.promises.stat(tempFile);
@@ -116,9 +117,10 @@ describe("TFRecords Builder Functions", () => {
             const inMemoryResult = TFRecordsBuilder.buildTFRecords([record]);
 
             // Build using file writer
-            const writer = TFRecordsBuilder.transformStream({ filePath: tempFile });
-            writer.write(record);
-            await writer.end();
+            const stream = TFRecordsBuilder.transformStream({ filePath: tempFile });
+            stream.write(record);
+            stream.end();
+            await stream.finished;
 
             // Read file contents and compare
             const diskResult = await fs.promises.readFile(tempFile);
diff --git a/src/tensorFlowBuilder.ts b/src/tensorFlowBuilder.ts
@@ -1,7 +1,7 @@
 import { TFRecordsImageMessage, Features, Feature,
     BytesList, Int64List, FloatList } from "./tensorFlowRecordsProtoBuf_pb";
 import { crc32c, getInt32Buffer, getInt64Buffer, maskCrc, textEncode } from "./tensorFlowHelpers";
-import { Transform, Readable, finished } from "stream";
+import { Transform, Readable, TransformOptions, finished } from "stream";
 
 // Conditionally import fs for Node.js environments
 let fs: typeof import("fs") | null = null;
@@ -11,16 +11,36 @@ try {
     // Not available in browser
 }
 
-export interface ITFRecordsFileWriter {
-    write(record: Buffer): boolean;
-    end(): Promise<void>;
-}
-
 export interface TransformStreamOptions {
     highWaterMark?: number;
     filePath?: string;
 }
 
+/**
+ * A Transform stream for TFRecords with an optional `finished` promise
+ * that resolves when the stream (and any piped file) is complete.
+ */
+export class TFRecordsTransform extends Transform {
+    /**
+     * A promise that resolves when the stream is finished writing.
+     * When piped to a file, this waits for the file to be fully written.
+     */
+    public finished: Promise<void>;
+
+    constructor(options?: TransformOptions, fileStream?: NodeJS.WritableStream) {
+        super(options);
+
+        // If there's a file stream, wait for it to finish; otherwise wait for this transform
+        const streamToWatch = fileStream || this;
+        this.finished = new Promise((resolve, reject) => {
+            finished(streamToWatch, (err) => {
+                if (err) reject(err);
+                else resolve();
+            });
+        });
+    }
+}
+
 /**
  * @name - TFRecords Feature Type
  * @description - Defines the type of TFRecords Feature
@@ -74,60 +94,48 @@ export class TFRecordsBuilder {
 
     /**
      * @description - Create a Transform stream for TFRecords.
-     *                Optionally writes directly to disk when filePath is provided.
+     *                Optionally pipes output directly to disk when filePath is provided.
      * @param optionsOrHighWaterMark - Stream buffer size (number) or options object
      * @param options.highWaterMark - Stream buffer size
-     * @param options.filePath - When provided, pipes output to this file (Node.js only)
-     * @returns - Transform stream, or ITFRecordsFileWriter when filePath is provided
+     * @param options.filePath - When provided, pipes output to this file (Node.js only).
+     *                           Use stream.finished promise to know when done.
+     * @returns - TFRecordsTransform stream with a `finished` promise
      */
-    public static transformStream(): Transform;
-    public static transformStream(highWaterMark: number): Transform;
-    public static transformStream(options: { highWaterMark?: number }): Transform;
-    public static transformStream(options: { filePath: string; highWaterMark?: number }): ITFRecordsFileWriter;
-    public static transformStream(optionsOrHighWaterMark?: TransformStreamOptions | number): Transform | ITFRecordsFileWriter {
+    public static transformStream(optionsOrHighWaterMark?: TransformStreamOptions | number): TFRecordsTransform {
         const options: TransformStreamOptions | undefined =
             typeof optionsOrHighWaterMark === "number"
                 ? { highWaterMark: optionsOrHighWaterMark }
                 : optionsOrHighWaterMark;
 
-        const transformer = new Transform({
-            transform: (record: Buffer, encoding, callback) => {
-                const length = record.length;
+        let fileStream: NodeJS.WritableStream | undefined;
+        if (options?.filePath) {
+            if (!fs) {
+                throw new Error("File output is only available in Node.js. Use transformStream() without filePath in the browser.");
+            }
+            fileStream = fs.createWriteStream(options.filePath);
+        }
 
-                // Get TFRecords CRCs for TFRecords Header and Footer
-                const bufferLength = getInt64Buffer(length);
-                const bufferLengthMaskedCRC = getInt32Buffer(maskCrc(crc32c(bufferLength)));
-                const bufferDataMaskedCRC = getInt32Buffer(maskCrc(crc32c(record)));
-                callback(undefined, Buffer.concat([bufferLength, bufferLengthMaskedCRC, record, bufferDataMaskedCRC]));
+        const transformer = new TFRecordsTransform(
+            {
+                transform: (record: Buffer, encoding, callback) => {
+                    const length = record.length;
+
+                    // Get TFRecords CRCs for TFRecords Header and Footer
+                    const bufferLength = getInt64Buffer(length);
+                    const bufferLengthMaskedCRC = getInt32Buffer(maskCrc(crc32c(bufferLength)));
+                    const bufferDataMaskedCRC = getInt32Buffer(maskCrc(crc32c(record)));
+                    callback(undefined, Buffer.concat([bufferLength, bufferLengthMaskedCRC, record, bufferDataMaskedCRC]));
+                },
+                highWaterMark: options?.highWaterMark,
             },
-            highWaterMark: options?.highWaterMark,
-        });
+            fileStream,
+        );
 
-        if (!options?.filePath) {
-            return transformer;
+        if (fileStream) {
+            transformer.pipe(fileStream);
         }
 
-        // File output mode
-        if (!fs) {
-            throw new Error("File output is only available in Node.js. Use transformStream() without filePath in the browser.");
-        }
-
-        const fileStream = fs.createWriteStream(options.filePath);
-        transformer.pipe(fileStream);
-
-        return {
-            write: (record: Buffer) => transformer.write(record),
-            end: () => new Promise<void>((resolve, reject) => {
-                transformer.end();
-                finished(fileStream, (err) => {
-                    if (err) {
-                        reject(err);
-                    } else {
-                        resolve();
-                    }
-                });
-            }),
-        };
+        return transformer;
     }
 
     private features: Features;

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`		`-export { FeatureType, TFRecordsBuilder, ITFRecordsFileWriter, TransformStreamOptions } from "./tensorFlowBuilder";`
	`1`	`+export { FeatureType, TFRecordsBuilder, TFRecordsTransform, TransformStreamOptions } from "./tensorFlowBuilder";`
`2`	`2`	`export { TFRecordsReader } from "./tensorFlowReader";`