@lowentry/utils 1.24.2 → 1.25.1

package/index.d.ts

@@ -1,5 +1,9 @@
 export declare function ARRAY(value: any): any[];
 
+export declare function BOOL(value: any): boolean;
+
+export declare function BOOL_ANY(...values: any): boolean;
+
 /**
  * A simple event emitter class that allows you to register listeners for events, emit events, and remove listeners.
  */

package/index.js

@@ -95,6 +95,64 @@ var STRING_ANY = function STRING_ANY() {
   return '';
 };
 
+/**
+ * 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}
+ */
+var BOOL = function BOOL(value) {
+  return BOOL_ANY(value);
+};
+
+/**
+ * Returns the first non-null non-undefined boolean-castable value as a boolean.
+ *
+ * @param {*} values
+ * @returns {boolean}
+ */
+var BOOL_ANY = function BOOL_ANY() {
+  for (var _len2 = arguments.length, values = new Array(_len2), _key2 = 0; _key2 < _len2; _key2++) {
+    values[_key2] = arguments[_key2];
+  }
+  for (var _i2 = 0, _values2 = values; _i2 < _values2.length; _i2++) {
+    var value = _values2[_i2];
+    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;
+      }
+      var _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).
  *
@@ -136,11 +194,11 @@ var FLOAT = function FLOAT(value) {
  * @returns {number}
  */
 var FLOAT_ANY = function FLOAT_ANY() {
-  for (var _len2 = arguments.length, values = new Array(_len2), _key2 = 0; _key2 < _len2; _key2++) {
-    values[_key2] = arguments[_key2];
+  for (var _len3 = arguments.length, values = new Array(_len3), _key3 = 0; _key3 < _len3; _key3++) {
+    values[_key3] = arguments[_key3];
   }
-  for (var _i2 = 0, _values2 = values; _i2 < _values2.length; _i2++) {
-    var value = _values2[_i2];
+  for (var _i3 = 0, _values3 = values; _i3 < _values3.length; _i3++) {
+    var value = _values3[_i3];
     if (value !== null) {
       var v = +value;
       if (!isNaN(v)) {
@@ -196,11 +254,11 @@ var FLOAT_LAX = function FLOAT_LAX(value) {
  * @returns {number}
  */
 var FLOAT_LAX_ANY = function FLOAT_LAX_ANY() {
-  for (var _len3 = arguments.length, values = new Array(_len3), _key3 = 0; _key3 < _len3; _key3++) {
-    values[_key3] = arguments[_key3];
+  for (var _len4 = arguments.length, values = new Array(_len4), _key4 = 0; _key4 < _len4; _key4++) {
+    values[_key4] = arguments[_key4];
   }
-  for (var _i3 = 0, _values3 = values; _i3 < _values3.length; _i3++) {
-    var value = _values3[_i3];
+  for (var _i4 = 0, _values4 = values; _i4 < _values4.length; _i4++) {
+    var value = _values4[_i4];
     if (value !== null) {
       var v = typeof value === 'number' ? value : parseFloat((value + '').replace(REGEX_ALL_NON_FLOAT_CHARACTERS, ''));
       if (!isNaN(v)) {
@@ -4098,5 +4156,5 @@ var TreeSet = /*#__PURE__*/function () {
   }]);
 }();
 
-export { ARRAY, EventEmitter, FLOAT, FLOAT_ANY, FLOAT_LAX, FLOAT_LAX_ANY, INT, INT_ANY, INT_LAX, INT_LAX_ANY, ISSET, IS_ARRAY, IS_OBJECT, LeUtils, LinkedList, OBJECT, STRING, STRING_ANY, SerializableMap, TreeSet };
+export { ARRAY, BOOL, BOOL_ANY, EventEmitter, FLOAT, FLOAT_ANY, FLOAT_LAX, FLOAT_LAX_ANY, INT, INT_ANY, INT_LAX, INT_LAX_ANY, ISSET, IS_ARRAY, IS_OBJECT, LeUtils, LinkedList, OBJECT, STRING, STRING_ANY, SerializableMap, TreeSet };
 //# sourceMappingURL=index.js.map