@lowentry/utils 1.24.2 → 1.25.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lowentry/utils",
-  "version": "1.24.2",
+  "version": "1.25.1",
   "private": false,
   "type": "module",
   "main": "./index.js",

package/src/LeTypes.js

@@ -71,6 +71,73 @@ export const STRING_ANY = (...values) =>
 };
 
 
+/**
+ * Ensures the given value is a boolean.
+ *
+ * This will work differently than !!value, as it will try to figure out the most logical boolean value from the given value.
+ *
+ * @param {*} value
+ * @returns {boolean}
+ */
+export const BOOL = (value) =>
+{
+	return BOOL_ANY(value);
+};
+
+/**
+ * Returns the first non-null non-undefined boolean-castable value as a boolean.
+ *
+ * @param {*} values
+ * @returns {boolean}
+ */
+export const BOOL_ANY = (...values) =>
+{
+	for(let value of values)
+	{
+		if(!ISSET(value))
+		{
+			continue;
+		}
+		if(typeof value === 'boolean')
+		{
+			return value;
+		}
+		if(typeof value === 'number')
+		{
+			if(!isNaN(value))
+			{
+				return (value !== 0);
+			}
+			return false;
+		}
+		if(typeof value === 'string')
+		{
+			value = value.toLowerCase().trim();
+			if((value === '') || (value === 'false') || (value === 'no') || (value === 'off') || (value === '0'))
+			{
+				return false;
+			}
+			if((value === 'true') || (value === 'yes') || (value === 'on') || (value === '1'))
+			{
+				return true;
+			}
+			const float = +value;
+			if(!isNaN(float))
+			{
+				return (float !== 0);
+			}
+			// unrecognized string, let's try the next value, else we return false (after the loop)
+		}
+		if(IS_ARRAY(value) || IS_OBJECT(value))
+		{
+			return !!value;
+		}
+		// unrecognized type, let's try the next value, else we return false (after the loop)
+	}
+	return false;
+};
+
+
 /**
  * Ensures the given value is an integer (attempts to cast it to an integer if it's not, null and undefined will return 0).
  *

package/src/index.js

@@ -1,5 +1,5 @@
 export {LeUtils} from './LeUtils.js';
-export {ISSET, IS_ARRAY, ARRAY, IS_OBJECT, OBJECT, STRING, STRING_ANY, INT, INT_ANY, FLOAT, FLOAT_ANY, INT_LAX, INT_LAX_ANY, FLOAT_LAX, FLOAT_LAX_ANY} from './LeTypes.js';
+export {ISSET, IS_ARRAY, ARRAY, IS_OBJECT, OBJECT, STRING, STRING_ANY, BOOL, BOOL_ANY, INT, INT_ANY, FLOAT, FLOAT_ANY, INT_LAX, INT_LAX_ANY, FLOAT_LAX, FLOAT_LAX_ANY} from './LeTypes.js';
 export {EventEmitter} from './classes/EventEmitter.js';
 export {LinkedList} from './classes/LinkedList.js';
 export {SerializableMap} from './classes/SerializableMap.js';