Mirrors/lodash
1
0
Fork 0
mirror of https://github.com/whoisclebs/lodash.git synced 2026-01-29 14:37:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

Simplify jsdoc arg signatures.

Browse Source
This commit is contained in:
John-David Dalton
2016-05-27 14:38:32 -07:00
parent ee5718003b
commit a7dcce3e8d
1 changed files with 52 additions and 70 deletions
Download Patch File Download Diff File Expand all files Collapse all files

122
lodash.js
View File

@@ -6234,8 +6234,7 @@
* @category Array
* @param {Array} array The array to inspect.
* @param {...Array} [values] The values to exclude.
* @param {Array|Function|Object|string} [iteratee=_.identity]
* The iteratee invoked per element.
* @param {Function} [iteratee=_.identity] The iteratee invoked per element.
* @returns {Array} Returns the new array of filtered values.
* @example
*
@@ -6366,8 +6365,7 @@
* @since 3.0.0
* @category Array
* @param {Array} array The array to query.
* @param {Array|Function|Object|string} [predicate=_.identity]
* The function invoked per iteration.
* @param {Function} [predicate=_.identity] The function invoked per iteration.
* @returns {Array} Returns the slice of `array`.
* @example
*
@@ -6408,7 +6406,7 @@
* @since 3.0.0
* @category Array
* @param {Array} array The array to query.
* @param {Array|Function|Object|string} [predicate=_.identity]
* @param {Function} [predicate=_.identity]
* The function invoked per iteration.
* @returns {Array} Returns the slice of `array`.
* @example
@@ -6490,7 +6488,7 @@
* @since 1.1.0
* @category Array
* @param {Array} array The array to search.
* @param {Array|Function|Object|string} [predicate=_.identity]
* @param {Function} [predicate=_.identity]
* The function invoked per iteration.
* @param {number} [fromIndex=0] The index to search from.
* @returns {number} Returns the index of the found element, else `-1`.
@@ -6538,7 +6536,7 @@
* @since 2.0.0
* @category Array
* @param {Array} array The array to search.
* @param {Array|Function|Object|string} [predicate=_.identity]
* @param {Function} [predicate=_.identity]
* The function invoked per iteration.
* @param {number} [fromIndex=array.length-1] The index to search from.
* @returns {number} Returns the index of the found element, else `-1`.
@@ -6784,8 +6782,7 @@
* @since 4.0.0
* @category Array
* @param {...Array} [arrays] The arrays to inspect.
* @param {Array|Function|Object|string} [iteratee=_.identity]
* The iteratee invoked per element.
* @param {Function} [iteratee=_.identity] The iteratee invoked per element.
* @returns {Array} Returns the new array of intersecting values.
* @example
*
@@ -7018,7 +7015,7 @@
* @category Array
* @param {Array} array The array to modify.
* @param {Array} values The values to remove.
* @param {Array|Function|Object|string} [iteratee=_.identity]
* @param {Function} [iteratee=_.identity]
* The iteratee invoked per element.
* @returns {Array} Returns `array`.
* @example
@@ -7114,7 +7111,7 @@
* @since 2.0.0
* @category Array
* @param {Array} array The array to modify.
* @param {Array|Function|Object|string} [predicate=_.identity]
* @param {Function} [predicate=_.identity]
* The function invoked per iteration.
* @returns {Array} Returns the new array of removed elements.
* @example
@@ -7242,7 +7239,7 @@
* @category Array
* @param {Array} array The sorted array to inspect.
* @param {*} value The value to evaluate.
* @param {Array|Function|Object|string} [iteratee=_.identity]
* @param {Function} [iteratee=_.identity]
* The iteratee invoked per element.
* @returns {number} Returns the index at which `value` should be inserted
* into `array`.
@@ -7321,7 +7318,7 @@
* @category Array
* @param {Array} array The sorted array to inspect.
* @param {*} value The value to evaluate.
* @param {Array|Function|Object|string} [iteratee=_.identity]
* @param {Function} [iteratee=_.identity]
* The iteratee invoked per element.
* @returns {number} Returns the index at which `value` should be inserted
* into `array`.
@@ -7506,7 +7503,7 @@
* @since 3.0.0
* @category Array
* @param {Array} array The array to query.
* @param {Array|Function|Object|string} [predicate=_.identity]
* @param {Function} [predicate=_.identity]
* The function invoked per iteration.
* @returns {Array} Returns the slice of `array`.
* @example
@@ -7548,7 +7545,7 @@
* @since 3.0.0
* @category Array
* @param {Array} array The array to query.
* @param {Array|Function|Object|string} [predicate=_.identity]
* @param {Function} [predicate=_.identity]
* The function invoked per iteration.
* @returns {Array} Returns the slice of `array`.
* @example
@@ -7611,7 +7608,7 @@
* @since 4.0.0
* @category Array
* @param {...Array} [arrays] The arrays to inspect.
* @param {Array|Function|Object|string} [iteratee=_.identity]
* @param {Function} [iteratee=_.identity]
* The iteratee invoked per element.
* @returns {Array} Returns the new array of combined values.
* @example
@@ -7692,7 +7689,7 @@
* @since 4.0.0
* @category Array
* @param {Array} array The array to inspect.
* @param {Array|Function|Object|string} [iteratee=_.identity]
* @param {Function} [iteratee=_.identity]
* The iteratee invoked per element.
* @returns {Array} Returns the new duplicate free array.
* @example
@@ -7861,7 +7858,7 @@
* @since 4.0.0
* @category Array
* @param {...Array} [arrays] The arrays to inspect.
* @param {Array|Function|Object|string} [iteratee=_.identity]
* @param {Function} [iteratee=_.identity]
* The iteratee invoked per element.
* @returns {Array} Returns the new array of filtered values.
* @example
@@ -8354,7 +8351,7 @@
* @since 0.5.0
* @category Collection
* @param {Array|Object} collection The collection to iterate over.
* @param {Array|Function|Object|string} [iteratee=_.identity]
* @param {Function} [iteratee=_.identity]
* The iteratee to transform keys.
* @returns {Object} Returns the composed aggregate object.
* @example
@@ -8380,7 +8377,7 @@
* @since 0.1.0
* @category Collection
* @param {Array|Object} collection The collection to iterate over.
* @param {Array|Function|Object|string} [predicate=_.identity]
* @param {Function} [predicate=_.identity]
* The function invoked per iteration.
* @param- {Object} [guard] Enables use as an iteratee for methods like `_.map`.
* @returns {boolean} Returns `true` if all elements pass the predicate check,
@@ -8425,7 +8422,7 @@
* @since 0.1.0
* @category Collection
* @param {Array|Object} collection The collection to iterate over.
* @param {Array|Function|Object|string} [predicate=_.identity]
* @param {Function} [predicate=_.identity]
* The function invoked per iteration.
* @returns {Array} Returns the new filtered array.
* @see _.reject
@@ -8466,7 +8463,7 @@
* @since 0.1.0
* @category Collection
* @param {Array|Object} collection The collection to search.
* @param {Array|Function|Object|string} [predicate=_.identity]
* @param {Function} [predicate=_.identity]
* The function invoked per iteration.
* @param {number} [fromIndex=0] The index to search from.
* @returns {*} Returns the matched element, else `undefined`.
@@ -8504,7 +8501,7 @@
* @since 2.0.0
* @category Collection
* @param {Array|Object} collection The collection to search.
* @param {Array|Function|Object|string} [predicate=_.identity]
* @param {Function} [predicate=_.identity]
* The function invoked per iteration.
* @param {number} [fromIndex=collection.length-1] The index to search from.
* @returns {*} Returns the matched element, else `undefined`.
@@ -8527,7 +8524,7 @@
* @since 4.0.0
* @category Collection
* @param {Array|Object} collection The collection to iterate over.
* @param {Array|Function|Object|string} [iteratee=_.identity]
* @param {Function} [iteratee=_.identity]
* The function invoked per iteration.
* @returns {Array} Returns the new flattened array.
* @example
@@ -8552,7 +8549,7 @@
* @since 4.7.0
* @category Collection
* @param {Array|Object} collection The collection to iterate over.
* @param {Array|Function|Object|string} [iteratee=_.identity]
* @param {Function} [iteratee=_.identity]
* The function invoked per iteration.
* @returns {Array} Returns the new flattened array.
* @example
@@ -8577,7 +8574,7 @@
* @since 4.7.0
* @category Collection
* @param {Array|Object} collection The collection to iterate over.
* @param {Array|Function|Object|string} [iteratee=_.identity]
* @param {Function} [iteratee=_.identity]
* The function invoked per iteration.
* @param {number} [depth=1] The maximum recursion depth.
* @returns {Array} Returns the new flattened array.
@@ -8667,7 +8664,7 @@
* @since 0.1.0
* @category Collection
* @param {Array|Object} collection The collection to iterate over.
* @param {Array|Function|Object|string} [iteratee=_.identity]
* @param {Function} [iteratee=_.identity]
* The iteratee to transform keys.
* @returns {Object} Returns the composed aggregate object.
* @example
@@ -8777,7 +8774,7 @@
* @since 4.0.0
* @category Collection
* @param {Array|Object} collection The collection to iterate over.
* @param {Array|Function|Object|string} [iteratee=_.identity]
* @param {Function} [iteratee=_.identity]
* The iteratee to transform keys.
* @returns {Object} Returns the composed aggregate object.
* @example
@@ -8818,8 +8815,7 @@
* @since 0.1.0
* @category Collection
* @param {Array|Object} collection The collection to iterate over.
* @param {Array|Function|Object|string} [iteratee=_.identity]
* The function invoked per iteration.
* @param {Function} [iteratee=_.identity] The function invoked per iteration.
* @returns {Array} Returns the new mapped array.
* @example
*
@@ -8901,8 +8897,7 @@
* @since 3.0.0
* @category Collection
* @param {Array|Object} collection The collection to iterate over.
* @param {Array|Function|Object|string} [predicate=_.identity]
* The function invoked per iteration.
* @param {Function} [predicate=_.identity] The function invoked per iteration.
* @returns {Array} Returns the array of grouped elements.
* @example
*
@@ -9013,8 +9008,7 @@
* @since 0.1.0
* @category Collection
* @param {Array|Object} collection The collection to iterate over.
* @param {Array|Function|Object|string} [predicate=_.identity]
* The function invoked per iteration.
* @param {Function} [predicate=_.identity] The function invoked per iteration.
* @returns {Array} Returns the new filtered array.
* @see _.filter
* @example
@@ -9177,8 +9171,7 @@
* @since 0.1.0
* @category Collection
* @param {Array|Object} collection The collection to iterate over.
* @param {Array|Function|Object|string} [predicate=_.identity]
* The function invoked per iteration.
* @param {Function} [predicate=_.identity] The function invoked per iteration.
* @param- {Object} [guard] Enables use as an iteratee for methods like `_.map`.
* @returns {boolean} Returns `true` if any element passes the predicate check,
* else `false`.
@@ -9223,8 +9216,8 @@
* @since 0.1.0
* @category Collection
* @param {Array|Object} collection The collection to iterate over.
* @param {...(Array|Array[]|Function|Function[]|Object|Object[]|string|string[])}
* [iteratees=[_.identity]] The iteratees to sort by.
* @param {...(Function|Function[])} [iteratees=[_.identity]]
* The iteratees to sort by.
* @returns {Array} Returns the new sorted array.
* @example
*
@@ -9934,8 +9927,8 @@
* @memberOf _
* @category Function
* @param {Function} func The function to wrap.
* @param {...(Array|Array[]|Function|Function[]|Object|Object[]|string|string[])}
* [transforms[_.identity]] The functions to transform.
* @param {...(Function|Function[])} [transforms[_.identity]]
* The argument transforms.
* @returns {Function} Returns the new function.
* @example
*
@@ -12153,8 +12146,7 @@
* @since 1.1.0
* @category Object
* @param {Object} object The object to search.
* @param {Array|Function|Object|string} [predicate=_.identity]
* The function invoked per iteration.
* @param {Function} [predicate=_.identity] The function invoked per iteration.
* @returns {string|undefined} Returns the key of the matched element,
* else `undefined`.
* @example
@@ -12193,8 +12185,7 @@
* @since 2.0.0
* @category Object
* @param {Object} object The object to search.
* @param {Array|Function|Object|string} [predicate=_.identity]
* The function invoked per iteration.
* @param {Function} [predicate=_.identity] The function invoked per iteration.
* @returns {string|undefined} Returns the key of the matched element,
* else `undefined`.
* @example
@@ -12531,8 +12522,7 @@
* @since 4.1.0
* @category Object
* @param {Object} object The object to invert.
* @param {Array|Function|Object|string} [iteratee=_.identity]
* The iteratee invoked per element.
* @param {Function} [iteratee=_.identity] The iteratee invoked per element.
* @returns {Object} Returns the new inverted object.
* @example
*
@@ -12676,8 +12666,7 @@
* @since 3.8.0
* @category Object
* @param {Object} object The object to iterate over.
* @param {Array|Function|Object|string} [iteratee=_.identity]
* The function invoked per iteration.
* @param {Function} [iteratee=_.identity] The function invoked per iteration.
* @returns {Object} Returns the new mapped object.
* @see _.mapValues
* @example
@@ -12708,8 +12697,7 @@
* @since 2.4.0
* @category Object
* @param {Object} object The object to iterate over.
* @param {Array|Function|Object|string} [iteratee=_.identity]
* The function invoked per iteration.
* @param {Function} [iteratee=_.identity] The function invoked per iteration.
* @returns {Object} Returns the new mapped object.
* @see _.mapKeys
* @example
@@ -12851,8 +12839,7 @@
* @since 4.0.0
* @category Object
* @param {Object} object The source object.
* @param {Array|Function|Object|string} [predicate=_.identity]
* The function invoked per property.
* @param {Function} [predicate=_.identity] The function invoked per property.
* @returns {Object} Returns the new object.
* @example
*
@@ -12898,8 +12885,7 @@
* @since 4.0.0
* @category Object
* @param {Object} object The source object.
* @param {Array|Function|Object|string} [predicate=_.identity]
* The function invoked per property.
* @param {Function} [predicate=_.identity] The function invoked per property.
* @returns {Object} Returns the new object.
* @example
*
@@ -14742,7 +14728,7 @@
* @memberOf _
* @since 3.0.0
* @category Util
* @param {...(Function|Function[])} [funcs] Functions to invoke.
* @param {...(Function|Function[])} [funcs] The functions to invoke.
* @returns {Function} Returns the new composite function.
* @see _.flowRight
* @example
@@ -14765,7 +14751,7 @@
* @since 3.0.0
* @memberOf _
* @category Util
* @param {...(Function|Function[])} [funcs] Functions to invoke.
* @param {...(Function|Function[])} [funcs] The functions to invoke.
* @returns {Function} Returns the new composite function.
* @see _.flow
* @example
@@ -15104,8 +15090,8 @@
* @memberOf _
* @since 4.0.0
* @category Util
* @param {...(Array|Array[]|Function|Function[]|Object|Object[]|string|string[])}
* [iteratees=[_.identity]] The iteratees to invoke.
* @param {...(Function|Function[])} [iteratees=[_.identity]]
* The iteratees to invoke.
* @returns {Function} Returns the new function.
* @example
*
@@ -15124,8 +15110,8 @@
* @memberOf _
* @since 4.0.0
* @category Util
* @param {...(Array|Array[]|Function|Function[]|Object|Object[]|string|string[])}
* [predicates=[_.identity]] The predicates to check.
* @param {...(Function|Function[])} [predicates=[_.identity]]
* The predicates to check.
* @returns {Function} Returns the new function.
* @example
*
@@ -15150,8 +15136,8 @@
* @memberOf _
* @since 4.0.0
* @category Util
* @param {...(Array|Array[]|Function|Function[]|Object|Object[]|string|string[])}
* [predicates=[_.identity]] The predicates to check.
* @param {...(Function|Function[])} [predicates=[_.identity]]
* The predicates to check.
* @returns {Function} Returns the new function.
* @example
*
@@ -15600,8 +15586,7 @@
* @since 4.0.0
* @category Math
* @param {Array} array The array to iterate over.
* @param {Array|Function|Object|string} [iteratee=_.identity]
* The iteratee invoked per element.
* @param {Function} [iteratee=_.identity] The iteratee invoked per element.
* @returns {*} Returns the maximum value.
* @example
*
@@ -15648,8 +15633,7 @@
* @since 4.7.0
* @category Math
* @param {Array} array The array to iterate over.
* @param {Array|Function|Object|string} [iteratee=_.identity]
* The iteratee invoked per element.
* @param {Function} [iteratee=_.identity] The iteratee invoked per element.
* @returns {number} Returns the mean.
* @example
*
@@ -15700,8 +15684,7 @@
* @since 4.0.0
* @category Math
* @param {Array} array The array to iterate over.
* @param {Array|Function|Object|string} [iteratee=_.identity]
* The iteratee invoked per element.
* @param {Function} [iteratee=_.identity] The iteratee invoked per element.
* @returns {*} Returns the minimum value.
* @example
*
@@ -15811,8 +15794,7 @@
* @since 4.0.0
* @category Math
* @param {Array} array The array to iterate over.
* @param {Array|Function|Object|string} [iteratee=_.identity]
* The iteratee invoked per element.
* @param {Function} [iteratee=_.identity] The iteratee invoked per element.
* @returns {number} Returns the sum.
* @example
*