nhb-toolbox 0.9.7 → 0.9.9

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export { capitalizeString, truncateString, generateRandomID } from './string';
+export { getRandomNumber, convertToDecimal } from './number';
 export { getColorForFirstCharacter } from './colors';
 export { generateRandomColor } from './colors/random';
 export { convertHexToHsl, convertHexToRgb, convertHslToHex, convertHslToRgb, convertRgbToHex, convertRgbToHsl, } from './colors/convert';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAE9E,OAAO,EAAE,yBAAyB,EAAE,MAAM,UAAU,CAAC;AAErD,OAAO,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAEtD,OAAO,EACN,eAAe,EACf,eAAe,EACf,eAAe,EACf,eAAe,EACf,eAAe,EACf,eAAe,GACf,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAE5D,OAAO,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAE9E,OAAO,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAE7D,OAAO,EAAE,yBAAyB,EAAE,MAAM,UAAU,CAAC;AAErD,OAAO,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAEtD,OAAO,EACN,eAAe,EACf,eAAe,EACf,eAAe,EACf,eAAe,EACf,eAAe,EACf,eAAe,GACf,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAE5D,OAAO,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC"}

package/dist/index.js

@@ -1,10 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateQueryParams = exports.createSelectOptions = exports.flattenArray = exports.convertRgbToHsl = exports.convertRgbToHex = exports.convertHslToRgb = exports.convertHslToHex = exports.convertHexToRgb = exports.convertHexToHsl = exports.generateRandomColor = exports.getColorForFirstCharacter = exports.generateRandomID = exports.truncateString = exports.capitalizeString = void 0;
+exports.generateQueryParams = exports.createSelectOptions = exports.flattenArray = exports.convertRgbToHsl = exports.convertRgbToHex = exports.convertHslToRgb = exports.convertHslToHex = exports.convertHexToRgb = exports.convertHexToHsl = exports.generateRandomColor = exports.getColorForFirstCharacter = exports.convertToDecimal = exports.getRandomNumber = exports.generateRandomID = exports.truncateString = exports.capitalizeString = void 0;
 var string_1 = require("./string");
 Object.defineProperty(exports, "capitalizeString", { enumerable: true, get: function () { return string_1.capitalizeString; } });
 Object.defineProperty(exports, "truncateString", { enumerable: true, get: function () { return string_1.truncateString; } });
 Object.defineProperty(exports, "generateRandomID", { enumerable: true, get: function () { return string_1.generateRandomID; } });
+var number_1 = require("./number");
+Object.defineProperty(exports, "getRandomNumber", { enumerable: true, get: function () { return number_1.getRandomNumber; } });
+Object.defineProperty(exports, "convertToDecimal", { enumerable: true, get: function () { return number_1.convertToDecimal; } });
 var colors_1 = require("./colors");
 Object.defineProperty(exports, "getColorForFirstCharacter", { enumerable: true, get: function () { return colors_1.getColorForFirstCharacter; } });
 var random_1 = require("./colors/random");

package/dist/number/index.d.ts

@@ -0,0 +1,21 @@
+import type { DecimalOptions, RandomNumberOptions } from './types';
+/**
+ * * Utility to generate a random number between a given range.
+ * * If no options are provided, it will generate a random number between `0` and `100` (inclusive).
+ * * If `min` is greater than `max`, it will swap the values and generate a random number.
+ *
+ * @param options - Options for configuring random number generator.
+ * @returns Random number.
+ */
+export declare const getRandomNumber: (options?: RandomNumberOptions) => number;
+/**
+ * * Utility to round a number to a given decimal places.
+ *
+ * @param num - Number to round.
+ * @param options - Options for rounding behavior, including decimal places and return type.
+ * @param options.decimalPlaces - Number of decimal places to round to.
+ * @param options.isString - Flag to determine if the result should be returned as a string (default: `false`).
+ * @returns - Rounded number (as a `number`) or string (if `isString` is `true`).
+ */
+export declare const convertToDecimal: (num: number, options?: DecimalOptions) => number | string;
+//# sourceMappingURL=index.d.ts.map

package/dist/number/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/number/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAEnE;;;;;;;GAOG;AACH,eAAO,MAAM,eAAe,aAAc,mBAAmB,KAAG,MA+C/D,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,gBAAgB,QACvB,MAAM,YACD,cAAc,KACtB,MAAM,GAAG,MAQX,CAAC"}

package/dist/number/index.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.convertToDecimal = exports.getRandomNumber = void 0;
+/**
+ * * Utility to generate a random number between a given range.
+ * * If no options are provided, it will generate a random number between `0` and `100` (inclusive).
+ * * If `min` is greater than `max`, it will swap the values and generate a random number.
+ *
+ * @param options - Options for configuring random number generator.
+ * @returns Random number.
+ */
+const getRandomNumber = (options) => {
+    const { min = 0, max = 100, includeMin = true, includeMax = true, } = options || {};
+    let minimum = min, maximum = max;
+    if (min > max) {
+        [minimum, maximum] = [max, min];
+        return (0, exports.getRandomNumber)({
+            min: minimum,
+            max: maximum,
+            includeMin,
+            includeMax,
+        });
+    }
+    if (min === max) {
+        return min;
+    }
+    if (includeMin && includeMax) {
+        // Generate random number between min and max, inclusive
+        return Math.floor(Math.random() * (max - min + 1)) + min;
+    }
+    if (!includeMin && !includeMax) {
+        // Generate random number between min and max, exclusive
+        return Math.floor(Math.random() * (max - min - 1)) + min + 1;
+    }
+    if (includeMin && !includeMax) {
+        // Generate random number between min and max, inclusive of min but exclusive of max
+        return Math.floor(Math.random() * (max - min)) + min;
+    }
+    if (!includeMin && includeMax) {
+        // Generate random number between min and max, exclusive of min but inclusive of max
+        return Math.floor(Math.random() * (max - min)) + min + 1;
+    }
+    return 0;
+};
+exports.getRandomNumber = getRandomNumber;
+/**
+ * * Utility to round a number to a given decimal places.
+ *
+ * @param num - Number to round.
+ * @param options - Options for rounding behavior, including decimal places and return type.
+ * @param options.decimalPlaces - Number of decimal places to round to.
+ * @param options.isString - Flag to determine if the result should be returned as a string (default: `false`).
+ * @returns - Rounded number (as a `number`) or string (if `isString` is `true`).
+ */
+const convertToDecimal = (num, options) => {
+    const { decimalPlaces = 2, isString = false } = options || {};
+    if (isString) {
+        return num.toFixed(decimalPlaces); // Return as string
+    }
+    return parseFloat(num.toFixed(decimalPlaces)); // Return as number
+};
+exports.convertToDecimal = convertToDecimal;

package/dist/number/types.d.ts

@@ -0,0 +1,19 @@
+/** - Options for random number generator */
+export interface RandomNumberOptions {
+    /** Minimum number to start with. */
+    min?: number;
+    /** Maximum number to end with. */
+    max?: number;
+    /** Whether to include the minimum number. */
+    includeMin?: boolean;
+    /** Whether to include the maximum number. */
+    includeMax?: boolean;
+}
+/** Decimal options for converting to decimal */
+export interface DecimalOptions {
+    /** Number of decimal places to round to. Defaults to `2`. */
+    decimalPlaces?: number;
+    /** If the return value is in `string` or `number`. Defaults to `false`. */
+    isString?: boolean;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/number/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/number/types.ts"],"names":[],"mappings":"AAAA,4CAA4C;AAC5C,MAAM,WAAW,mBAAmB;IACnC,oCAAoC;IACpC,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,kCAAkC;IAClC,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,6CAA6C;IAC7C,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,6CAA6C;IAC7C,UAAU,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,gDAAgD;AAChD,MAAM,WAAW,cAAc;IAC9B,6DAA6D;IAC7D,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,2EAA2E;IAC3E,QAAQ,CAAC,EAAE,OAAO,CAAC;CACnB"}

package/dist/number/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nhb-toolbox",
-  "version": "0.9.7",
+  "version": "0.9.9",
   "description": "A versatile collection of smart, efficient, and reusable utility functions for everyday development needs.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",