v1.2.4

A release cleaning up some code and updating JSDocs.

Author: wdhdev

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "easyscriptjs",
-  "version": "1.2.3",
+  "version": "1.2.4",
   "description": "Easy Script is a npm package which makes coding in JavaScript easy!",
   "main": "src/index.js",
   "scripts": {},

package.json

@@ -1,7 +1,7 @@
-const modules = {
+module.exports = {
     dns: {
         a: require("./modules/dns/a"),
-        cname: require("./modules/dns/cname"),
+        cname: require("./modules/dns/cname")
     },
     flip: require("./modules/flip"),
     id: require("./modules/id"),
@@ -19,5 +19,3 @@ const modules = {
     },
     uuid: require("./modules/uuid")
 }
-
-module.exports = modules;

src/index.js

@@ -1,12 +1,11 @@
 /**
  * @function `validateARecord` - Validate an A record
+ * @param { String } [record] - *Required* The record to be validated.
  * @returns { Boolean } - Returns true if valid, returns false if invalid
  */
 
-function validateARecord(record) {
+module.exports = function validateARecord(record) {
     const regex = /^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$/;
 
     return regex.test(record);
 }
-
-module.exports = validateARecord;

src/modules/dns/a.js

@@ -1,12 +1,11 @@
 /**
  * @function `validateCNAMERecord` - Validate a CNAME record
+ * @param { String } [record] - *Required* The record to be validated.
  * @returns { Boolean } - Returns true if valid, returns false if invalid
  */
 
-function validateCNAMERecord(record) {
+module.exports = function validateCNAMERecord(record) {
     const regex = /^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9])$/;
 
     return regex.test(record);
 }
-
-module.exports = validateCNAMERecord;

src/modules/dns/cname.js

@@ -3,8 +3,6 @@
  * @returns { Number } - Returns 1 for heads or 0 for tails
  */
 
-function flip() {
+module.exports = function flip() {
     return Math.random() >= 0.5 ? 1 : 0;
 }
-
-module.exports = flip;

src/modules/flip.js

@@ -1,44 +1,37 @@
-const { customAlphabet } = require("nanoid");
-
 /**
  * @function `id` - Generate a unique ID composed of random characters and numbers.
  * @param { Number } [length] - The length of each ID.
  * @param { Number } [amount] - The amount of IDs to generate. Condition: **`1 < amount < 64`**
- * @returns { Array } - Returns an array if the amount inputted is above 1.
- * @returns { String } - Returns a string if the amount inputted is equal to 1.
+ * @returns { string | string[] } - Returns an array if the amount inputted is above 1, else returns a string.
  */
 
-function generateId(length, amount) {
-    let ids = [];
+const { customAlphabet } = require("nanoid");
+
+module.exports = function id(length, amount) {
+    if (!length) throw new SyntaxError("No length specified");
+    if (typeof length !== "number") throw new TypeError("Length must be Number type");
+
+    let ids = 1;
+
+    if (amount && !isFinite(amount)) throw new TypeError("Amount must be Number type");
+    if ((amount && amount < 1) || (amount && amount >= 64)) throw new RangeError("Amount must be equal or higher than 1 and lower than 64");
+
+    if (amount) ids = amount;
+
+    let generatedIds = [];
 
     let i = 0;
 
     do {
         const nanoid = customAlphabet("1234567890abcdefghijklmnopqrstuvwxyz", length );
         const id = nanoid();
 
-        ids.push(id);
+        generatedIds.push(id);
 
         i++;
     } while (i < amount);
 
-    if (ids.length === 1) ids = ids[0];
+    if (generatedIds.length === 1) return generatedIds[0];
 
-    return ids;
+    return generatedIds;
 }
-
-function id(length, amount) {
-    if (!length) throw new SyntaxError("No length specified");
-    if (typeof length !== "number") throw new TypeError("Length must be Number type");
-
-    let ids = 1;
-
-    if (amount && !isFinite(amount)) throw new TypeError("Amount must be Number type");
-    if ((amount && amount < 1) || (amount && amount >= 64)) throw new RangeError("Amount must be equal or higher than 1 and lower than 64");
-
-    if (amount) ids = amount;
-
-    return generateId(length, amount);
-}
-
-module.exports = id;

src/modules/id.js

@@ -1,13 +1,11 @@
 /**
  * @function `log` - Quickly log any data to the console.
- * @param { any } input - *Required* The data that will be passed on to the console.
- * @returns { Function } - An instance of console.log() that is executed using `input`
+ * @param { any } [input] - *Required* The data that will be passed on to the console.
+ * @returns { void } - An instance of console.log() that is executed using `input`.
  */
 
-function log(input) {
+module.exports = function log(input) {
     if (!input) throw new SyntaxError("No input specified");
 
     return console.log(input);
 }
-
-module.exports = log;

src/modules/log.js

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

src/modules/print.js

@@ -4,7 +4,7 @@
  * @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) {
+module.exports = function random(max) {
     let highest = 100;
 
     if (max && !isFinite(max)) throw new TypeError("Max number must be a number");
@@ -16,5 +16,3 @@ function random(max) {
 
     return result;
 }
-
-module.exports = random;