@lowentry/utils 1.11.5 → 1.12.2

package/index.js

@@ -542,10 +542,64 @@ var LeUtils = {
     });
     return result;
   },
+  /**
+   * @callback LeUtils~__findIndexValueCallback
+   * @param {*} value
+   * @param {*} index
+   * @returns {boolean|undefined}
+   */
+  /**
+   * Finds the first element in the given array or object that returns true from the callback, and returns an object with the index and value.
+   *
+   * @param {*[]|object|Function} elements
+   * @param {LeUtils~__findIndexValueCallback} callback
+   * @param {boolean} [optionalSkipHasOwnPropertyCheck]
+   * @returns {{index:*, value:*}|null}
+   */
+  findIndexValue: function findIndexValue(elements, callback) {
+    var result = null;
+    LeUtils.each(elements, function (value, index) {
+      if (callback.call(elements[index], elements[index], index)) {
+        result = {
+          index: index,
+          value: value
+        };
+        return false;
+      }
+    });
+    return result;
+  },
+  /**
+   * Finds the first element in the given array or object that returns true from the callback, and returns the index.
+   *
+   * @param {*[]|object|Function} elements
+   * @param {LeUtils~__findIndexValueCallback} callback
+   * @param {boolean} [optionalSkipHasOwnPropertyCheck]
+   * @returns {*|null}
+   */
+  findIndex: function findIndex(elements, callback) {
+    var _LeUtils$findIndexVal, _LeUtils$findIndexVal2;
+    var optionalSkipHasOwnPropertyCheck = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : false;
+    return (_LeUtils$findIndexVal = (_LeUtils$findIndexVal2 = LeUtils.findIndexValue(elements, callback, optionalSkipHasOwnPropertyCheck)) === null || _LeUtils$findIndexVal2 === void 0 ? void 0 : _LeUtils$findIndexVal2.index) !== null && _LeUtils$findIndexVal !== void 0 ? _LeUtils$findIndexVal : null;
+  },
+  /**
+   * Finds the first element in the given array or object that returns true from the callback, and returns the value.
+   *
+   * @param {*[]|object|Function} elements
+   * @param {LeUtils~__findIndexValueCallback} callback
+   * @param {boolean} [optionalSkipHasOwnPropertyCheck]
+   * @returns {*|null}
+   */
+  find: function find(elements, callback) {
+    var _LeUtils$findIndexVal3, _LeUtils$findIndexVal4;
+    var optionalSkipHasOwnPropertyCheck = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : false;
+    return (_LeUtils$findIndexVal3 = (_LeUtils$findIndexVal4 = LeUtils.findIndexValue(elements, callback, optionalSkipHasOwnPropertyCheck)) === null || _LeUtils$findIndexVal4 === void 0 ? void 0 : _LeUtils$findIndexVal4.value) !== null && _LeUtils$findIndexVal3 !== void 0 ? _LeUtils$findIndexVal3 : null;
+  },
   /**
    * @callback LeUtils~__eachCallback
    * @param {*} value
    * @param {*} index
+   * @returns {boolean|undefined}
    */
   /**
    * Loops through each element in the given array or object, and calls the callback for each element.
@@ -792,9 +846,10 @@ var LeUtils = {
    * @callback LeUtils~__filterCallback
    * @param {*} value
    * @param {*} index
+   * @returns {boolean|undefined}
    */
   /**
-   * Loops through the given elements, and returns a new array or object, with only the elements that didn't return false from the callback.
+   * Loops through the given elements, and returns a new array or object, with only the elements that returned true (or a value equals to true) from the callback.
    *
    * @param {*[]|object|Function} elements
    * @param {LeUtils~__filterCallback} callback
@@ -807,7 +862,7 @@ var LeUtils = {
       if (Array.isArray(elements)) {
         var result = [];
         for (var index = 0; index < elements.length; index++) {
-          if (callback.call(elements[index], elements[index], index) !== false) {
+          if (!callback.call(elements[index], elements[index], index)) {
             result.push(elements[index]);
           }
         }
@@ -816,7 +871,7 @@ var LeUtils = {
         var _result = {};
         for (var _index3 in elements) {
           if (optionalSkipHasOwnPropertyCheck === true || Object.prototype.hasOwnProperty.call(elements, _index3)) {
-            if (callback.call(elements[_index3], elements[_index3], _index3) !== false) {
+            if (!callback.call(elements[_index3], elements[_index3], _index3)) {
               _result[_index3] = elements[_index3];
             }
           }
@@ -832,6 +887,7 @@ var LeUtils = {
    * @callback LeUtils~__mapCallback
    * @param {*} value
    * @param {*} index
+   * @returns {*}
    */
   /**
    * Loops through the given elements, and returns a new array or object, with the elements that were returned from the callback.
@@ -868,6 +924,7 @@ var LeUtils = {
    * @callback LeUtils~__mapToArrayCallback
    * @param {*} value
    * @param {*} index
+   * @returns {*}
    */
   /**
    * Loops through the given elements, and returns a new array, with the elements that were returned from the callback. Always returns an array.
@@ -901,6 +958,7 @@ var LeUtils = {
    * @callback LeUtils~__mapToArraySortedCallback
    * @param {*} value
    * @param {*} index
+   * @returns {*}
    */
   /**
    * Loops through the given elements, and returns a new array, with the elements that were returned from the callback. The elements will be sorted by the result from the given comparator. Always returns an array.
@@ -924,6 +982,7 @@ var LeUtils = {
    * @callback LeUtils~__sortKeysComparatorCallback
    * @param {*} elementA
    * @param {*} elementB
+   * @returns {number}
    */
   /**
    * Loops through the given elements, and returns a new array, with the keys from the given elements, sorted by the result from the given comparator. Always returns an array.