object-loops/some.js

Functional methods like forEach, map, filter, and other Array methods for Objects in javascript

/**
 * @module object-loops/some
 */

/**
 * Tests whether some value in the object passes the test implemented by the callback.
 * @function module:object-loops/some
 * @param {object} [obj] - object to iterate through, not accepted if being used directly on Object.prototype
 * @param {someCallback} callback - function to test each value in the object. return truthy to end the loop, falsey otherwise.
 * @param {*} [thisArg] - optional. context to bind to callback
 * @returns {boolean} if callback returns true, the loop is ended and true is returned (else false)
 */
module.exports = some

function some (obj, callback, thisArg) {
  if (Array.isArray(obj)) {
    return obj.some(callback, thisArg)
  }
  if (typeof obj !== 'object' && typeof obj !== 'function') {
    throw new TypeError(obj + ' must be an object')
  }
  if (typeof callback !== 'function') {
    throw new TypeError(callback + ' must be a function')
  }
  var ret = false
  var keys = Object.keys(obj)

  for (var i = 0; i < keys.length; i++) {
    var key = keys[i]
    var val = obj[key]
    var pass = callback.call(thisArg, val, key, obj)

    if (pass) {
      return true
    }
  }

  return ret
}
/**
 * This callback type is called `someCallback` and is displayed as a global symbol.
 * @callback someCallback
 * @param {*} val - value for key
 * @param {string} key - object key (used in current iteration)
 * @param {object} obj - object which values are being iterated
 * @returns {boolean} include -  return true to break loop and return true, false otherwise
 */