lodash/array/dropWhile.js

var baseCallback = require('../internal/baseCallback'),
    baseSlice = require('../internal/baseSlice');

/**
 * Creates a slice of `array` excluding elements dropped from the beginning.
 * Elements are dropped until `predicate` returns falsey. The predicate is
 * bound to `thisArg` and invoked with three arguments; (value, index, array).
 *
 * If a property name is provided for `predicate` the created `_.property`
 * style callback returns the property value of the given element.
 *
 * If a value is also provided for `thisArg` the created `_.matchesProperty`
 * style callback returns `true` for elements that have a matching property
 * value, else `false`.
 *
 * If an object is provided for `predicate` the created `_.matches` style
 * callback returns `true` for elements that have the properties of the given
 * object, else `false`.
 *
 * @static
 * @memberOf _
 * @category Array
 * @param {Array} array The array to query.
 * @param {Function|Object|string} [predicate=_.identity] The function invoked
 *  per iteration.
 * @param {*} [thisArg] The `this` binding of `predicate`.
 * @returns {Array} Returns the slice of `array`.
 * @example
 *
 * _.dropWhile([1, 2, 3], function(n) {
 *   return n < 3;
 * });
 * // => [3]
 *
 * var users = [
 *   { 'user': 'barney',  'active': false },
 *   { 'user': 'fred',    'active': false },
 *   { 'user': 'pebbles', 'active': true }
 * ];
 *
 * // using the `_.matches` callback shorthand
 * _.pluck(_.dropWhile(users, { 'user': 'barney', 'active': false }), 'user');
 * // => ['fred', 'pebbles']
 *
 * // using the `_.matchesProperty` callback shorthand
 * _.pluck(_.dropWhile(users, 'active', false), 'user');
 * // => ['pebbles']
 *
 * // using the `_.property` callback shorthand
 * _.pluck(_.dropWhile(users, 'active'), 'user');
 * // => ['barney', 'fred', 'pebbles']
 */
function dropWhile(array, predicate, thisArg) {
  var length = array ? array.length : 0;
  if (!length) {
    return [];
  }
  var index = -1;
  predicate = baseCallback(predicate, thisArg, 3);
  while (++index < length && predicate(array[index], index, array)) {}
  return baseSlice(array, index);
}

module.exports = dropWhile;