You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
38 lines
1.3 KiB
JavaScript
38 lines
1.3 KiB
JavaScript
var arrayEach = require('../internal/arrayEach'),
|
|
baseEach = require('../internal/baseEach'),
|
|
createForEach = require('../internal/createForEach');
|
|
|
|
/**
|
|
* Iterates over elements of `collection` invoking `iteratee` for each element.
|
|
* The `iteratee` is bound to `thisArg` and invoked with three arguments:
|
|
* (value, index|key, collection). Iteratee functions may exit iteration early
|
|
* by explicitly returning `false`.
|
|
*
|
|
* **Note:** As with other "Collections" methods, objects with a "length" property
|
|
* are iterated like arrays. To avoid this behavior `_.forIn` or `_.forOwn`
|
|
* may be used for object iteration.
|
|
*
|
|
* @static
|
|
* @memberOf _
|
|
* @alias each
|
|
* @category Collection
|
|
* @param {Array|Object|string} collection The collection to iterate over.
|
|
* @param {Function} [iteratee=_.identity] The function invoked per iteration.
|
|
* @param {*} [thisArg] The `this` binding of `iteratee`.
|
|
* @returns {Array|Object|string} Returns `collection`.
|
|
* @example
|
|
*
|
|
* _([1, 2]).forEach(function(n) {
|
|
* console.log(n);
|
|
* }).value();
|
|
* // => logs each value from left to right and returns the array
|
|
*
|
|
* _.forEach({ 'a': 1, 'b': 2 }, function(n, key) {
|
|
* console.log(n, key);
|
|
* });
|
|
* // => logs each value-key pair and returns the object (iteration order is not guaranteed)
|
|
*/
|
|
var forEach = createForEach(arrayEach, baseEach);
|
|
|
|
module.exports = forEach;
|