changes for type-checking and some JSDoc comments

jsconfig.json

@@ -0,0 +1,5 @@
+{
+    "compilerOptions": {
+        "checkJs": true
+    }
+}

package.json

@@ -8,6 +8,7 @@
   },
   "scripts": {
     "build": "webpack",
+    "typegen": "tsc src/*.js --outDir dist/types --allowJs --declaration --emitDeclarationOnly",
     "dev": "webpack serve --no-client-overlay",
     "test": "node tests/index.js"
   },
@@ -29,7 +30,8 @@
   "homepage": "https://github.com/xenova/transformers.js#readme",
   "dependencies": {
     "jimp": "^0.22.7",
-    "onnxruntime-web": "^1.14.0"
+    "onnxruntime-web": "^1.14.0",
+    "typescript": "^5.0.2"
   },
   "devDependencies": {
     "copy-webpack-plugin": "^11.0.0",

src/tensor_utils.js

@@ -26,6 +26,11 @@ class Tensor extends ONNX.Tensor {
 
     }
 
+    /**
+     * 
+     * @param {number} index 
+     * @returns 
+     */
     get(index) {
         const iterDims = this.dims.slice(1);
         if (iterDims.length > 0) {
@@ -46,6 +51,12 @@ class Tensor extends ONNX.Tensor {
         return -1;
     }
 
+    /**
+     * @param {number} index 
+     * @param {number} iterSize 
+     * @param {number} iterDims 
+     * @returns {this}
+     */
     _subarray(index, iterSize, iterDims) {
         let data = this.data.subarray(index * iterSize, (index + 1) * iterSize);
         return new Tensor(this.type, data, iterDims);

src/utils.js

@@ -4,6 +4,9 @@ const fs = require('fs');
 const { env } = require('./env.js');
 
 class FileResponse {
+    /**
+     * @param {string} filePath 
+     */
     constructor(filePath) {
         this.filePath = filePath;
         this.headers = {};