@valkyriestudios/utils 12.19.0 → 12.21.0

package/number/isBetween.js

@@ -3,10 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.isNumberBetween = isNumberBetween;
 exports.default = isNumberBetween;
 function isNumberBetween(val, min, max) {
-    if (!Number.isFinite(val) ||
-        !Number.isFinite(min) ||
-        !Number.isFinite(max) ||
-        min >= max)
-        return false;
-    return val >= min && val <= max;
+    return (Number.isFinite(val) &&
+        Number.isFinite(min) &&
+        Number.isFinite(max) &&
+        (val >= min && val <= max));
 }

package/number/isInteger.d.ts

@@ -1,9 +1,7 @@
 /**
  * Check whether or not a provided value is an integer
  *
- * @param val - Value to verify
- *
- * @returns Whether or not the value is an integer
+ * @param {unknown} val - Value to verify
  */
 declare function isInteger(val: unknown): val is number;
 export { isInteger, isInteger as default };

package/number/isIntegerAbove.d.ts

@@ -1,10 +1,8 @@
 /**
  * Check whether or not the provided value is an integer above another value
  *
- * @param val - Value to verify
- * @param ref - Reference the provided value needs to be above
- *
- * @returns Whether or not the value is above the reference
+ * @param {unknown} val - Value to verify
+ * @param {number} ref - Reference the provided value needs to be above
  */
 declare function isIntegerAbove(val: unknown, ref: number): val is number;
 export { isIntegerAbove, isIntegerAbove as default };

package/number/isIntegerAboveOrEqual.d.ts

@@ -2,10 +2,8 @@
  * Check whether or not the provided value is an integer above or equal
  * to another value
  *
- * @param val - Value to verify
- * @param ref - Reference the provided value needs to be above or equal to
- *
- * @returns Whether or not the value is above or equal to the reference
+ * @param {unknown} val - Value to verify
+ * @param {number} ref - Reference the provided value needs to be above or equal to
  */
 declare function isIntegerAboveOrEqual(val: unknown, ref: number): val is number;
 export { isIntegerAboveOrEqual, isIntegerAboveOrEqual as default };

package/number/isIntegerBelow.d.ts

@@ -1,10 +1,8 @@
 /**
  * Check whether or not the provided value is an integer below another value
  *
- * @param val - Value to verify
- * @param ref - Reference the provided value needs to be below
- *
- * @returns Whether or not the value is below the reference
+ * @param {unknown} val - Value to verify
+ * @param {number} ref - Reference the provided value needs to be below
  */
 declare function isIntegerBelow(val: unknown, ref: number): val is number;
 export { isIntegerBelow, isIntegerBelow as default };

package/number/isIntegerBelowOrEqual.d.ts

@@ -2,10 +2,8 @@
  * Check whether or not the provided value is an integer below or
  * equal to another value
  *
- * @param val - Value to verify
- * @param ref - Reference the provided value needs to be below or equal to
- *
- * @returns Whether or not the value is below or equal to the reference
+ * @param {unknown} val - Value to verify
+ * @param {number} ref - Reference the provided value needs to be below or equal to
  */
 declare function isIntegerBelowOrEqual(val: unknown, ref: number): val is number;
 export { isIntegerBelowOrEqual, isIntegerBelowOrEqual as default };

package/number/isIntegerBetween.d.ts

@@ -3,11 +3,9 @@
  * inclusive of min and max
  * equal to another value
  *
- * @param val - Value to verify
- * @param min - Lower boundary
- * @param max - Upper boundary
- *
- * @returns Whether or not the value is an integer between min and max inclusive
+ * @param {unknown} val - Value to verify
+ * @param {number} min - Lower boundary
+ * @param {number} max - Upper boundary
  */
 declare function isIntegerBetween(val: unknown, min: number, max: number): val is number;
 export { isIntegerBetween, isIntegerBetween as default };

package/number/isIntegerBetween.js

@@ -3,10 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.isIntegerBetween = isIntegerBetween;
 exports.default = isIntegerBetween;
 function isIntegerBetween(val, min, max) {
-    if (!Number.isInteger(val) ||
-        !Number.isFinite(min) ||
-        !Number.isFinite(max) ||
-        min >= max)
-        return false;
-    return val >= min && val <= max;
+    return (Number.isInteger(val) &&
+        Number.isFinite(min) &&
+        Number.isFinite(max) &&
+        (val >= min && val <= max));
 }

package/number/isNumericalNaN.d.ts

@@ -1,9 +1,7 @@
 /**
  * Check whether or not the provided value is a numerical NaN
  *
- * @param val - Value to verify
- *
- * @returns Whether or not the value is a numerical NaN
+ * @param {unknown} val - Value to verify
  */
 declare function isNumericalNaN(val: unknown): boolean;
 export { isNumericalNaN, isNumericalNaN as default };

package/number/randomBetween.d.ts

@@ -1,10 +1,8 @@
 /**
  * Generates a random number between the provided lower and upper bound
  *
- * @param min - (default=0) Lower bound
- * @param max - (default=10) Upper bound
- *
- * @returns Random number between min and max
+ * @param {number} min - (default=0) Lower bound
+ * @param {number} max - (default=10) Upper bound
  */
 declare function randomBetween(min?: number, max?: number): number;
 export { randomBetween, randomBetween as default };

package/number/randomIntBetween.d.ts

@@ -2,10 +2,8 @@
  * Generates a random integer between the provided lower and upper bound,
  * not inclusive of the upper bound
  *
- * @param min - (default=0) Lower bound
- * @param max - (default=10) Upper bound
- *
- * @returns Random integer between min and max
+ * @param {number} min - (default=0) Lower bound
+ * @param {number} max - (default=10) Upper bound
  */
 declare function randomIntBetween(min?: number, max?: number): number;
 export { randomIntBetween, randomIntBetween as default };

package/number/round.d.ts

@@ -1,10 +1,8 @@
 /**
  * Rounds the provided value to a certain precision
  *
- * @param val - Value to round
- * @param precision - (default=0) Amount of decimals precision to round to
- *
- * @returns Rounded value according to decimal precision provided
+ * @param {number} val - Value to round
+ * @param {number} precision - (default=0) Amount of decimals precision to round to
  */
 declare function round(val: number, precision?: number): number;
 export { round, round as default };

package/number/round.js

@@ -2,10 +2,12 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.round = round;
 exports.default = round;
+const ROUND_EPSILON = 1 + Number.EPSILON;
 function round(val, precision = 0) {
     if (!Number.isFinite(val))
         throw new TypeError('Value should be numeric');
-    const exp = Math.pow(10, Number.isInteger(precision) && precision > 0 ? precision : 0);
-    const num = (val * exp) * (1 + Number.EPSILON);
-    return Math.round(num) / exp;
+    if (!Number.isInteger(precision) || precision <= 0)
+        return Math.round(val * ROUND_EPSILON);
+    const exp = Math.pow(10, precision);
+    return Math.round((val * exp) * ROUND_EPSILON) / exp;
 }

package/number/toPercentage.d.ts

@@ -1,12 +1,10 @@
 /**
  * Converts a number into a percentage respective to a provided range
  *
- * @param val - Value to convert into a percentage for the provided range
- * @param precision - (default=0) Amount of decimals precision to use
- * @param min - (default=0) Lower bound of the range the value is to be converted to percentage for
- * @param max - (default=1) Upper bound of the range the value is to be converted to percentage for
- *
- * @returns Percentage value respective to the provided range
+ * @param {number} val - Value to convert into a percentage for the provided range
+ * @param {number} precision - (default=0) Amount of decimals precision to use
+ * @param {number} min - (default=0) Lower bound of the range the value is to be converted to percentage for
+ * @param {number} max - (default=1) Upper bound of the range the value is to be converted to percentage for
  */
 declare function toPercentage(val: number, precision?: number, min?: number, max?: number): number;
 export { toPercentage, toPercentage as default };

package/object/define.d.ts

@@ -3,8 +3,6 @@
  *
  * @param props - Object with properties to define
  * @param obj - (default={}) Object to define on top of
- *
- * @returns Object with the defined properties
  */
 declare function define(props: {
     [key: string]: any;

package/object/is.d.ts

@@ -1,9 +1,7 @@
 /**
  * Check whether or not a provided value is an object
  *
- * @param val - Value to verify
- *
- * @returns Whether or not the value is an object
+ * @param {unknown} val - Value to verify
  */
 declare function isObject(val: unknown): val is {
     [key: string]: any;

package/object/isNotEmpty.d.ts

@@ -1,11 +1,7 @@
 /**
  * Check whether or not a provided value is an object with content
  *
- * @param val - Value to verify
- *
- * @returns Whether or not the value is an object with content
+ * @param {unknown} val - Value to verify
  */
-declare function isNotEmptyObject(val: unknown): val is {
-    [key: string]: any;
-};
+declare function isNotEmptyObject(val: unknown): val is Record<string, any>;
 export { isNotEmptyObject, isNotEmptyObject as default };

package/object/merge.d.ts

@@ -10,10 +10,8 @@ type MergeOptions = {
  * take note: this does not merge onto passed objects by reference but instead
  * returns a new object
  *
- * @param target - Base Object
- * @param source - (default={}) Object to merge onto base object
- *
- * @returns Combined target and source objects
+ * @param {Record<string,any>} target - Base Object
+ * @param {Record<string,any>|Record<string,any>[]} source - (default={}) Object to merge onto base object
  */
 declare function merge(target: Record<string, any>, source?: Record<string, any> | Record<string, any>[], opts?: MergeOptions): Record<string, any>;
 export { merge, merge as default };

package/object/merge.js

@@ -26,9 +26,8 @@ function merge(target, source = {}, opts = {}) {
     let acc = { ...target };
     for (let i = 0; i < sources.length; i++) {
         const el = sources[i];
-        if (Object.prototype.toString.call(el) !== PROTO_OBJ) {
-            throw new Error('object/merge: Please ensure valid target/source is passed');
-        }
+        if (Object.prototype.toString.call(el) !== PROTO_OBJ)
+            continue;
         acc = innerMerge(acc, el, union);
     }
     return acc;

package/object/pick.d.ts

@@ -9,8 +9,6 @@ type DottedKeys<T> = (T extends ObjectType ? {
  *
  * @param obj - Object to pick from
  * @param keys - Array of keys to pick from object
- *
- * @returns Object containing the picked keys from source object
  */
 declare function pick<T extends Record<string, any>, K extends DottedKeys<T>>(obj: T, keys: K[]): {
     [key: string]: any;

package/object/pick.js

@@ -18,7 +18,7 @@ function pick(obj, keys) {
         sanitized = key.trim();
         if (!sanitized.length)
             continue;
-        if (sanitized.includes('.')) {
+        if (sanitized.indexOf('.') >= 0) {
             val = (0, get_1.deepGet)(obj, sanitized);
             if (val === undefined)
                 continue;
@@ -27,9 +27,8 @@ function pick(obj, keys) {
             let cursor = map;
             for (let y = 0; y < parts_len - 1; y++) {
                 const part = parts[y].trim();
-                if (!cursor[part]) {
+                if (!cursor[part])
                     cursor[part] = {};
-                }
                 cursor = cursor[part];
             }
             cursor[parts[parts_len - 1].trim()] = val;

package/package.json

@@ -1 +1 @@
-{ "name": "@valkyriestudios/utils", "version": "12.19.0", "description": "A collection of single-function utilities for common tasks", "author": { "name": "Peter Vermeulen", "url": "https://www.linkedin.com/in/petervermeulen1/" }, "keywords": [ "utility", "library", "javascript", "js", "node", "bun" ], "license": "MIT", "repository": { "type": "git", "url": "git+https://github.com/ValkyrieStudios/utils.git" }, "bugs": { "url": "https://github.com/ValkyrieStudios/utils/issues" }, "homepage": "https://github.com/ValkyrieStudios/utils#readme", "types": "index.d.ts" }
+{ "name": "@valkyriestudios/utils", "version": "12.21.0", "description": "A collection of single-function utilities for common tasks", "author": { "name": "Peter Vermeulen", "url": "https://www.linkedin.com/in/petervermeulen1/" }, "keywords": [ "utility", "library", "javascript", "js", "node", "bun" ], "license": "MIT", "repository": { "type": "git", "url": "git+https://github.com/ValkyrieStudios/utils.git" }, "bugs": { "url": "https://github.com/ValkyrieStudios/utils/issues" }, "homepage": "https://github.com/ValkyrieStudios/utils#readme", "types": "index.d.ts" }

package/regexp/is.d.ts

@@ -1,9 +1,7 @@
 /**
  * Check whether or not a provided value is a RegExp instance
  *
- * @param val - Value to verify
- *
- * @returns Whether or not the value is a RegExp
+ * @param {unknown} val - Value to verify
  */
 declare function isRegExp(val: unknown): val is RegExp;
 export { isRegExp, isRegExp as default };

package/regexp/sanitize.d.ts

@@ -4,9 +4,7 @@
  *
  * For more info: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#Escaping
  *
- * @param val - Value to sanitize
- *
- * @returns Sanitized value
+ * @param {string} val - Value to sanitize
  */
 declare function sanitizeRegExp(val: string): string | false;
 export { sanitizeRegExp, sanitizeRegExp as default };

package/regexp/sanitize.js

@@ -2,8 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.sanitizeRegExp = sanitizeRegExp;
 exports.default = sanitizeRegExp;
+const RGX = /[.*+\-?^${}()|[\]\\]/g;
 function sanitizeRegExp(val) {
     if (typeof val !== 'string')
         return false;
-    return val.trim().replace(/[.*+\-?^${}()|[\]\\]/g, '\\$&');
+    return val.trim().replace(RGX, '\\$&');
 }

package/string/humanizeBytes.d.ts

@@ -32,9 +32,7 @@ interface humanizeBytesOptions {
  * 	humanizeBytes(-374237489237); // '-348.5 GB'
  *
  * @param {number|string} val - Number or string byte value to humanize (string should be convertible to a number)
- * @param {humanizeBytesOptions?} opts - Humanization options
- *
- * @returns Humanized byte value as string
+ * @param {humanizeBytesOptions} opts - Humanization options
  */
 declare function humanizeBytes(val: number | string, options?: humanizeBytesOptions): string;
 export { humanizeBytes, humanizeBytes as default };

package/string/humanizeBytes.js

@@ -3,21 +3,15 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.humanizeBytes = humanizeBytes;
 exports.default = humanizeBytes;
 const humanizeNumber_1 = require("./humanizeNumber");
-const isIntegerAboveOrEqual_1 = require("../number/isIntegerAboveOrEqual");
+const DEFAULT_UNITS = [' bytes', ' KB', ' MB', ' GB', ' TB', ' PB', ' EB', ' ZB', ' YB'];
 function humanizeBytes(val, options = {}) {
     return (0, humanizeNumber_1.humanizeNumber)(val, {
-        delim: typeof options?.delim === 'string'
-            ? options.delim
-            : ',',
-        separator: typeof options?.separator === 'string' && options.separator.trim().length
-            ? options.separator
-            : '.',
-        precision: (0, isIntegerAboveOrEqual_1.isIntegerAboveOrEqual)(options?.precision, 0)
-            ? options.precision
-            : 2,
+        delim: 'delim' in options ? options.delim : ',',
+        separator: 'separator' in options ? options.separator : '.',
+        precision: 'precision' in options ? options.precision : 2,
         units: Array.isArray(options?.units) && options.units.length
             ? options.units
-            : [' bytes', ' KB', ' MB', ' GB', ' TB', ' PB', ' EB', ' ZB', ' YB'],
+            : DEFAULT_UNITS,
         divider: 1024,
         real: true,
     });

package/string/humanizeNumber.d.ts

@@ -43,10 +43,8 @@ interface humanizeNumberOptions {
  *	humanizeNumber('-1500'); // '-1.5k'
  *	humanizeNumber(47328748923747923479); // '47,328.75q'
  *
- * @param val - Number or string value to humanize (string should be convertible to a number)
- * @param opts - (default={}) Pass to override options.
- *
- * @returns Humanized number as string
+ * @param {number|string} val - Number or string value to humanize (string should be convertible to a number)
+ * @param {humanizeNumberOptions} opts - (default={}) Pass to override options.
  */
 declare function humanizeNumber(val: number | string, options?: humanizeNumberOptions): string;
 export { humanizeNumber, humanizeNumber as default };

package/string/humanizeNumber.js

@@ -16,31 +16,29 @@ function humanizeNumber(val, options = {}) {
         : options?.units === false
             ? false
             : DEFAULT_UNITS;
-    let normalized = 0;
-    if (typeof val === 'string') {
-        normalized = REAL ? parseInt(val.trim(), 10) : parseFloat(val);
-    }
-    else if (Number.isFinite(val)) {
-        normalized = REAL ? Math.round(val) : val;
-    }
+    let normalized = typeof val === 'string' ? parseFloat(val.trim()) : val;
     if (!Number.isFinite(normalized) || normalized === 0)
-        return UNITS ? `0${UNITS[0]}` : '0';
+        return UNITS ? '0' + UNITS[0] : '0';
+    if (REAL)
+        normalized = Math.round(normalized);
     const sign = normalized < 0 ? '-' : '';
     normalized = Math.abs(normalized);
     let unit_ix = 0;
     if (UNITS) {
-        for (unit_ix; normalized >= DIVIDER && unit_ix < UNITS.length - 1; unit_ix++) {
+        while (normalized >= DIVIDER && unit_ix < UNITS.length - 1) {
             normalized /= DIVIDER;
+            unit_ix++;
         }
     }
-    const humanized = `${(0, round_1.round)(normalized, PRECISION)}`.split('.', 2);
-    const integerPart = humanized[0];
+    const humanized = ('' + (0, round_1.round)(normalized, PRECISION)).split('.', 2);
+    const integer_part = humanized[0];
+    const integer_part_len = integer_part.length;
     let formattedIntegerPart = '';
-    for (let i = 0; i < integerPart.length; i++) {
-        if (i > 0 && (integerPart.length - i) % 3 === 0) {
+    for (let i = 0; i < integer_part_len; i++) {
+        if (i > 0 && (integer_part_len - i) % 3 === 0) {
             formattedIntegerPart += DELIM;
         }
-        formattedIntegerPart += integerPart[i];
+        formattedIntegerPart += integer_part[i];
     }
-    return `${sign}${formattedIntegerPart}${humanized[1] ? SEPARATOR + humanized[1] : ''}${UNITS ? UNITS[unit_ix] : ''}`;
+    return sign + formattedIntegerPart + (humanized[1] ? SEPARATOR + humanized[1] : '') + (UNITS ? UNITS[unit_ix] : '');
 }

package/string/is.d.ts

@@ -1,9 +1,7 @@
 /**
  * Check whether or not a provided value is a string
  *
- * @param val - Value to verify
- *
- * @returns Whether or not the value is a string
+ * @param {unknown} val - Value to verify
  */
 declare function isString(val: unknown): val is string;
 export { isString, isString as default };

package/string/isBetween.d.ts

@@ -3,12 +3,10 @@
  * inclusive of min and max
  * equal to another value
  *
- * @param val - Value to verify
- * @param min - Lower boundary
- * @param max - Upper boundary
- * @param trimmed  - (default=true) Trim the string or not
- *
- * @returns Whether or not the value is a string of length between min and max inclusive
+ * @param {unknown} val - Value to verify
+ * @param {number} min - Lower boundary
+ * @param {number} max - Upper boundary
+ * @param {boolean} trimmed  - (default=true) Trim the string or not
  */
 declare function isStringBetween(val: unknown, min: number, max: number, trimmed?: boolean): val is string;
 export { isStringBetween, isStringBetween as default };

package/string/isNotEmpty.d.ts

@@ -1,10 +1,8 @@
 /**
  * Check whether or not a provided value is a string with content
  *
- * @param val - Value to verify
- * @param trimmed  - (default=true) Trim the string or not
- *
- * @returns Whether or not the value is a string with content
+ * @param {unknown} val - Value to verify
+ * @param {boolean} trimmed - (default=true) Trim the string or not
  */
 declare function isNotEmptyString(val: unknown, trimmed?: boolean): val is string;
 export { isNotEmptyString, isNotEmptyString as default };

package/string/shorten.d.ts

@@ -5,8 +5,6 @@
  * @param {number} length - Length to shorten it to
  * @param {string} postfix - (default:'...') Postfix to use in case the string got shortened
  * @param {boolean?} truncate_words - (default:true) Truncate words or not
- *
- * @returns Shortened string
  */
 declare function shorten(val: string, length: number, postfix?: string, truncate_words?: boolean): string;
 export { shorten, shorten as default };

package/string/shorten.js

@@ -14,11 +14,8 @@ function shorten(val, length, postfix = '...', truncate_words = true) {
     if (truncate_words)
         return truncated + postfix;
     let end = length;
-    while (end > 0 && sanitized[end] !== ' ' && sanitized[end - 1] !== ' ') {
+    while (end && sanitized[end] !== ' ' && sanitized[end - 1] !== ' ') {
         end--;
     }
-    if (end === 0) {
-        return sanitized.substring(0, length) + postfix;
-    }
     return sanitized.substring(0, end).trim() + postfix;
 }