v1.1.5

This release adds self-documenting to all modules.

Co-authored-by: Abdennour Boudjema <nourik27@gmail.com>

Author: wdhdev

package-lock.json

@@ -14,5 +14,6 @@ module.exports = {
     "util": {
         "removeDuplicates": require("./modules/util/removeDuplicates")
     },
+    "removeDuplicates": require("./modules/removeDuplicates"),
     "uuid": require("./modules/uuid")
 }

src/modules.js

@@ -1,5 +1,11 @@
+/**
+ * 
+ * @function `flip` - Quickly execute a heads or tails decision randomly 
+ * @returns {string} Returns "heads" or "tails" (*as string*)
+ */
+
 function flip() {
     return Math.random() >= 0.5 ? "heads" : "tails";
 }
 
-module.exports = flip;
+module.exports = flip;

src/modules/flip.js

@@ -1,5 +1,11 @@
 const { customAlphabet } = require("nanoid");
 
+/**
+ * @function `id` - Randomly generate a unique ID composed of random characters and numbers 
+ * @param {Number} length - (*Required*) The length of the ID. Condition: *`1 <= length <= 64`*
+ * @returns {String} A unique ID string of a specified length (e.g. *abthvmyt3h1j3it*)
+ */
+
 function id(length) {
     if(!length) throw new Error("No length specified");
     if(typeof length !== "number") throw new Error("Invalid type specified");
@@ -12,4 +18,4 @@ function id(length) {
     return id;
 }
 
-module.exports = id;
+module.exports = id;

src/modules/id.js

@@ -1,9 +1,13 @@
+/**
+ * @function `log` - Quickly log any data to the console.
+ * @param {any} input - *Required* The data that will be passed on to the console. Will throw an error if the input is undefined
+ * @returns {Function} an Instance of console.log() that is executed instantly using `input` 
+ */
+
 function log(input) {
-    if(!input) {
-        throw new Error("No input specified");
-    }
+    if(!input) throw new Error("No input specified");
 
     return console.log(input);
 }
 
-module.exports = log;
+module.exports = log;

src/modules/log.js

@@ -1,9 +1,13 @@
+/**
+ * @function `print` - Quickly log any data to the console.
+ * @param {any} input - *Required* The data that will be passed on to the console. Will throw an error if the input is undefined
+ * @returns {Function} An instance of console.log() that is executed instantly using `input` 
+ */
+
 function print(input) {
-    if(!input) {
-        throw new Error("No input specified");
-    }
+    if(!input) throw new Error("No input specified");
 
     return console.log(input);
 }
 
-module.exports = print;
+module.exports = print;

src/modules/print.js

@@ -1,3 +1,9 @@
+/**
+ * @function `random` - Used to generate a random number between 1 and a max value 
+ * @param {Number} [max] - The max value used. Condition: **`1 < max < 2_147_483_647`**
+ * @returns {Number} A random number between 1 and max (*parameter*). If max is *undefined*, will return a random number between 1 and 100
+ */
+
 function random(max) {
     let highest = 100;
 
@@ -11,4 +17,4 @@ function random(max) {
     return result;
 }
 
-module.exports = random;
+module.exports = random;

src/modules/random.js

@@ -65,7 +65,7 @@ const removeDuplicates = (
         });
     } else if (typeof truthy_only !== "boolean")
         throw new MethodException(
-            `Illegal use of parameter multi_dim  - Expected true or false - Found: ${truthy_only}`
+            `Illegal use of parameter truthy_only  - Expected true or false - Found: ${truthy_only}`
         );
 
     // Sort
@@ -122,7 +122,7 @@ const removeDuplicates = (
             } else if (e === "lengthwise") {
                 newArray.sort((a, b) =>
                     (typeof a === "string" && typeof b == "string") ||
-                    (Array.isArray(a) && Array.isArray(b))
+                        (Array.isArray(a) && Array.isArray(b))
                         ? a.length - b.length
                         : -1
                 );

src/modules/util/removeDuplicates.js

@@ -1,3 +1,8 @@
+/**
+ * @function `uuid` - Randomly generate a unique UUID composed of random characters and numbers 
+ * @returns {String} A unique UUID string that follows this rule: xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx
+ */
+
 function uuid() {
     var d = new Date().getTime();