Merge pull request #74 from jrTilak/satnize/count

chore: sanitize count

src/www/src/configs/nav-links.json

@@ -31,18 +31,6 @@
         "label": "Arrays",
         "url": "/docs/functions/arrays",
         "methods": [
-          {
-            "label": "chunk",
-            "url": "/docs/functions/arrays/chunk"
-          },
-          {
-            "label": "compact",
-            "url": "/docs/functions/arrays/compact"
-          },
-          {
-            "label": "insert",
-            "url": "/docs/functions/arrays/insert"
-          },
           {
             "label": "partition",
             "url": "/docs/functions/arrays/partition"
@@ -74,6 +62,18 @@
           {
             "label": "zip",
             "url": "/docs/functions/arrays/zip"
+          },
+          {
+            "label": "chunk",
+            "url": "/docs/functions/arrays/chunk"
+          },
+          {
+            "label": "compact",
+            "url": "/docs/functions/arrays/compact"
+          },
+          {
+            "label": "insert",
+            "url": "/docs/functions/arrays/insert"
           }
         ]
       },

src/www/src/configs/prev-next-button-links.json

@@ -23,18 +23,6 @@
     "label": "Functions",
     "url": "/docs/functions"
   },
-  {
-    "label": "chunk",
-    "url": "/docs/functions/arrays/chunk"
-  },
-  {
-    "label": "compact",
-    "url": "/docs/functions/arrays/compact"
-  },
-  {
-    "label": "insert",
-    "url": "/docs/functions/arrays/insert"
-  },
   {
     "label": "partition",
     "url": "/docs/functions/arrays/partition"
@@ -67,6 +55,18 @@
     "label": "zip",
     "url": "/docs/functions/arrays/zip"
   },
+  {
+    "label": "chunk",
+    "url": "/docs/functions/arrays/chunk"
+  },
+  {
+    "label": "compact",
+    "url": "/docs/functions/arrays/compact"
+  },
+  {
+    "label": "insert",
+    "url": "/docs/functions/arrays/insert"
+  },
   {
     "label": "callAfter",
     "url": "/docs/functions/functional/callAfter"

src/www/src/registry/functions/functional/count/count.example.ts

@@ -1,13 +1,12 @@
-import count from "."
+import count from ".";
 
-const add =(a:number, b:number)=>{
-    return a+b;
-    }
+const add = (a: number, b: number) => {
+  return a + b;
+};
+
+const countAddFn = count(add);
+countAddFn(1, 2);
+countAddFn(3, 4);
 
-const countAddFn =  count(add);
-countAddFn(1,2);
-// Expected Output: Original function called 1 times
-countAddFn(3,4);
-// Expected Output: Original function called 2 times
 console.log(countAddFn.getCount());
-// Expected Output: 2
+// Expected Output: 2

src/www/src/registry/functions/functional/count/docs.md

@@ -4,4 +4,4 @@ desc: returns the result of a function and the number of times that function is
 
 The `count` function invokes another function passed as an `arg` and returns both the `result` of the invoked function and the `count of how many times the function has been called`.
 
-This is useful in when you need to keep a tab on how many times a function is being called which can be helpful in monitoring,debugging,testing,anayltics,resource management.
+This is useful in when you need to keep a tab on how many times a function is being called which can be helpful in monitoring, debugging, testing, analytics, resource management.

src/www/src/registry/functions/functional/count/index.test.ts

@@ -1,33 +1,30 @@
-import { expect, test, describe } from 'vitest'
-import count from "."
+import { expect, test, describe } from "vitest";
+import count from ".";
 
-describe('count', () => {
-    //Test case 1: Testing the wrapper function 
-    test('calls the function passed and returns the result', ()=>{
-        const mockFunction = (a: number, b: number): number => {
-            return a + b;
-        };
-        const countedFunction = count(mockFunction);
-        expect(countedFunction(1,2)).toBe(3);
-    })
+describe("count", () => {
+  //Test case 1: Testing the wrapper function
+  test("calls the function passed and returns the result", () => {
+    const mockFunction = (a: number, b: number): number => {
+      return a + b;
+    };
+    const countedFunction = count(mockFunction);
+    expect(countedFunction(1, 2)).toBe(3);
+  });
 
-
-    // Test case 2: Testing the getCount function
-    test('resturns the count of function calls', ()=>{
-        const mockFunction = (a: number, b: number): number => {
-            return Math.abs(a - b);
-        };
-        const countedFunction = count(mockFunction);
-        countedFunction(4,6);
-        countedFunction(10,6);
-        countedFunction(4,5);
-        countedFunction(4,13);
-        countedFunction(155,6);
-        countedFunction(109,126);
+  // Test case 2: Testing the getCount function
+  test("returns the count of function calls", () => {
+    const mockFunction = (a: number, b: number): number => {
+      return Math.abs(a - b);
+    };
+    const countedFunction = count(mockFunction);
+    countedFunction(4, 6);
+    countedFunction(10, 6);
+    countedFunction(4, 5);
+    countedFunction(4, 13);
+    countedFunction(155, 6);
+    countedFunction(109, 126);
 
-        //test the getCount method
-        expect(countedFunction.getCount()).toBe(6)
-    })
-
-
-})
+    //test the getCount method
+    expect(countedFunction.getCount()).toBe(6);
+  });
+});

src/www/src/registry/functions/functional/count/index.ts

@@ -1,23 +1,22 @@
 /**
- * Invokes the function passed with arguments and 
+ * Invokes the function passed with arguments and
  * counts how many times the function is executed.
- * 
+ *
  * @param {Function} fn - The function to be called.
  * @returns          - result: the result of the passed function invocation.
  *                    This function also has a getCount method attached.
- * @returns {Function} getCount - A method that returns the count of execution of the passed function. 
+ * @returns {Function} getCount - A method that returns the count of execution of the passed function.
  */
-const count = <T>(fn: (...args: any[]) => T) => {
+const count = <A extends any[], R>(fn: (...args: A) => R) => {
   let callCount = 0;
 
-  const wrapper = (...args: any[]): T => {
+  const wrapper = (...args: A): R => {
     callCount++;
     const result = fn(...args);
     return result;
   };
 
   const getCount: () => number = () => callCount;
-
   wrapper.getCount = getCount;
 
   return wrapper;

src/www/src/registry/functions/functional/count/props.ts

@@ -5,10 +5,9 @@ const Props: IRegistryFunctionPropTable[] = [
     title: "function",
     required: true,
     defaultValue: undefined,
-    propDesc:
-      "The function calculates count of exceution of func passed. The function receives a function as an argument.",
+    propDesc: "The function to count the number of times it is called.",
     type: "Function",
-  }
+  },
 ];
 
 export default Props;