@valkyriestudios/utils 12.20.0 → 12.22.0

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/package.json

@@ -1 +1 @@
-{ "name": "@valkyriestudios/utils", "version": "12.20.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.22.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/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

@@ -18,7 +18,7 @@ function humanizeNumber(val, options = {}) {
             : DEFAULT_UNITS;
     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 ? '-' : '';
@@ -30,7 +30,7 @@ function humanizeNumber(val, options = {}) {
             unit_ix++;
         }
     }
-    const humanized = `${(0, round_1.round)(normalized, PRECISION)}`.split('.', 2);
+    const humanized = ('' + (0, round_1.round)(normalized, PRECISION)).split('.', 2);
     const integer_part = humanized[0];
     const integer_part_len = integer_part.length;
     let formattedIntegerPart = '';

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,7 +14,7 @@ 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--;
     }
     return sanitized.substring(0, end).trim() + postfix;