v1.3.1

Author: wdhdev

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "easyscriptjs",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "description": "Easy Script is a npm package which makes coding in JavaScript easy!",
   "main": "src/index.js",
   "types": "src/index.d.ts",

package.json

@@ -1,23 +1,17 @@
 export function flip(): 0 | 1;
 export function id(length: number, amount?: 1): string;
 export function id(length: number, amount?: number): string[];
-export function log(...input: any[]): void;
 export function print(...input: any[]): void;
 export function random(max?: number): number;
 export function uuid(amount?: 1): string;
 export function uuid(amount?: number): string[];
 
 export declare const util: {
-    boolToNum(boolean: boolean): 0 | 1;
-    boolToStr(boolean: boolean): "true" | "false";
-    numToBool(number: 0 | 1): boolean;
+    boolToNum<B extends boolean>(boolean: B): B extends true ? 1 : 0;
+    boolToStr<B extends boolean>(boolean: B): B extends true ? "true" : false;
+    numToBool<N extends 0 | 1>(number: N): N extends 1 ? true : false;
     numToStr<N extends number>(number: N): `${N}`;
-    removeDuplicates(
-        arr: any[],
-        multi_dim?: boolean,
-        truthy_only?: boolean,
-        sort_by?: "alphabetic" | "numeric" | "lengthwise" | "none"
-    ): any[];
-    strToBool(string: string): boolean;
+    removeDuplicates(arr: any[], multi_dim?: boolean, truthy_only?: boolean, sort_by?: "alphabetic" | "numeric" | "lengthwise" | "none"): any[];
+    strToBool<S extends "true" | "false">(string: S): S extends "true" ? true : false;
     strToNum(string: string): number;
 };

src/index.d.ts

@@ -1,17 +1,16 @@
-module.exports = {
-    flip: require("./modules/flip"),
-    id: require("./modules/id"),
-    log: require("./modules/log"),
-    print: require("./modules/print"),
-    random: require("./modules/random"),
-    util: {
-        boolToNum: require("./modules/util/boolToNum"),
-        boolToStr: require("./modules/util/boolToStr"),
-        numToBool: require("./modules/util/numToBool"),
-        numToStr: require("./modules/util/numToStr"),
-        removeDuplicates: require("./modules/util/removeDuplicates"),
-        strToBool: require("./modules/util/strToBool"),
-        strToNum: require("./modules/util/strToNum")
-    },
-    uuid: require("./modules/uuid")
-}
+module.exports = {
+    flip: require("./modules/flip"),
+    id: require("./modules/id"),
+    print: require("./modules/print"),
+    random: require("./modules/random"),
+    util: {
+        boolToNum: require("./modules/util/boolToNum"),
+        boolToStr: require("./modules/util/boolToStr"),
+        numToBool: require("./modules/util/numToBool"),
+        numToStr: require("./modules/util/numToStr"),
+        removeDuplicates: require("./modules/util/removeDuplicates"),
+        strToBool: require("./modules/util/strToBool"),
+        strToNum: require("./modules/util/strToNum"),
+    },
+    uuid: require("./modules/uuid"),
+};

src/index.js

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

src/modules/flip.js

@@ -1,37 +1,37 @@
-/**
- * @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 { string | string[] } - Returns an array if the amount inputted is above 1, else returns a string.
- */
-
-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();
-
-        generatedIds.push(id);
-
-        i++;
-    } while (i < amount);
-
-    if (generatedIds.length === 1) return generatedIds[0];
-
-    return generatedIds;
-}
+/**
+ * @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 { string | string[] } - Returns an array if the amount inputted is above 1, else returns a string.
+ */
+
+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();
+
+        generatedIds.push(id);
+
+        i++;
+    } while (i < amount);
+
+    if (generatedIds.length === 1) return generatedIds[0];
+
+    return generatedIds;
+};

src/modules/id.js

@@ -1,11 +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 { void } - An instance of console.log() that is executed using `input`.
- */
-
-module.exports = function print(input) {
-    if (!input) throw new SyntaxError("No input specified");
-
-    return console.log(input);
-}
+/**
+ * @function `print` - Quickly log any data to the console.
+ * @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`.
+ */
+
+module.exports = function print(input) {
+    if (!input) throw new SyntaxError("No input specified");
+
+    return console.log(input);
+};

src/modules/log.js

@@ -1,14 +1,14 @@
-/**
- * @function `random` - Used to generate a random number between 1 and a max value.
- * @param { Number } [min] - The min value used. 
- * @param { Number } [max] - The max value used.
- * @returns { Number } - A random number between 1 and max (*parameter*). If max is *undefined*, will return a random number between 1 and 100.
- */
-
-module.exports = function random(min, max) {
-    if (max && !isFinite(max) || min && !isFinite(min)) throw new TypeError("Parameter number must be a number");
-    if (min >= max) throw new RangeError("Parameter min must be less than max");
-    else if (min <= 0 && min >= max) throw new RangeError("Parameter max must be greater than min");
-
-    return Math.floor(Math.random() * (max - min + 1) + min);
-}
+/**
+ * @function `random` - Used to generate a random number between 1 and a max value.
+ * @param { Number } [min] - The min value used.
+ * @param { Number } [max] - The max value used.
+ * @returns { Number } - A random number between 1 and max (*parameter*). If max is *undefined*, will return a random number between 1 and 100.
+ */
+
+module.exports = function random(min, max) {
+    if ((max && !isFinite(max)) || (min && !isFinite(min))) throw new TypeError("Parameter number must be a number");
+    if (min >= max) throw new RangeError("Parameter min must be less than max");
+    if (min <= 0 && min >= max) throw new RangeError("Parameter max must be greater than min");
+
+    return Math.floor(Math.random() * (max - min + 1) + min);
+};

src/modules/print.js

@@ -1,11 +1,11 @@
-/**
- * @function `boolToNum` - Convert a boolean to a number.
- * @param { Boolean } [boolean] - *Required* The boolean to be converted.
- * @returns { Number } - The output of the conversion.
- */
-
-module.exports = function boolToNum(boolean) {
-    if (typeof boolean !== "boolean") throw new TypeError("No boolean provided");
-
-    return boolean === true ? 1 : 0;
-}
+/**
+ * @function `boolToNum` - Convert a boolean to a number.
+ * @param { Boolean } [boolean] - *Required* The boolean to be converted.
+ * @returns { Number } - The output of the conversion.
+ */
+
+module.exports = function boolToNum(boolean) {
+    if (typeof boolean !== "boolean") throw new TypeError("No boolean provided");
+
+    return boolean === true ? 1 : 0;
+};