www.aleph1.co.uk Git - yaffs-website/blob - node_modules/grunt-legacy-util/node_modules/lodash/map.js

   1 var arrayMap = require('./_arrayMap'),
   2     baseIteratee = require('./_baseIteratee'),
   3     baseMap = require('./_baseMap'),
   4     isArray = require('./isArray');
   5
   6 /**
   7  * Creates an array of values by running each element in `collection` through
   8  * `iteratee`. The iteratee is invoked with three arguments:
   9  * (value, index|key, collection).
  10  *
  11  * Many lodash methods are guarded to work as iteratees for methods like
  12  * `_.every`, `_.filter`, `_.map`, `_.mapValues`, `_.reject`, and `_.some`.
  13  *
  14  * The guarded methods are:
  15  * `ary`, `curry`, `curryRight`, `drop`, `dropRight`, `every`, `fill`,
  16  * `invert`, `parseInt`, `random`, `range`, `rangeRight`, `slice`, `some`,
  17  * `sortBy`, `take`, `takeRight`, `template`, `trim`, `trimEnd`, `trimStart`,
  18  * and `words`
  19  *
  20  * @static
  21  * @memberOf _
  22  * @category Collection
  23  * @param {Array|Object} collection The collection to iterate over.
  24  * @param {Function|Object|string} [iteratee=_.identity] The function invoked per iteration.
  25  * @returns {Array} Returns the new mapped array.
  26  * @example
  27  *
  28  * function square(n) {
  29  *   return n * n;
  30  * }
  31  *
  32  * _.map([4, 8], square);
  33  * // => [16, 64]
  34  *
  35  * _.map({ 'a': 4, 'b': 8 }, square);
  36  * // => [16, 64] (iteration order is not guaranteed)
  37  *
  38  * var users = [
  39  *   { 'user': 'barney' },
  40  *   { 'user': 'fred' }
  41  * ];
  42  *
  43  * // The `_.property` iteratee shorthand.
  44  * _.map(users, 'user');
  45  * // => ['barney', 'fred']
  46  */
  47 function map(collection, iteratee) {
  48   var func = isArray(collection) ? arrayMap : baseMap;
  49   return func(collection, baseIteratee(iteratee, 3));
  50 }
  51
  52 module.exports = map;