Add types to cache library

Author: Surjit Kumar Sahoo

.vscode/settings.json

@@ -5,7 +5,7 @@
   "editor.tabSize": 2,
   "editor.insertSpaces": true,
   "editor.codeActionsOnSave": {
-    "source.fixAll": true
+    "source.fixAll": "explicit"
   },
   "eslint.alwaysShowStatus": true,
   "files.autoSave": "onFocusChange",

libs/cache/.gitignore

@@ -0,0 +1 @@
+dist

libs/cache/package.json

@@ -1,20 +1,27 @@
 {
-  "name": "cache",
-  "version": "1.0.0",
+  "name": "@surjit/cache",
+  "version": "0.0.2",
   "description": "A simple cache library",
   "author": "Surjit Kumar Sahoo",
   "license": "MIT",
-  "main": "src/index.js",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "type": "module",
+  "files": [
+    "dist"
+  ],
   "scripts": {
-    "test": "cross-env NODE_OPTIONS=--experimental-vm-modules jest"
+    "test": "cross-env NODE_OPTIONS=--experimental-vm-modules jest",
+    "build:types": "rimraf dist && tsc --declaration --outDir dist"
   },
   "engines": {
     "node": ">=14.5.0"
   },
   "devDependencies": {
     "@types/jest": "^29.2.4",
     "cross-env": "^7.0.3",
-    "jest": "^29.3.1"
+    "jest": "^29.3.1",
+    "rimraf": "^5.0.7",
+    "typescript": "^5.4.5"
   }
 }

libs/cache/src/memoryCache/memCache.js

@@ -20,7 +20,7 @@ export class Cache {
   #logger = console;
 
   /**
-   * @param {object=} config - Optional Config options
+   * @param {object} [config] - Optional Config options
    * @param {object} config.logger - A logger instance which must have .log method in it
    * @param {boolean} config.debug - Enable debug mode
    */
@@ -93,6 +93,10 @@ export class Cache {
     return value;
   }
 
+  /**
+   *
+   * @param {string} key
+   */
   #del(key) {
     this.#size -= 1;
     delete this.#cache[key];
@@ -135,6 +139,11 @@ export class Cache {
     }
   }
 
+  /**
+   * Get Cached data
+   * @param {string} key
+   * @returns {any}
+   */
   get(key) {
     const data = this.#cache[key];
     if (data) {
@@ -152,6 +161,9 @@ export class Cache {
     return null;
   }
 
+  /**
+   * Count the cache size
+   */
   get size() {
     return this.#size;
   }

libs/cache/tsconfig.json

@@ -0,0 +1,12 @@
+{
+  "compilerOptions": {
+    "noEmit": false,
+    "moduleResolution": "Node",
+    "target": "ESNext",
+    "allowJs": true,
+    "checkJs": true,
+    "esModuleInterop": true
+  },
+  "include": ["./src/**/*"],
+  "exclude": ["./src/**/*.test.js"]
+}