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

Remove default false from param docs. [ci skip]

Browse Source
This commit is contained in:
John-David Dalton
2014-12-20 14:56:35 -06:00
parent 5d83cafc50
commit 8299dded0b
1 changed files with 23 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
lodash.js
View File

@@ -398,7 +398,7 @@
* @param {Array} array The array to iterate over. * @param {Array} array The array to iterate over.
* @param {Function} iteratee The function invoked per iteration. * @param {Function} iteratee The function invoked per iteration.
* @param {*} [accumulator] The initial value. * @param {*} [accumulator] The initial value.
* @param {boolean} [initFromArray=false] Specify using the first element of * @param {boolean} [initFromArray] Specify using the first element of
* `array` as the initial value. * `array` as the initial value.
* @returns {*} Returns the accumulated value. * @returns {*} Returns the accumulated value.
*/ */
@@ -423,7 +423,7 @@
* @param {Array} array The array to iterate over. * @param {Array} array The array to iterate over.
* @param {Function} iteratee The function invoked per iteration. * @param {Function} iteratee The function invoked per iteration.
* @param {*} [accumulator] The initial value. * @param {*} [accumulator] The initial value.
* @param {boolean} [initFromArray=false] Specify using the last element of * @param {boolean} [initFromArray] Specify using the last element of
* `array` as the initial value. * `array` as the initial value.
* @returns {*} Returns the accumulated value. * @returns {*} Returns the accumulated value.
*/ */
@@ -676,7 +676,7 @@
* @private * @private
* @param {Array} array The array to search. * @param {Array} array The array to search.
* @param {number} [fromIndex] The index to search from. * @param {number} [fromIndex] The index to search from.
* @param {boolean} [fromRight=false] Specify iterating from right to left. * @param {boolean} [fromRight] Specify iterating from right to left.
* @returns {number} Returns the index of the matched `NaN`, else `-1`. * @returns {number} Returns the index of the matched `NaN`, else `-1`.
*/ */
function indexOfNaN(array, fromIndex, fromRight) { function indexOfNaN(array, fromIndex, fromRight) {
@@ -1111,7 +1111,7 @@
* *
* @private * @private
* @param {*} value The value to wrap. * @param {*} value The value to wrap.
* @param {boolean} [chainAll=false] Enable chaining for all wrapper methods. * @param {boolean} [chainAll] Enable chaining for all wrapper methods.
* @param {Array} [actions=[]] Actions to peform to resolve the unwrapped value. * @param {Array} [actions=[]] Actions to peform to resolve the unwrapped value.
*/ */
function LodashWrapper(value, chainAll, actions) { function LodashWrapper(value, chainAll, actions) {
@@ -1733,7 +1733,7 @@
* @param {Array} array The sorted array to inspect. * @param {Array} array The sorted array to inspect.
* @param {*} value The value to evaluate. * @param {*} value The value to evaluate.
* @param {Function} [iteratee=_.identity] The function invoked per iteration. * @param {Function} [iteratee=_.identity] The function invoked per iteration.
* @param {boolean} [retHighest=false] Specify returning the highest, instead * @param {boolean} [retHighest] Specify returning the highest, instead
* of the lowest, index at which a value should be inserted into `array`. * of the lowest, index at which a value should be inserted into `array`.
* @returns {number} Returns the index at which `value` should be inserted * @returns {number} Returns the index at which `value` should be inserted
* into `array`. * into `array`.
@@ -1858,7 +1858,7 @@
* *
* @private * @private
* @param {*} value The value to clone. * @param {*} value The value to clone.
* @param {boolean} [isDeep=false] Specify a deep clone. * @param {boolean} [isDeep] Specify a deep clone.
* @param {Function} [customizer] The function to customize cloning values. * @param {Function} [customizer] The function to customize cloning values.
* @param {string} [key] The key of `value`. * @param {string} [key] The key of `value`.
* @param {Object} [object] The object `value` belongs to. * @param {Object} [object] The object `value` belongs to.
@@ -2098,7 +2098,7 @@
* @param {Array|Object|string} collection The collection to search. * @param {Array|Object|string} collection The collection to search.
* @param {Function} predicate The function invoked per iteration. * @param {Function} predicate The function invoked per iteration.
* @param {Function} eachFunc The function to iterate over `collection`. * @param {Function} eachFunc The function to iterate over `collection`.
* @param {boolean} [retKey=false] Specify returning the key of the found * @param {boolean} [retKey] Specify returning the key of the found
* element instead of the element itself. * element instead of the element itself.
* @returns {*} Returns the found element or its key, else `undefined`. * @returns {*} Returns the found element or its key, else `undefined`.
*/ */
@@ -2120,8 +2120,8 @@
* *
* @private * @private
* @param {Array} array The array to flatten. * @param {Array} array The array to flatten.
* @param {boolean} [isDeep=false] Specify a deep flatten. * @param {boolean} [isDeep] Specify a deep flatten.
* @param {boolean} [isStrict=false] Restrict flattening to arrays and `arguments` objects. * @param {boolean} [isStrict] Restrict flattening to arrays and `arguments` objects.
* @param {number} [fromIndex=0] The index to start from. * @param {number} [fromIndex=0] The index to start from.
* @returns {Array} Returns the new flattened array. * @returns {Array} Returns the new flattened array.
*/ */
@@ -2332,7 +2332,7 @@
* @param {Array} other The object to compare to `value`. * @param {Array} other The object to compare to `value`.
* @param {Function} equalFunc The function to determine equivalents of arbitrary values. * @param {Function} equalFunc The function to determine equivalents of arbitrary values.
* @param {Function} [customizer] The function to customize comparing objects. * @param {Function} [customizer] The function to customize comparing objects.
* @param {boolean} [isWhere=false] Specify performing partial comparisons. * @param {boolean} [isWhere] Specify performing partial comparisons.
* @param {Array} [stackA=[]] Tracks traversed `value` objects. * @param {Array} [stackA=[]] Tracks traversed `value` objects.
* @param {Array} [stackB=[]] Tracks traversed `other` objects. * @param {Array} [stackB=[]] Tracks traversed `other` objects.
* @returns {boolean} Returns `true` if the objects are equivalent, else `false`. * @returns {boolean} Returns `true` if the objects are equivalent, else `false`.
@@ -2735,7 +2735,7 @@
* @param {Array} array The sorted array to inspect. * @param {Array} array The sorted array to inspect.
* @param {*} value The value to evaluate. * @param {*} value The value to evaluate.
* @param {Function} [iteratee] The function invoked per iteration. * @param {Function} [iteratee] The function invoked per iteration.
* @param {boolean} [retHighest=false] Specify returning the highest, instead * @param {boolean} [retHighest] Specify returning the highest, instead
* of the lowest, index at which a value should be inserted into `array`. * of the lowest, index at which a value should be inserted into `array`.
* @returns {number} Returns the index at which `value` should be inserted * @returns {number} Returns the index at which `value` should be inserted
* into `array`. * into `array`.
@@ -3302,17 +3302,17 @@
} }
/** /**
* A specialized version of `baseIsEqualDeep`, for objects-only, which allows * A specialized version of `baseIsEqualDeep`, for objects-only, which supports
* partial "_.where" style comparisons. * partial deep comparisons.
* *
* @private * @private
* @param {Object} object The object to compare to `other`. * @param {Object} object The object to compare to `other`.
* @param {Object} other The object to compare to `value`. * @param {Object} other The object to compare to `value`.
* @param {Function} equalFunc The function to determine equivalents of arbitrary values. * @param {Function} equalFunc The function to determine equivalents of arbitrary values.
* @param {Function} [customizer] The function to customize comparing values. * @param {Function} [customizer] The function to customize comparing values.
* @param {boolean} [isWhere=false] Specify performing partial comparisons. * @param {boolean} [isWhere] Specify performing partial comparisons.
* @param {Array} [stackA=[]] Tracks traversed `value` objects. * @param {Array} [stackA] Tracks traversed `value` objects.
* @param {Array} [stackB=[]] Tracks traversed `other` objects. * @param {Array} [stackB] Tracks traversed `other` objects.
* @returns {boolean} Returns `true` if the objects are equivalent, else `false`. * @returns {boolean} Returns `true` if the objects are equivalent, else `false`.
*/ */
function equalObjects(object, other, equalFunc, customizer, isWhere, stackA, stackB) { function equalObjects(object, other, equalFunc, customizer, isWhere, stackA, stackB) {
@@ -3437,7 +3437,7 @@
* *
* @private * @private
* @param {Array} array The array to clone. * @param {Array} array The array to clone.
* @param {boolean} [isDeep=false] Specify a deep clone. * @param {boolean} [isDeep] Specify a deep clone.
* @returns {Array} Returns the initialized array clone. * @returns {Array} Returns the initialized array clone.
*/ */
function initArrayClone(array, isDeep) { function initArrayClone(array, isDeep) {
@@ -3463,7 +3463,7 @@
* *
* @private * @private
* @param {Object} object The object to clone. * @param {Object} object The object to clone.
* @param {boolean} [isDeep=false] Specify a deep clone. * @param {boolean} [isDeep] Specify a deep clone.
* @returns {null|Object} Returns the initialized object clone if an object * @returns {null|Object} Returns the initialized object clone if an object
* is cloneable, else `null`. * is cloneable, else `null`.
*/ */
@@ -4268,7 +4268,7 @@
* @memberOf _ * @memberOf _
* @category Array * @category Array
* @param {Array} array The array to flatten. * @param {Array} array The array to flatten.
* @param {boolean} [isDeep=false] Specify a deep flatten. * @param {boolean} [isDeep] Specify a deep flatten.
* @param- {Object} [guard] Enables use as a callback for functions like `_.map`. * @param- {Object} [guard] Enables use as a callback for functions like `_.map`.
* @returns {Array} Returns the new flattened array. * @returns {Array} Returns the new flattened array.
* @example * @example
@@ -4969,7 +4969,7 @@
* @alias unique * @alias unique
* @category Array * @category Array
* @param {Array} array The array to inspect. * @param {Array} array The array to inspect.
* @param {boolean} [isSorted=false] Specify the array is sorted. * @param {boolean} [isSorted] Specify the array is sorted.
* @param {Function|Object|string} [iteratee] The function invoked per iteration. * @param {Function|Object|string} [iteratee] The function invoked per iteration.
* If a property name or object is provided it is 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. * or "_.where" style callback respectively.
@@ -7455,7 +7455,7 @@
* @memberOf _ * @memberOf _
* @category Lang * @category Lang
* @param {*} value The value to clone. * @param {*} value The value to clone.
* @param {boolean} [isDeep=false] Specify a deep clone. * @param {boolean} [isDeep] Specify a deep clone.
* @param {Function} [customizer] The function to customize cloning values. * @param {Function} [customizer] The function to customize cloning values.
* @param {*} [thisArg] The `this` binding of `customizer`. * @param {*} [thisArg] The `this` binding of `customizer`.
* @returns {*} Returns the cloned value. * @returns {*} Returns the cloned value.
@@ -8470,7 +8470,7 @@
* @memberOf _ * @memberOf _
* @category Object * @category Object
* @param {Object} object The object to invert. * @param {Object} object The object to invert.
* @param {boolean} [multiValue=false] Allow multiple values per key. * @param {boolean} [multiValue] Allow multiple values per key.
* @param- {Object} [guard] Enables use as a callback for functions like `_.map`. * @param- {Object} [guard] Enables use as a callback for functions like `_.map`.
* @returns {Object} Returns the new inverted object. * @returns {Object} Returns the new inverted object.
* @example * @example
@@ -8974,7 +8974,7 @@
* @category Number * @category Number
* @param {number} [min=0] The minimum possible value. * @param {number} [min=0] The minimum possible value.
* @param {number} [max=1] The maximum possible value. * @param {number} [max=1] The maximum possible value.
* @param {boolean} [floating=false] Specify returning a floating-point number. * @param {boolean} [floating] Specify returning a floating-point number.
* @returns {number} Returns the random number. * @returns {number} Returns the random number.
* @example * @example
* *