feat: docstrings for InputFile class

Author: loks0n

templates/node/index.d.ts.twig

@@ -250,7 +250,7 @@ declare module "{{ language.params.npmPackage|caseDash }}" {
      * @throws {{ '{' }}{{ spec.title | caseUcfirst}}Exception}
      * @returns {Promise}
      */
-    {{ method.name | caseCamel }}{% if generics %}<{{generics}}>{% endif %}({% for parameter in method.parameters.all %}{{ parameter.name | caseCamel | escapeKeyword }}{% if not parameter.required or parameter.nullable %}?{% endif %}: {{ parameter | typeName }}{% if not loop.last %}, {% endif %}{% endfor %}): Promise<{% if method.type == 'location' %}Buffer{% else %}{% if method.responseModel and method.responseModel != 'any' %}{% if not spec.definitions[method.responseModel].additionalProperties %}Models.{% endif %}{{method.responseModel | caseUcfirst}}{% if generics_return %}<{{generics_return}}>{% endif %}{% else %}{% if method.method == 'delete' %}string{% else %}any{% endif %}{% endif %}{% endif %}>;
+    {{ method.name | caseCamel }}{% if generics %}<{{generics}}>{% endif %}({% for parameter in method.parameters.all %}{{ parameter.name | caseCamel | escapeKeyword }}{% if not parameter.required or parameter.nullable %}?{% endif %}: {{ parameter | typeName }}{% if not loop.last %}, {% endif %}{% endfor %}): Promise<{% if method.type == 'location' %}ArrayBuffer{% else %}{% if method.responseModel and method.responseModel != 'any' %}{% if not spec.definitions[method.responseModel].additionalProperties %}Models.{% endif %}{{method.responseModel | caseUcfirst}}{% if generics_return %}<{{generics_return}}>{% endif %}{% else %}{% if method.method == 'delete' %}string{% else %}any{% endif %}{% endif %}{% endif %}>;
 {% endfor %}
   }
 {% endfor %}

templates/node/lib/inputFile.js.twig

@@ -1,45 +1,96 @@
-const { readFileSync } = require("fs");
+const fs = require("fs");
 const { ReadableStream } = require("stream/web");
 
-const _bufferToString = (buffer) => {
+/**
+ * @param {fs.ReadStream} readStream
+ * @returns {ReadableStream}
+ */
+function convertReadStreamToReadableStream(readStream) {
+  return new ReadableStream({
+    start(controller) {
+      readStream.on("data", (chunk) => {
+        controller.enqueue(chunk);
+      });
+      readStream.on("end", () => {
+        controller.close();
+      });
+      readStream.on("error", (err) => {
+        controller.error(err);
+      });
+    },
+    cancel() {
+      readStream.destroy();
+    },
+  });
+}
+
+/**
+ * @param {Buffer} buffer
+ * @returns {ReadableStream}
+ */
+function bufferToReadableStream(buffer) {
   return new ReadableStream({
     start(controller) {
       controller.enqueue(buffer);
       controller.close();
     },
   });
-};
+}
 
 class InputFile {
-  stream; // Content of file as a stream
-  size; // Total final size of the file content
-  filename; // File name
+  /** @type {ReadableStream} Content of file as a stream */
+  stream;
+
+  /** @type {number} Total final size of the file content */
+  size;
 
+  /** @type {string} File name */
+  filename;
+
+  /**
+   * @param {string} filePath
+   * @param {string} filename
+   * @returns {InputFile}
+   */
   static fromPath = (filePath, filename) => {
-    const data = readFileSync(filePath);
-    const stream = _bufferToString(data);
-    const size = data.byteLength;
+    const nodeStream = fs.createReadStream(filePath);
+    const stream = convertReadStreamToReadableStream(nodeStream);
+    const size = fs.statSync(filePath).size;
     return new InputFile(stream, filename, size);
   };
 
+  /**
+   * @param {Buffer} buffer
+   * @param {string} filename
+   * @returns {InputFile}
+   */
   static fromBuffer = (buffer, filename) => {
-    const stream = _bufferToString(buffer);
+    const stream = bufferToReadableStream(buffer);
     const size = buffer.byteLength;
     return new InputFile(stream, filename, size);
   };
 
+  /**
+   * @param {string} content
+   * @param {string} filename
+   * @returns {InputFile}
+   */
   static fromPlainText = (content, filename) => {
-    const buffer = new TextEncoder().encode(content);
-    const stream = _bufferToString(buffer);
-    const size = buffer.byteLength;
-    return new InputFile(stream, filename, size);
+    const array = new TextEncoder().encode(content);
+    const buffer = Buffer.from(array);
+    return InputFile.fromBuffer(buffer, filename);
   };
 
+  /**
+   * @param {ReadableStream} stream
+   * @param {string} filename
+   * @param {number} size
+   */
   constructor(stream, filename, size) {
     this.stream = stream;
     this.filename = filename;
     this.size = size;
   }
 }
 
-module.exports = InputFile;
+module.exports = InputFile;