mirror of
https://github.com/whoisclebs/lodash.git
synced 2026-02-10 19:07:49 +00:00
Doc cleanup. [ci skip]
This commit is contained in:
committed by
jdalton
parent
d2e50b09db
commit
f478d916aa
@@ -1312,7 +1312,7 @@
|
|||||||
* @private
|
* @private
|
||||||
* @name has
|
* @name has
|
||||||
* @memberOf _.memoize.Cache
|
* @memberOf _.memoize.Cache
|
||||||
* @param {string} key The name of the entry to check.
|
* @param {string} key The key of the entry to check.
|
||||||
* @returns {boolean} Returns `true` if an entry for `key` exists, else `false`.
|
* @returns {boolean} Returns `true` if an entry for `key` exists, else `false`.
|
||||||
*/
|
*/
|
||||||
function mapHas(key) {
|
function mapHas(key) {
|
||||||
@@ -2489,7 +2489,7 @@
|
|||||||
* @private
|
* @private
|
||||||
* @param {Object} object The destination object.
|
* @param {Object} object The destination object.
|
||||||
* @param {Object} source The source object.
|
* @param {Object} source The source object.
|
||||||
* @param {string} key The key of the property value to merge.
|
* @param {string} key The key of the value to merge.
|
||||||
* @param {Function} mergeFunc The function to merge values.
|
* @param {Function} mergeFunc The function to merge values.
|
||||||
* @param {Function} [customizer] The function to customize merging properties.
|
* @param {Function} [customizer] The function to customize merging properties.
|
||||||
* @param {Array} [stackA=[]] Tracks traversed source objects.
|
* @param {Array} [stackA=[]] Tracks traversed source objects.
|
||||||
@@ -2540,7 +2540,7 @@
|
|||||||
* The base implementation of `_.property` which does not coerce `key` to a string.
|
* The base implementation of `_.property` which does not coerce `key` to a string.
|
||||||
*
|
*
|
||||||
* @private
|
* @private
|
||||||
* @param {string} key The name of the property to get.
|
* @param {string} key The key of the property to get.
|
||||||
* @returns {Function} Returns the new function.
|
* @returns {Function} Returns the new function.
|
||||||
*/
|
*/
|
||||||
function baseProperty(key) {
|
function baseProperty(key) {
|
||||||
@@ -3850,8 +3850,8 @@
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A specialized version of `_.pick` that picks `object` properties
|
* A specialized version of `_.pick` that picks `object` properties specified
|
||||||
* specified by the `props` array.
|
* by the `props` array.
|
||||||
*
|
*
|
||||||
* @private
|
* @private
|
||||||
* @param {Object} object The source object.
|
* @param {Object} object The source object.
|
||||||
@@ -4754,9 +4754,9 @@
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Removes elements from `array` corresponding to the specified indexes and
|
* Removes elements from `array` corresponding to the given indexes and returns
|
||||||
* returns an array of the removed elements. Indexes may be specified as an
|
* an array of the removed elements. Indexes may be specified as an array of
|
||||||
* array of indexes or as individual arguments.
|
* indexes or as individual arguments.
|
||||||
*
|
*
|
||||||
* **Note:** Unlike `_.at`, this method mutates `array`.
|
* **Note:** Unlike `_.at`, this method mutates `array`.
|
||||||
*
|
*
|
||||||
@@ -5544,7 +5544,7 @@
|
|||||||
/*------------------------------------------------------------------------*/
|
/*------------------------------------------------------------------------*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Creates an array of elements corresponding to the specified keys, or indexes,
|
* Creates an array of elements corresponding to the given keys, or indexes,
|
||||||
* of `collection`. Keys may be specified as individual arguments or as arrays
|
* of `collection`. Keys may be specified as individual arguments or as arrays
|
||||||
* of keys.
|
* of keys.
|
||||||
*
|
*
|
||||||
@@ -6207,13 +6207,13 @@
|
|||||||
}, function() { return [[], []]; });
|
}, function() { return [[], []]; });
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Gets the value of a specified property from all elements in `collection`.
|
* Gets the value of `key` from all elements in `collection`.
|
||||||
*
|
*
|
||||||
* @static
|
* @static
|
||||||
* @memberOf _
|
* @memberOf _
|
||||||
* @category Collection
|
* @category Collection
|
||||||
* @param {Array|Object|string} collection The collection to iterate over.
|
* @param {Array|Object|string} collection The collection to iterate over.
|
||||||
* @param {string} key The name of the property to pluck.
|
* @param {string} key The key of the property to pluck.
|
||||||
* @returns {Array} Returns the property values.
|
* @returns {Array} Returns the property values.
|
||||||
* @example
|
* @example
|
||||||
*
|
*
|
||||||
@@ -6865,7 +6865,7 @@
|
|||||||
* Creates a function that accepts one or more arguments of `func` that when
|
* Creates a function that accepts one or more arguments of `func` that when
|
||||||
* called either invokes `func` returning its result, if all `func` arguments
|
* called either invokes `func` returning its result, if all `func` arguments
|
||||||
* have been provided, or returns a function that accepts one or more of the
|
* have been provided, or returns a function that accepts one or more of the
|
||||||
* remaining `func` arguments, and so on. The arity of `func` can be specified
|
* remaining `func` arguments, and so on. The arity of `func` may be specified
|
||||||
* if `func.length` is not sufficient.
|
* if `func.length` is not sufficient.
|
||||||
*
|
*
|
||||||
* The `_.curry.placeholder` value, which defaults to `_` in monolithic builds,
|
* The `_.curry.placeholder` value, which defaults to `_` in monolithic builds,
|
||||||
@@ -8664,14 +8664,14 @@
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Checks if the specified property name exists as a direct property of `object`,
|
* Checks if `key` exists as a direct property of `object` instead of an
|
||||||
* instead of an inherited property.
|
* inherited property.
|
||||||
*
|
*
|
||||||
* @static
|
* @static
|
||||||
* @memberOf _
|
* @memberOf _
|
||||||
* @category Object
|
* @category Object
|
||||||
* @param {Object} object The object to inspect.
|
* @param {Object} object The object to inspect.
|
||||||
* @param {string} key The name of the property to check.
|
* @param {string} key The key to check.
|
||||||
* @returns {boolean} Returns `true` if `key` is a direct property, else `false`.
|
* @returns {boolean} Returns `true` if `key` is a direct property, else `false`.
|
||||||
* @example
|
* @example
|
||||||
*
|
*
|
||||||
@@ -9061,7 +9061,7 @@
|
|||||||
* @memberOf _
|
* @memberOf _
|
||||||
* @category Object
|
* @category Object
|
||||||
* @param {Object} object The object to query.
|
* @param {Object} object The object to query.
|
||||||
* @param {string} key The name of the property to resolve.
|
* @param {string} key The key of the property to resolve.
|
||||||
* @param {*} [defaultValue] The value returned if the property value
|
* @param {*} [defaultValue] The value returned if the property value
|
||||||
* resolves to `undefined`.
|
* resolves to `undefined`.
|
||||||
* @returns {*} Returns the resolved value.
|
* @returns {*} Returns the resolved value.
|
||||||
@@ -9836,7 +9836,7 @@
|
|||||||
|
|
||||||
source += "';\n";
|
source += "';\n";
|
||||||
|
|
||||||
// If `variable` is not specified, wrap a with-statement around the generated
|
// If `variable` is not specified wrap a with-statement around the generated
|
||||||
// code to add the data object to the top of the scope chain.
|
// code to add the data object to the top of the scope chain.
|
||||||
var variable = options.variable;
|
var variable = options.variable;
|
||||||
if (!variable) {
|
if (!variable) {
|
||||||
@@ -10220,9 +10220,9 @@
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Creates a "_.matches" style predicate function which performs a deep comparison
|
* Creates a function which performs a deep comparison between a given object
|
||||||
* between a given object and `source`, returning `true` if the given object
|
* and `source`, returning `true` if the given object has equivalent property
|
||||||
* has equivalent property values, else `false`.
|
* values, else `false`.
|
||||||
*
|
*
|
||||||
* @static
|
* @static
|
||||||
* @memberOf _
|
* @memberOf _
|
||||||
@@ -10366,13 +10366,12 @@
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Creates a "_.property" style function which returns the property value
|
* Creates a function which returns the property value of `key` on a given object.
|
||||||
* of `key` on a given object.
|
|
||||||
*
|
*
|
||||||
* @static
|
* @static
|
||||||
* @memberOf _
|
* @memberOf _
|
||||||
* @category Utility
|
* @category Utility
|
||||||
* @param {string} key The name of the property to get.
|
* @param {string} key The key of the property to get.
|
||||||
* @returns {Function} Returns the new function.
|
* @returns {Function} Returns the new function.
|
||||||
* @example
|
* @example
|
||||||
*
|
*
|
||||||
|
|||||||
Reference in New Issue
Block a user