Mirrors/lodash
1
0
Fork 0
mirror of https://github.com/whoisclebs/lodash.git synced 2026-02-01 15:57:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

Lots of doc tweak removing heavy will use. [ci skip]

Browse Source
This commit is contained in:
John-David Dalton
2014-05-24 18:33:05 -07:00
parent 1ce0fffd25
commit cb81fccfaf
1 changed files with 210 additions and 210 deletions
Download Patch File Download Diff File Expand all files Collapse all files

420
lodash.js
View File

@@ -2131,7 +2131,7 @@
/**
* Compiles a function from `source` using the `varNames` and `varValues`
* pairs to import free variables into the compiled function. If `sourceURL`
* is provided it will be used as the sourceURL for the compiled function.
* is provided it is used as the sourceURL for the compiled function.
*
* @private
* @param {string} source The source to compile.
@@ -2220,7 +2220,7 @@
* Creates a function that aggregates a collection, creating an accumulator
* object composed from the results of running each element in the collection
* through a callback. The given setter function sets the keys and values of
* the accumulator object. If `initializer` is provided it will be used to
* the accumulator object. If `initializer` is provided it is used to
* initialize the accumulator object.
*
* @private
@@ -2670,14 +2670,14 @@
/**
* Creates a slice of `array` excluding elements dropped from the end.
* Elements will be dropped until the predicate returns falsey. The predicate
* is bound to `thisArg` and invoked with three arguments; (value, index, array).
* Elements are dropped until the 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 "_.pluck" style
* callback will return the property value of the given element.
* callback returns the property value of the given element.
*
* If an object is provided for `predicate` the created "_.where" style callback
* will return `true` for elements that have the properties of the given object,
* returns `true` for elements that have the properties of the given object,
* else `false`.
*
* @static
@@ -2713,14 +2713,14 @@
/**
* Creates a slice of `array` excluding elements dropped from the beginning.
* Elements will be dropped until the predicate returns falsey. The predicate
* is bound to `thisArg` and invoked with three arguments; (value, index, array).
* Elements are dropped until the 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 "_.pluck" style
* callback will return the property value of the given element.
* callback returns the property value of the given element.
*
* If an object is provided for `predicate` the created "_.where" style callback
* will return `true` for elements that have the properties of the given object,
* returns `true` for elements that have the properties of the given object,
* else `false`.
*
* @static
@@ -2759,10 +2759,10 @@
* element the predicate returns truthy for, instead of the element itself.
*
* If a property name is provided for `predicate` the created "_.pluck" style
* callback will return the property value of the given element.
* callback returns the property value of the given element.
*
* If an object is provided for `predicate` the created "_.where" style callback
* will return `true` for elements that have the properties of the given object,
* returns `true` for elements that have the properties of the given object,
* else `false`.
*
* @static
@@ -2770,8 +2770,8 @@
* @category Arrays
* @param {Array} array The array to search.
* @param {Function|Object|string} [predicate=identity] The function called
* per iteration. If a property name or object is provided it will be used
* to create a "_.pluck" or "_.where" style callback respectively.
* per iteration. If a property name or object is provided it is used to
* create a "_.pluck" or "_.where" style callback respectively.
* @param {*} [thisArg] The `this` binding of `predicate`.
* @returns {number} Returns the index of the found element, else `-1`.
* @example
@@ -2813,10 +2813,10 @@
* of a collection from right to left.
*
* If a property name is provided for `predicate` the created "_.pluck" style
* callback will return the property value of the given element.
* callback returns the property value of the given element.
*
* If an object is provided for `predicate` the created "_.where" style callback
* will return `true` for elements that have the properties of the given object,
* returns `true` for elements that have the properties of the given object,
* else `false`.
*
* @static
@@ -2824,8 +2824,8 @@
* @category Arrays
* @param {Array} array The array to search.
* @param {Function|Object|string} [predicate=identity] The function called
* per iteration. If a property name or object is provided it will be used
* to create a "_.pluck" or "_.where" style callback respectively.
* per iteration. If a property name or object is provided it is used to
* create a "_.pluck" or "_.where" style callback respectively.
* @param {*} [thisArg] The `this` binding of `predicate`.
* @returns {number} Returns the index of the found element, else `-1`.
* @example
@@ -2902,16 +2902,16 @@
/**
* Flattens a nested array (the nesting can be to any depth). If `isShallow`
* is truthy, the array will only be flattened a single level. If a callback
* is provided each element of the array is passed through the callback before
* is truthy, the array is only flattened a single level. If a callback is
* provided each element of the array is passed through the callback before
* flattening. The callback is bound to `thisArg` and invoked with three
* arguments; (value, index, array).
*
* If a property name is provided for `callback` the created "_.pluck" style
* callback will return the property value of the given element.
* callback returns the property value of the given element.
*
* If an object is provided for `callback` the created "_.where" style callback
* will return `true` for elements that have the properties of the given object,
* returns `true` for elements that have the properties of the given object,
* else `false`.
*
* @static
@@ -2920,7 +2920,7 @@
* @param {Array} array The array to flatten.
* @param {boolean} [isShallow=false] A flag to restrict flattening to a single level.
* @param {Function|Object|string} [callback] The function called per iteration.
* If a property name or object is provided it will be used to create a "_.pluck"
* If a property name or object is provided it is used to create a "_.pluck"
* or "_.where" style callback respectively.
* @param {*} [thisArg] The `this` binding of `callback`.
* @returns {Array} Returns the new flattened array.
@@ -2968,7 +2968,7 @@
/**
* Gets the index at which the first occurrence of `value` is found using
* strict equality for comparisons, i.e. `===`. If the array is already sorted
* providing `true` for `fromIndex` will run a faster binary search.
* providing `true` for `fromIndex` performs a faster binary search.
*
* @static
* @memberOf _
@@ -3237,10 +3237,10 @@
* and invoked with three arguments; (value, index, array).
*
* If a property name is provided for `predicate` the created "_.pluck" style
* callback will return the property value of the given element.
* callback returns the property value of the given element.
*
* If an object is provided for `predicate` the created "_.where" style callback
* will return `true` for elements that have the properties of the given object,
* returns `true` for elements that have the properties of the given object,
* else `false`.
*
* Note: Unlike `_.filter`, this method mutates `array`.
@@ -3250,8 +3250,8 @@
* @category Arrays
* @param {Array} array The array to modify.
* @param {Function|Object|string} [predicate=identity] The function called
* per iteration. If a property name or object is provided it will be used
* to create a "_.pluck" or "_.where" style callback respectively.
* per iteration. If a property name or object is provided it is used to
* create a "_.pluck" or "_.where" style callback respectively.
* @param {*} [thisArg] The `this` binding of `predicate`.
* @returns {Array} Returns the new array of removed elements.
* @example
@@ -3359,15 +3359,15 @@
/**
* Uses a binary search to determine the smallest index at which a value
* should be inserted into a given sorted array in order to maintain the sort
* order of the array. If a callback is provided it will be executed for
* `value` and each element of `array` to compute their sort ranking. The
* callback is bound to `thisArg` and invoked with one argument; (value).
* order of the array. If a callback is provided it is executed for `value`
* and each element of `array` to compute their sort ranking. The callback
* is bound to `thisArg` and invoked with one argument; (value).
*
* If a property name is provided for `callback` the created "_.pluck" style
* callback will return the property value of the given element.
* callback returns the property value of the given element.
*
* If an object is provided for `callback` the created "_.where" style callback
* will return `true` for elements that have the properties of the given object,
* returns `true` for elements that have the properties of the given object,
* else `false`.
*
* @static
@@ -3376,8 +3376,8 @@
* @param {Array} array The array to inspect.
* @param {*} value The value to evaluate.
* @param {Function|Object|string} [callback=identity] The function called
* per iteration. If a property name or object is provided it will be used
* to create a "_.pluck" or "_.where" style callback respectively.
* per iteration. If a property name or object is provided it is used to
* create a "_.pluck" or "_.where" style callback respectively.
* @param {*} [thisArg] The `this` binding of `callback`.
* @returns {number} Returns the index at which `value` should be inserted
* into `array`.
@@ -3476,15 +3476,15 @@
var takeRight = last;
/**
* Creates a slice of `array` with elements taken from the end. Elements will
* be taken until the predicate returns falsey. The predicate is bound to
* `thisArg` and invoked with three arguments; (value, index, array).
* Creates a slice of `array` with elements taken from the end. Elements are
* taken until the 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 "_.pluck" style
* callback will return the property value of the given element.
* callback returns the property value of the given element.
*
* If an object is provided for `predicate` the created "_.where" style callback
* will return `true` for elements that have the properties of the given object,
* returns `true` for elements that have the properties of the given object,
* else `false`.
*
* @static
@@ -3520,14 +3520,14 @@
/**
* Creates a slice of `array` with elements taken from the beginning. Elements
* will be taken until the predicate returns falsey. The predicate is bound
* to `thisArg` and invoked with three arguments; (value, index, array).
* are taken until the 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 "_.pluck" style
* callback will return the property value of the given element.
* callback returns the property value of the given element.
*
* If an object is provided for `predicate` the created "_.where" style callback
* will return `true` for elements that have the properties of the given object,
* returns `true` for elements that have the properties of the given object,
* else `false`.
*
* @static
@@ -3581,17 +3581,17 @@
/**
* Creates a duplicate-value-free version of an array using strict equality
* for comparisons, i.e. `===`. If the array is sorted, providing `true` for
* `isSorted` will use a faster algorithm. If a callback is provided it will
* be executed for each value in the array to generate the criterion by which
* uniqueness is computed. The callback is bound to `thisArg` and invoked with
* three arguments; (value, index, array).
* for comparisons, i.e. `===`. Providing `true` for `isSorted` performs a
* faster search algorithm for sorted arrays. If a callback is provided it
* is executed for each value in the array to generate the criterion by which
* uniqueness is computed. The callback is bound to `thisArg` and invoked
* with three arguments; (value, index, array).
*
* If a property name is provided for `callback` the created "_.pluck" style
* callback will return the property value of the given element.
* callback returns the property value of the given element.
*
* If an object is provided for `callback` the created "_.where" style callback
* will return `true` for elements that have the properties of the given object,
* returns `true` for elements that have the properties of the given object,
* else `false`.
*
* @static
@@ -3601,7 +3601,7 @@
* @param {Array} array The array to process.
* @param {boolean} [isSorted=false] A flag to indicate that `array` is sorted.
* @param {Function|Object|string} [callback] The function called per iteration.
* If a property name or object is provided it will be used to create a "_.pluck"
* If a property name or object is provided it is used to create a "_.pluck"
* or "_.where" style callback respectively.
* @param {*} [thisArg] The `this` binding of `callback`.
* @returns {Array} Returns the new duplicate-value-free array.
@@ -3705,7 +3705,7 @@
* Creates an array of grouped elements, the first of which contains the first
* elements of the given arrays, the second of which contains the second elements
* of the given arrays, and so on. If a zipped value is provided its corresponding
* unzipped value will be returned.
* unzipped value is returned.
*
* @static
* @memberOf _
@@ -3975,10 +3975,10 @@
* (value, index|key, collection).
*
* If a property name is provided for `callback` the created "_.pluck" style
* callback will return the property value of the given element.
* callback returns the property value of the given element.
*
* If an object is provided for `callback` the created "_.where" style callback
* will return `true` for elements that have the properties of the given object,
* returns `true` for elements that have the properties of the given object,
* else `false`.
*
* @static
@@ -3986,8 +3986,8 @@
* @category Collections
* @param {Array|Object|string} collection The collection to iterate over.
* @param {Function|Object|string} [callback=identity] The function called
* per iteration. If a property name or object is provided it will be used
* to create a "_.pluck" or "_.where" style callback respectively.
* per iteration. If a property name or object is provided it is used to
* create a "_.pluck" or "_.where" style callback respectively.
* @param {*} [thisArg] The `this` binding of `callback`.
* @returns {Object} Returns the composed aggregate object.
* @example
@@ -4011,10 +4011,10 @@
* (value, index|key, collection).
*
* If a property name is provided for `predicate` the created "_.pluck" style
* callback will return the property value of the given element.
* callback returns the property value of the given element.
*
* If an object is provided for `predicate` the created "_.where" style callback
* will return `true` for elements that have the properties of the given object,
* returns `true` for elements that have the properties of the given object,
* else `false`.
*
* @static
@@ -4023,8 +4023,8 @@
* @category Collections
* @param {Array|Object|string} collection The collection to iterate over.
* @param {Function|Object|string} [predicate=identity] The function called
* per iteration. If a property name or object is provided it will be used
* to create a "_.pluck" or "_.where" style callback respectively.
* per iteration. If a property name or object is provided it is used to
* create a "_.pluck" or "_.where" style callback respectively.
* @param {*} [thisArg] The `this` binding of `predicate`.
* @returns {boolean} Returns `true` if all elements passed the predicate check,
* else `false`.
@@ -4076,10 +4076,10 @@
* invoked with three arguments; (value, index|key, collection).
*
* If a property name is provided for `predicate` the created "_.pluck" style
* callback will return the property value of the given element.
* callback returns the property value of the given element.
*
* If an object is provided for `predicate` the created "_.where" style callback
* will return `true` for elements that have the properties of the given object,
* returns `true` for elements that have the properties of the given object,
* else `false`.
*
* @static
@@ -4088,8 +4088,8 @@
* @category Collections
* @param {Array|Object|string} collection The collection to iterate over.
* @param {Function|Object|string} [predicate=identity] The function called
* per iteration. If a property name or object is provided it will be used
* to create a "_.pluck" or "_.where" style callback respectively.
* per iteration. If a property name or object is provided it is used to
* create a "_.pluck" or "_.where" style callback respectively.
* @param {*} [thisArg] The `this` binding of `predicate`.
* @returns {Array} Returns the new filtered array.
* @example
@@ -4140,10 +4140,10 @@
* invoked with three arguments; (value, index|key, collection).
*
* If a property name is provided for `predicate` the created "_.pluck" style
* callback will return the property value of the given element.
* callback returns the property value of the given element.
*
* If an object is provided for `predicate` the created "_.where" style callback
* will return `true` for elements that have the properties of the given object,
* returns `true` for elements that have the properties of the given object,
* else `false`.
*
* @static
@@ -4152,8 +4152,8 @@
* @category Collections
* @param {Array|Object|string} collection The collection to search.
* @param {Function|Object|string} [predicate=identity] The function called
* per iteration. If a property name or object is provided it will be used
* to create a "_.pluck" or "_.where" style callback respectively.
* per iteration. If a property name or object is provided it is used to
* create a "_.pluck" or "_.where" style callback respectively.
* @param {*} [thisArg] The `this` binding of `predicate`.
* @returns {*} Returns the matched element, else `undefined`.
* @example
@@ -4195,8 +4195,8 @@
* @category Collections
* @param {Array|Object|string} collection The collection to search.
* @param {Function|Object|string} [predicate=identity] The function called
* per iteration. If a property name or object is provided it will be used
* to create a "_.pluck" or "_.where" style callback respectively.
* per iteration. If a property name or object is provided it is used to
* create a "_.pluck" or "_.where" style callback respectively.
* @param {*} [thisArg] The `this` binding of `predicate`.
* @returns {*} Returns the matched element, else `undefined`.
* @example
@@ -4302,10 +4302,10 @@
* (value, index|key, collection).
*
* If a property name is provided for `callback` the created "_.pluck" style
* callback will return the property value of the given element.
* callback returns the property value of the given element.
*
* If an object is provided for `callback` the created "_.where" style callback
* will return `true` for elements that have the properties of the given object,
* returns `true` for elements that have the properties of the given object,
* else `false`.
*
* @static
@@ -4313,8 +4313,8 @@
* @category Collections
* @param {Array|Object|string} collection The collection to iterate over.
* @param {Function|Object|string} [callback=identity] The function called
* per iteration. If a property name or object is provided it will be used
* to create a "_.pluck" or "_.where" style callback respectively.
* per iteration. If a property name or object is provided it is used to
* create a "_.pluck" or "_.where" style callback respectively.
* @param {*} [thisArg] The `this` binding of `callback`.
* @returns {Object} Returns the composed aggregate object.
* @example
@@ -4345,10 +4345,10 @@
* (value, index|key, collection).
*
* If a property name is provided for `callback` the created "_.pluck" style
* callback will return the property value of the given element.
* callback returns the property value of the given element.
*
* If an object is provided for `callback` the created "_.where" style callback
* will return `true` for elements that have the properties of the given object,
* returns `true` for elements that have the properties of the given object,
* else `false`.
*
* @static
@@ -4356,8 +4356,8 @@
* @category Collections
* @param {Array|Object|string} collection The collection to iterate over.
* @param {Function|Object|string} [callback=identity] The function called
* per iteration. If a property name or object is provided it will be used
* to create a "_.pluck" or "_.where" style callback respectively.
* per iteration. If a property name or object is provided it is used to
* create a "_.pluck" or "_.where" style callback respectively.
* @param {*} [thisArg] The `this` binding of `callback`.
* @returns {Object} Returns the composed aggregate object.
* @example
@@ -4383,8 +4383,8 @@
/**
* Invokes the method named by `methodName` on each element in the collection
* returning an array of the results of each invoked method. Additional arguments
* will be provided to each invoked method. If `methodName` is a function it
* will be invoked for, and `this` bound to, each element in the collection.
* is provided to each invoked method. If `methodName` is a function it is
* invoked for, and `this` bound to, each element in the collection.
*
* @static
* @memberOf _
@@ -4412,10 +4412,10 @@
* three arguments; (value, index|key, collection).
*
* If a property name is provided for `callback` the created "_.pluck" style
* callback will return the property value of the given element.
* callback returns the property value of the given element.
*
* If an object is provided for `callback` the created "_.where" style callback
* will return `true` for elements that have the properties of the given object,
* returns `true` for elements that have the properties of the given object,
* else `false`.
*
* @static
@@ -4424,8 +4424,8 @@
* @category Collections
* @param {Array|Object|string} collection The collection to iterate over.
* @param {Function|Object|string} [callback=identity] The function called
* per iteration. If a property name or object is provided it will be used
* to create a "_.pluck" or "_.where" style callback respectively.
* per iteration. If a property name or object is provided it is used to
* create a "_.pluck" or "_.where" style callback respectively.
* @param {*} [thisArg] The `this` binding of `callback`.
* @returns {Array} Returns the new mapped array.
* @example
@@ -4461,17 +4461,17 @@
}
/**
* Retrieves the maximum value of a collection. If the collection is empty or
* falsey `-Infinity` is returned. If a callback is provided it will be executed
* for each value in the collection to generate the criterion by which the value
* is ranked. The callback is bound to `thisArg` and invoked with three
* Retrieves the maximum value of a collection. If the collection is empty
* or falsey `-Infinity` is returned. If a callback is provided it is executed
* for each value in the collection to generate the criterion by which the
* value is ranked. The callback is bound to `thisArg` and invoked with three
* arguments; (value, index, collection).
*
* If a property name is provided for `callback` the created "_.pluck" style
* callback will return the property value of the given element.
* callback returns the property value of the given element.
*
* If an object is provided for `callback` the created "_.where" style callback
* will return `true` for elements that have the properties of the given object,
* returns `true` for elements that have the properties of the given object,
* else `false`.
*
* @static
@@ -4479,7 +4479,7 @@
* @category Collections
* @param {Array|Object|string} collection The collection to iterate over.
* @param {Function|Object|string} [callback] The function called per iteration.
* If a property name or object is provided it will be used to create a "_.pluck"
* If a property name or object is provided it is used to create a "_.pluck"
* or "_.where" style callback respectively.
* @param {*} [thisArg] The `this` binding of `callback`.
* @returns {*} Returns the maximum value.
@@ -4539,17 +4539,17 @@
}
/**
* Retrieves the minimum value of a collection. If the collection is empty or
* falsey `Infinity` is returned. If a callback is provided it will be executed
* for each value in the collection to generate the criterion by which the value
* is ranked. The callback is bound to `thisArg` and invoked with three
* Retrieves the minimum value of a collection. If the collection is empty
* or falsey `Infinity` is returned. If a callback is provided it is executed
* for each value in the collection to generate the criterion by which the
* value is ranked. The callback is bound to `thisArg` and invoked with three
* arguments; (value, index, collection).
*
* If a property name is provided for `callback` the created "_.pluck" style
* callback will return the property value of the given element.
* callback returns the property value of the given element.
*
* If an object is provided for `callback` the created "_.where" style callback
* will return `true` for elements that have the properties of the given object,
* returns `true` for elements that have the properties of the given object,
* else `false`.
*
* @static
@@ -4557,7 +4557,7 @@
* @category Collections
* @param {Array|Object|string} collection The collection to iterate over.
* @param {Function|Object|string} [callback] The function called per iteration.
* If a property name or object is provided it will be used to create a "_.pluck"
* If a property name or object is provided it is used to create a "_.pluck"
* or "_.where" style callback respectively.
* @param {*} [thisArg] The `this` binding of `callback`.
* @returns {*} Returns the minimum value.
@@ -4623,10 +4623,10 @@
* to `thisArg` and invoked with three arguments; (value, index|key, collection).
*
* If a property name is provided for `predicate` the created "_.pluck" style
* callback will return the property value of the given element.
* callback returns the property value of the given element.
*
* If an object is provided for `predicate` the created "_.where" style callback
* will return `true` for elements that have the properties of the given object,
* returns `true` for elements that have the properties of the given object,
* else `false`.
*
* @static
@@ -4634,8 +4634,8 @@
* @category Collections
* @param {Array|Object|string} collection The collection to iterate over.
* @param {Function|Object|string} [predicate=identity] The function called
* per iteration. If a property name or object is provided it will be used
* to create a "_.pluck" or "_.where" style callback respectively.
* per iteration. If a property name or object is provided it is used to
* create a "_.pluck" or "_.where" style callback respectively.
* @param {*} [thisArg] The `this` binding of `predicate`.
* @returns {Array} Returns the array of grouped elements.
* @example
@@ -4691,9 +4691,9 @@
* Reduces a collection to a value which is the accumulated result of running
* each element in the collection through the callback, where each successive
* callback execution consumes the return value of the previous execution. If
* `accumulator` is not provided the first element of the collection will be
* used as the initial `accumulator` value. The callback is bound to `thisArg`
* and invoked with four arguments; (accumulator, value, index|key, collection).
* `accumulator` is not provided the first element of the collection is used
* as the initial `accumulator` value. The callback is bound to `thisArg` and
* invoked with four arguments; (accumulator, value, index|key, collection).
*
* @static
* @memberOf _
@@ -4777,10 +4777,10 @@
* the predicate does **not** return truthy for.
*
* If a property name is provided for `predicate` the created "_.pluck" style
* callback will return the property value of the given element.
* callback returns the property value of the given element.
*
* If an object is provided for `predicate` the created "_.where" style callback
* will return `true` for elements that have the properties of the given object,
* returns `true` for elements that have the properties of the given object,
* else `false`.
*
* @static
@@ -4788,8 +4788,8 @@
* @category Collections
* @param {Array|Object|string} collection The collection to iterate over.
* @param {Function|Object|string} [predicate=identity] The function called
* per iteration. If a property name or object is provided it will be used
* to create a "_.pluck" or "_.where" style callback respectively.
* per iteration. If a property name or object is provided it is used to
* create a "_.pluck" or "_.where" style callback respectively.
* @param {*} [thisArg] The `this` binding of `predicate`.
* @returns {Array} Returns the new filtered array.
* @example
@@ -4910,10 +4910,10 @@
* with three arguments; (value, index|key, collection).
*
* If a property name is provided for `predicate` the created "_.pluck" style
* callback will return the property value of the given element.
* callback returns the property value of the given element.
*
* If an object is provided for `predicate` the created "_.where" style callback
* will return `true` for elements that have the properties of the given object,
* returns `true` for elements that have the properties of the given object,
* else `false`.
*
* @static
@@ -4922,8 +4922,8 @@
* @category Collections
* @param {Array|Object|string} collection The collection to iterate over.
* @param {Function|Object|string} [predicate=identity] The function called
* per iteration. If a property name or object is provided it will be used
* to create a "_.pluck" or "_.where" style callback respectively.
* per iteration. If a property name or object is provided it is used to
* create a "_.pluck" or "_.where" style callback respectively.
* @param {*} [thisArg] The `this` binding of `predicate`.
* @returns {boolean} Returns `true` if any element passed the predicate check,
* else `false`.
@@ -4972,18 +4972,18 @@
/**
* Creates an array of elements, sorted in ascending order by the results of
* running each element in a collection through the callback. This method
* performs a stable sort, that is, it will preserve the original sort order
* of equal elements. The callback is bound to `thisArg` and invoked with
* three arguments; (value, index|key, collection).
* performs a stable sort, that is, it preserves the original sort order of
* equal elements. The callback is bound to `thisArg` and invoked with three
* arguments; (value, index|key, collection).
*
* If a property name is provided for `callback` the created "_.pluck" style
* callback will return the property value of the given element.
* callback returns the property value of the given element.
*
* If an array of property names is provided for `callback` the collection
* will be sorted by each property value.
* is sorted by each property value.
*
* If an object is provided for `callback` the created "_.where" style callback
* will return `true` for elements that have the properties of the given object,
* returns `true` for elements that have the properties of the given object,
* else `false`.
*
* @static
@@ -4991,8 +4991,8 @@
* @category Collections
* @param {Array|Object|string} collection The collection to iterate over.
* @param {Array|Function|Object|string} [callback=identity] The function
* called per iteration. If a property name or object is provided it will
* be used to create a "_.pluck" or "_.where" style callback respectively.
* called per iteration. If a property name or object is provided it is
* used to create a "_.pluck" or "_.where" style callback respectively.
* @param {*} [thisArg] The `this` binding of `callback`.
* @returns {Array} Returns the new sorted array.
* @example
@@ -5183,7 +5183,7 @@
* Binds methods of an object to the object itself, overwriting the existing
* method. Method names may be specified as individual arguments or as arrays
* of method names. If no method names are provided all enumerable function
* properties, own and inherited, of `object` will be bound.
* properties, own and inherited, of `object` are bound.
*
* Note: This method does not set the `length` property of bound functions.
*
@@ -5235,7 +5235,7 @@
* Creates a function that invokes the method at `object[key]` and prepends
* any additional `bindKey` arguments to those provided to the bound function.
* This method differs from `_.bind` by allowing bound functions to reference
* methods that will be redefined or don't yet exist.
* methods that may be redefined or don't yet exist.
* See [Peter Michaux's article](http://michaux.ca/articles/lazy-function-definition-pattern)
* for more details.
*
@@ -5361,15 +5361,15 @@
}
/**
* Creates a function that will delay the execution of `func` until after
* `wait` milliseconds have elapsed since the last time it was invoked.
* The created function comes with a `cancel` method to cancel delayed calls.
* Provide an options object to indicate that `func` should be invoked on
* the leading and/or trailing edge of the `wait` timeout. Subsequent calls
* to the debounced function will return the result of the last `func` call.
* Creates a function that delays the execution of `func` until after `wait`
* milliseconds have elapsed since the last time it was invoked. The created
* function comes with a `cancel` method to cancel delayed calls. Provide an
* options object to indicate that `func` should be invoked on the leading
* and/or trailing edge of the `wait` timeout. Subsequent calls to the
* debounced function return the result of the last `func` call.
*
* Note: If `leading` and `trailing` options are `true`, `func` will be called
* on the trailing edge of the timeout only if the the debounced function is
* Note: If `leading` and `trailing` options are `true`, `func` is called on
* the trailing edge of the timeout only if the the debounced function is
* invoked more than once during the `wait` timeout.
*
* @static
@@ -5531,8 +5531,8 @@
}
/**
* Defers executing the `func` function until the current call stack has cleared.
* Additional arguments will be provided to `func` when it is invoked.
* Defers executing the `func` function until the current call stack has
* cleared. Additional arguments are provided to `func` when it is invoked.
*
* @static
* @memberOf _
@@ -5555,7 +5555,7 @@
/**
* Executes the `func` function after `wait` milliseconds. Additional arguments
* will be provided to `func` when it is invoked.
* are provided to `func` when it is invoked.
*
* @static
* @memberOf _
@@ -5579,11 +5579,11 @@
/**
* Creates a function that memoizes the result of `func`. If `resolver` is
* provided it will be used to determine the cache key for storing the result
* based on the arguments provided to the memoized function. By default, the
* first argument provided to the memoized function is used as the cache key.
* The `func` is executed with the `this` binding of the memoized function.
* The result cache is exposed as the `cache` property on the memoized function.
* provided it determines the cache key for storing the result based on the
* arguments provided to the memoized function. By default, the first argument
* provided to the memoized function is used as the cache key. The `func` is
* executed with the `this` binding of the memoized function. The result cache
* is exposed as the `cache` property on the memoized function.
*
* @static
* @memberOf _
@@ -5659,8 +5659,8 @@
}
/**
* Creates a function that is restricted to execute `func` once. Repeat calls to
* the function will return the value of the first call. The `func` is executed
* Creates a function that is restricted to execute `func` once. Repeat calls
* to the function return the value of the first call. The `func` is executed
* with the `this` binding of the created function.
*
* @static
@@ -5762,15 +5762,15 @@
}
/**
* Creates a function that will only call the `func` function at most once
* per every `wait` milliseconds. The created function comes with a `cancel`
* method to cancel delayed calls. Provide an options object to indicate that
* `func` should be invoked on the leading and/or trailing edge of the `wait`
* timeout. Subsequent calls to the throttled function will return the result
* of the last `func` call.
* Creates a function that only calls the `func` function at most once per
* every `wait` milliseconds. The created function comes with a `cancel` method
* to cancel delayed calls. Provide an options object to indicate that `func`
* should be invoked on the leading and/or trailing edge of the `wait` timeout.
* Subsequent calls to the throttled function return the result of the last
* `func` call.
*
* Note: If `leading` and `trailing` options are `true`, `func` will be called
* on the trailing edge of the timeout only if the the throttled function is
* Note: If `leading` and `trailing` options are `true`, `func` is called on
* the trailing edge of the timeout only if the the throttled function is
* invoked more than once during the `wait` timeout.
*
* @static
@@ -5843,10 +5843,10 @@
/**
* Assigns own enumerable properties of source object(s) to the destination
* object. Subsequent sources will overwrite property assignments of previous
* sources. If a callback is provided it will be executed to produce the
* assigned values. The callback is bound to `thisArg` and invoked with
* five arguments; (objectValue, sourceValue, key, object, source).
* object. Subsequent sources overwrite property assignments of previous
* sources. If a callback is provided it is executed to produce the assigned
* values. The callback is bound to `thisArg` and invoked with five arguments;
* (objectValue, sourceValue, key, object, source).
*
* @static
* @memberOf _
@@ -5872,11 +5872,11 @@
var assign = createAssigner(baseAssign);
/**
* Creates a clone of `value`. If `isDeep` is `true` nested objects will also
* be cloned, otherwise they will be assigned by reference. If a callback
* is provided it will be executed to produce the cloned values. If the
* callback returns `undefined` cloning will be handled by the method instead.
* The callback is bound to `thisArg` and invoked with two argument; (value, index|key).
* Creates a clone of `value`. If `isDeep` is `true` nested objects are cloned,
* otherwise they are assigned by reference. If a callback is provided it is
* executed to produce the cloned values. If the callback returns `undefined`
* cloning is handled by the method instead. The callback is bound to `thisArg`
* and invoked with two argument; (value, index|key).
*
* Note: This method is loosely based on the structured clone algorithm. Functions
* and DOM nodes are **not** cloned. The enumerable properties of `arguments` objects and
@@ -5936,10 +5936,10 @@
}
/**
* Creates a deep clone of `value`. If a callback is provided it will be
* executed to produce the cloned values. If the callback returns `undefined`
* cloning will be handled by the method instead. The callback is bound to
* `thisArg` and invoked with two argument; (value, index|key).
* Creates a deep clone of `value`. If a callback is provided it is executed
* to produce the cloned values. If the callback returns `undefined` cloning
* is handled by the method instead. The callback is bound to `thisArg` and
* invoked with two argument; (value, index|key).
*
* Note: This method is loosely based on the structured clone algorithm. Functions
* and DOM nodes are **not** cloned. The enumerable properties of `arguments` objects and
@@ -6021,7 +6021,7 @@
/**
* Assigns own enumerable properties of source object(s) to the destination
* object for all destination properties that resolve to `undefined`. Once a
* property is set, additional defaults of the same property will be ignored.
* property is set, additional defaults of the same property are ignored.
*
* Note: See the [documentation example of `_.partialRight`](http://lodash.com/docs#partialRight)
* for a deep version of this method.
@@ -6052,10 +6052,10 @@
* first element the predicate returns truthy for, instead of the element itself.
*
* If a property name is provided for `predicate` the created "_.pluck" style
* callback will return the property value of the given element.
* callback returns the property value of the given element.
*
* If an object is provided for `predicate` the created "_.where" style callback
* will return `true` for elements that have the properties of the given object,
* returns `true` for elements that have the properties of the given object,
* else `false`.
*
* @static
@@ -6063,8 +6063,8 @@
* @category Objects
* @param {Object} object The object to search.
* @param {Function|Object|string} [predicate=identity] The function called
* per iteration. If a property name or object is provided it will be used
* to create a "_.pluck" or "_.where" style callback respectively.
* per iteration. If a property name or object is provided it is used to
* create a "_.pluck" or "_.where" style callback respectively.
* @param {*} [thisArg] The `this` binding of `predicate`.
* @returns {string|undefined} Returns the key of the matched element, else `undefined`.
* @example
@@ -6098,10 +6098,10 @@
* a collection in the opposite order.
*
* If a property name is provided for `predicate` the created "_.pluck" style
* callback will return the property value of the given element.
* callback returns the property value of the given element.
*
* If an object is provided for `predicate` the created "_.where" style callback
* will return `true` for elements that have the properties of the given object,
* returns `true` for elements that have the properties of the given object,
* else `false`.
*
* @static
@@ -6109,8 +6109,8 @@
* @category Objects
* @param {Object} object The object to search.
* @param {Function|Object|string} [predicate=identity] The function called
* per iteration. If a property name or object is provided it will be used
* to create a "_.pluck" or "_.where" style callback respectively.
* per iteration. If a property name or object is provided it is used to
* create a "_.pluck" or "_.where" style callback respectively.
* @param {*} [thisArg] The `this` binding of `predicate`.
* @returns {string|undefined} Returns the key of the matched element, else `undefined`.
* @example
@@ -6294,7 +6294,7 @@
/**
* Creates an object composed of the inverted keys and values of the given
* object. If the given object contains duplicate values, subsequent values
* will overwrite property assignments of previous values unless `multiValue`
* overwrite property assignments of previous values unless `multiValue`
* is `true`.
*
* @static
@@ -6505,10 +6505,10 @@
/**
* Performs a deep comparison between two values to determine if they are
* equivalent. If a callback is provided it will be executed to compare
* values. If the callback returns `undefined` comparisons will be handled
* by the method instead. The callback is bound to `thisArg` and invoked
* with three arguments; (value, other, key).
* equivalent. If a callback is provided it is executed to compare values.
* If the callback returns `undefined` comparisons are handled by the method
* instead. The callback is bound to `thisArg` and invoked with three arguments;
* (value, other, key).
*
* Note: This method supports comparing arrays, booleans, `Date` objects,
* numbers, `Object` objects, regexes, and strings. Functions and DOM nodes
@@ -6587,7 +6587,7 @@
/**
* Checks if `value` is, or can be coerced to, a finite number.
*
* Note: This method is not the same as native `isFinite` which will return
* Note: This method is not the same as native `isFinite` which returns
* `true` for booleans and empty strings. See the [ES5 spec](http://es5.github.io/#x15.1.2.5)
* for more details.
*
@@ -6677,7 +6677,7 @@
/**
* Checks if `value` is `NaN`.
*
* Note: This method is not the same as native `isNaN` which will return `true`
* Note: This method is not the same as native `isNaN` which returns `true`
* for `undefined` and other non-numeric values. See the [ES5 spec](http://es5.github.io/#x15.1.2.4)
* for more details.
*
@@ -6968,10 +6968,10 @@
* (value, key, object).
*
* If a property name is provided for `callback` the created "_.pluck" style
* callback will return the property value of the given element.
* callback returns the property value of the given element.
*
* If an object is provided for `callback` the created "_.where" style callback
* will return `true` for elements that have the properties of the given object,
* returns `true` for elements that have the properties of the given object,
* else `false`.
*
* @static
@@ -6979,8 +6979,8 @@
* @category Objects
* @param {Object} object The object to iterate over.
* @param {Function|Object|string} [callback=identity] The function called
* per iteration. If a property name or object is provided it will be used
* to create a "_.pluck" or "_.where" style callback respectively.
* per iteration. If a property name or object is provided it is used to
* create a "_.pluck" or "_.where" style callback respectively.
* @param {*} [thisArg] The `this` binding of `callback`.
* @returns {Object} Returns the new mapped object.
* @example
@@ -7010,11 +7010,11 @@
/**
* Recursively merges own enumerable properties of the source object(s), that
* don't resolve to `undefined` into the destination object. Subsequent sources
* will overwrite property assignments of previous sources. If a callback is
* provided it will be executed to produce the merged values of the destination
* and source properties. If the callback returns `undefined` merging will
* be handled by the method instead. The callback is bound to `thisArg` and
* invoked with five arguments; (objectValue, sourceValue, key, object, source).
* overwrite property assignments of previous sources. If a callback is provided
* it is executed to produce the merged values of the destination and source
* properties. If the callback returns `undefined` merging is handled by the
* method instead. The callback is bound to `thisArg` and invoked with five
* arguments; (objectValue, sourceValue, key, object, source).
*
* @static
* @memberOf _
@@ -7063,9 +7063,9 @@
/**
* Creates a shallow clone of `object` excluding the specified properties.
* Property names may be specified as individual arguments or as arrays of
* property names. If a predicate is provided it will be executed for each
* property of `object` omitting the properties the predicate returns truthy
* for. The predicate is bound to `thisArg` and invoked with three arguments;
* property names. If a predicate is provided it is executed for each property
* of `object` omitting the properties the predicate returns truthy for. The
* predicate is bound to `thisArg` and invoked with three arguments;
* (value, key, object).
*
* @static
@@ -7133,9 +7133,9 @@
/**
* Creates a shallow clone of `object` composed of the specified properties.
* Property names may be specified as individual arguments or as arrays of
* property names. If a predicate is provided it will be executed for each
* property of `object` picking the properties the predicate returns truthy
* for. The predicate is bound to `thisArg` and invoked with three arguments;
* property names. If a predicate is provided it is executed for each property
* of `object` picking the properties the predicate returns truthy for. The
* predicate is bound to `thisArg` and invoked with three arguments;
* (value, key, object).
*
* @static
@@ -7606,9 +7606,9 @@
* Creates a compiled template function that can interpolate data properties
* in "interpolate" delimiters, HTML-escaped interpolated data properties in
* "escape" delimiters, and execute JavaScript in "evaluate" delimiters. If
* a data object is provided the interpolated template string will be returned.
* a data object is provided the interpolated template string is returned.
* Data properties may be accessed as free variables in the template. If a
* settings object is provided it will override `_.templateSettings` for the
* settings object is provided it overrides `_.templateSettings` for the
* template.
*
* Note: In the development build, `_.template` utilizes sourceURLs for easier debugging.
@@ -7872,8 +7872,8 @@
/**
* Truncates `string` if it is longer than the given maximum string length.
* The last characters of the truncated string will be replaced with the
* omission string which defaults to "...".
* The last characters of the truncated string are replaced with the omission
* string which defaults to "...".
*
* @static
* @memberOf _
@@ -8000,9 +8000,9 @@
/**
* Creates a function bound to an optional `thisArg`. If `func` is a property
* name the created callback will return the property value for a given element.
* If `func` is an object the created callback will return `true` for elements
* that contain the equivalent object properties, otherwise it will return `false`.
* name the created callback returns the property value for a given element.
* If `func` is an object the created callback returns `true` for elements
* that contain the equivalent object properties, otherwise it returns `false`.
*
* @static
* @memberOf _
@@ -8123,7 +8123,7 @@
/**
* Adds all own enumerable function properties of a source object to the
* destination object. If `object` is a function methods will be added to
* destination object. If `object` is a function then methods are added to
* its prototype as well.
*
* @static
@@ -8313,9 +8313,9 @@
/**
* Produces a random number between `min` and `max` (inclusive). If only one
* argument is provided a number between `0` and the given number will be
* returned. If `floating` is truthy or either `min` or `max` are floats a
* floating-point number will be returned instead of an integer.
* argument is provided a number between `0` and the given number is returned.
* If `floating` is truthy, or either `min` or `max` are floats, a floating-point
* number is returned instead of an integer.
*
* @static
* @memberOf _
@@ -8427,10 +8427,10 @@
/**
* Resolves the value of property `key` on `object`. If `key` is a function
* it will be invoked with the `this` binding of `object` and its result
* returned, else the property value is returned. If `object` is `null` or
* `undefined` then `undefined` is returned. If a default value is provided
* it will be returned if the property value resolves to `undefined`.
* it is invoked with the `this` binding of `object` and its result returned,
* else the property value is returned. If `object` is `null` or `undefined`
* then `undefined` is returned. If a default value is provided it is returned
* if the property value resolves to `undefined`.
*
* @static
* @memberOf _
@@ -8503,7 +8503,7 @@
}
/**
* Generates a unique ID. If `prefix` is provided the ID will be appended to it.
* Generates a unique ID. If `prefix` is provided the ID is appended to it.
*
* @static
* @memberOf _