Lo-Dash ^v1.2.0

`Arrays`

_.compact
_.difference
_.drop
_.findIndex
_.first
_.flatten
_.head
_.indexOf
_.initial
_.intersection
_.last
_.lastIndexOf
_.object
_.range
_.rest
_.sortedIndex
_.tail
_.take
_.union
_.uniq
_.unique
_.unzip
_.without
_.zip
_.zipObject

`Chaining`

_
_.tap
_.prototype.toString
_.prototype.value
_.prototype.valueOf

`Collections`

_.all
_.any
_.at
_.collect
_.contains
_.countBy
_.detect
_.each
_.every
_.filter
_.find
_.foldl
_.foldr
_.forEach
_.groupBy
_.include
_.inject
_.invoke
_.map
_.max
_.min
_.pluck
_.reduce
_.reduceRight
_.reject
_.select
_.shuffle
_.size
_.some
_.sortBy
_.toArray
_.where

`Functions`

_.after
_.bind
_.bindAll
_.bindKey
_.compose
_.createCallback
_.debounce
_.defer
_.delay
_.memoize
_.once
_.partial
_.partialRight
_.throttle
_.wrap

`Objects`

_.assign
_.clone
_.cloneDeep
_.defaults
_.extend
_.findKey
_.forIn
_.forOwn
_.functions
_.has
_.invert
_.isArguments
_.isArray
_.isBoolean
_.isDate
_.isElement
_.isEmpty
_.isEqual
_.isFinite
_.isFunction
_.isNaN
_.isNull
_.isNumber
_.isObject
_.isPlainObject
_.isRegExp
_.isString
_.isUndefined
_.keys
_.merge
_.methods
_.omit
_.pairs
_.pick
_.values

`Utilities`

_.escape
_.identity
_.mixin
_.noConflict
_.parseInt
_.random
_.result
_.runInContext
_.template
_.times
_.unescape
_.uniqueId

`Methods`

_.templateSettings.imports._

`Properties`

_.VERSION
_.support
_.support.argsClass
_.support.argsObject
_.support.enumPrototypes
_.support.fastBind
_.support.nonEnumArgs
_.support.nonEnumShadows
_.support.ownLast
_.support.spliceObjects
_.support.unindexedChars
_.templateSettings
_.templateSettings.escape
_.templateSettings.evaluate
_.templateSettings.interpolate
_.templateSettings.variable
_.templateSettings.imports

`“Arrays” Methods`

`_.compact(array)`

# Ⓢ Ⓣ

Creates an array with all falsey values of array removed. The values false, null, 0, "", undefined and NaN are all falsey.

Arguments

array (Array): The array to compact.

Returns

(Array): Returns a new filtered array.

Example

_.compact([0, 1, false, 2, '', 3]);
// => [1, 2, 3]

`_.difference(array [, array1, array2, ...])`

# Ⓢ Ⓣ

Creates an array of array elements not present in the other arrays using strict equality for comparisons, i.e. ===.

Arguments

array (Array): The array to process.
[array1, array2, ...] (Array): Arrays to check.

Returns

(Array): Returns a new array of array elements not present in the other arrays.

Example

_.difference([1, 2, 3, 4, 5], [5, 2, 10]);
// => [1, 3, 4]

`_.findIndex(array [, callback=identity, thisArg])`

# Ⓢ Ⓣ

This method is similar to _.find, except that it returns the index of the element that passes the callback check, instead of the element itself.

Arguments

array (Array): The array to search.
[callback=identity] (Function|Object|String): The function called per iteration. If a property name or object is passed, it will be used to create a ".pluck" or ".where" style callback, respectively.
[thisArg] (Mixed): The this binding of callback.

Returns

(Mixed): Returns the index of the found element, else -1.

Example

_.findIndex(['apple', 'banana', 'beet'], function(food) {
  return /^b/.test(food);
});
// => 1

`_.first(array [, callback|n, thisArg])`

# Ⓢ Ⓣ

Gets the first element of the array. If a number n is passed, the first n elements of the array are returned. If a callback function is passed, elements at the beginning of the array are returned as long as the callback returns truthy. The callback is bound to thisArg and invoked with three arguments; (value, index, array).

If a property name is passed for callback, the created "_.pluck" style callback will return the property value of the given element.

If an object is passed for callback, the created "_.where" style callback will return true for elements that have the properties of the given object, else false.

Aliases

head, take

Arguments

array (Array): The array to query.
[callback|n] (Function|Object|Number|String): The function called per element or the number of elements to return. If a property name or object is passed, it will be used to create a ".pluck" or ".where" style callback, respectively.
[thisArg] (Mixed): The this binding of callback.

Returns

(Mixed): Returns the first element(s) of array.

Example

_.first([1, 2, 3]);
// => 1

_.first([1, 2, 3], 2);
// => [1, 2]

_.first([1, 2, 3], function(num) {
  return num < 3;
});
// => [1, 2]

var food = [
  { 'name': 'banana', 'organic': true },
  { 'name': 'beet',   'organic': false },
];

// using "_.pluck" callback shorthand
_.first(food, 'organic');
// => [{ 'name': 'banana', 'organic': true }]

var food = [
  { 'name': 'apple',  'type': 'fruit' },
  { 'name': 'banana', 'type': 'fruit' },
  { 'name': 'beet',   'type': 'vegetable' }
];

// using "_.where" callback shorthand
_.first(food, { 'type': 'fruit' });
// => [{ 'name': 'apple', 'type': 'fruit' }, { 'name': 'banana', 'type': 'fruit' }]

`_.flatten(array [, isShallow=false, callback=identity, thisArg])`

# Ⓢ Ⓣ

Flattens a nested array (the nesting can be to any depth). If isShallow is truthy, array will only be flattened a single level. If callback is passed, each element of array is passed through a callbackbefore flattening. Thecallbackis bound tothisArg` and invoked with three arguments; (value, index, array).

If a property name is passed for callback, the created "_.pluck" style callback will return the property value of the given element.

If an object is passed for callback, the created "_.where" style callback will return true for elements that have the properties of the given object, else false.

Arguments

array (Array): The array to flatten.
[isShallow=false] (Boolean): A flag to indicate only flattening a single level.
[callback=identity] (Function|Object|String): The function called per iteration. If a property name or object is passed, it will be used to create a ".pluck" or ".where" style callback, respectively.
[thisArg] (Mixed): The this binding of callback.

Returns

(Array): Returns a new flattened array.

Example

_.flatten([1, [2], [3, [[4]]]]);
// => [1, 2, 3, 4];

_.flatten([1, [2], [3, [[4]]]], true);
// => [1, 2, 3, [[4]]];

var stooges = [
  { 'name': 'curly', 'quotes': ['Oh, a wise guy, eh?', 'Poifect!'] },
  { 'name': 'moe', 'quotes': ['Spread out!', 'You knucklehead!'] }
];

// using "_.pluck" callback shorthand
_.flatten(stooges, 'quotes');
// => ['Oh, a wise guy, eh?', 'Poifect!', 'Spread out!', 'You knucklehead!']

`_.indexOf(array, value [, fromIndex=0])`

# Ⓢ Ⓣ

Gets the index at which the first occurrence of value is found using strict equality for comparisons, i.e. ===. If the array is already sorted, passing true for fromIndex will run a faster binary search.

Arguments

array (Array): The array to search.
value (Mixed): The value to search for.
[fromIndex=0] (Boolean|Number): The index to search from or true to perform a binary search on a sorted array.

Returns

(Number): Returns the index of the matched value or -1.

Example

_.indexOf([1, 2, 3, 1, 2, 3], 2);
// => 1

_.indexOf([1, 2, 3, 1, 2, 3], 2, 3);
// => 4

_.indexOf([1, 1, 2, 2, 3, 3], 2, true);
// => 2

`_.initial(array [, callback|n=1, thisArg])`

# Ⓢ Ⓣ

Gets all but the last element of array. If a number n is passed, the last n elements are excluded from the result. If a callback function is passed, elements at the end of the array are excluded from the result as long as the callback returns truthy. The callback is bound to thisArg and invoked with three arguments; (value, index, array).

If a property name is passed for callback, the created "_.pluck" style callback will return the property value of the given element.

If an object is passed for callback, the created "_.where" style callback will return true for elements that have the properties of the given object, else false.

Arguments

array (Array): The array to query.
[callback|n=1] (Function|Object|Number|String): The function called per element or the number of elements to exclude. If a property name or object is passed, it will be used to create a ".pluck" or ".where" style callback, respectively.
[thisArg] (Mixed): The this binding of callback.

Returns

(Array): Returns a slice of array.

Example

_.initial([1, 2, 3]);
// => [1, 2]

_.initial([1, 2, 3], 2);
// => [1]

_.initial([1, 2, 3], function(num) {
  return num > 1;
});
// => [1]

var food = [
  { 'name': 'beet',   'organic': false },
  { 'name': 'carrot', 'organic': true }
];

// using "_.pluck" callback shorthand
_.initial(food, 'organic');
// => [{ 'name': 'beet',   'organic': false }]

var food = [
  { 'name': 'banana', 'type': 'fruit' },
  { 'name': 'beet',   'type': 'vegetable' },
  { 'name': 'carrot', 'type': 'vegetable' }
];

// using "_.where" callback shorthand
_.initial(food, { 'type': 'vegetable' });
// => [{ 'name': 'banana', 'type': 'fruit' }]

`_.intersection([array1, array2, ...])`

# Ⓢ Ⓣ

Computes the intersection of all the passed-in arrays using strict equality for comparisons, i.e. ===.

Arguments

[array1, array2, ...] (Array): Arrays to process.

Returns

(Array): Returns a new array of unique elements that are present in all of the arrays.

Example

_.intersection([1, 2, 3], [101, 2, 1, 10], [2, 1]);
// => [1, 2]

`_.last(array [, callback|n, thisArg])`

# Ⓢ Ⓣ

Gets the last element of the array. If a number n is passed, the last n elements of the array are returned. If a callback function is passed, elements at the end of the array are returned as long as the callback returns truthy. The callback is bound to thisArg and invoked with three arguments;(value, index, array).

If a property name is passed for callback, the created "_.pluck" style callback will return the property value of the given element.

If an object is passed for callback, the created "_.where" style callback will return true for elements that have the properties of the given object, else false.

Arguments

array (Array): The array to query.
[callback|n] (Function|Object|Number|String): The function called per element or the number of elements to return. If a property name or object is passed, it will be used to create a ".pluck" or ".where" style callback, respectively.
[thisArg] (Mixed): The this binding of callback.

Returns

(Mixed): Returns the last element(s) of array.

Example

_.last([1, 2, 3]);
// => 3

_.last([1, 2, 3], 2);
// => [2, 3]

_.last([1, 2, 3], function(num) {
  return num > 1;
});
// => [2, 3]

var food = [
  { 'name': 'beet',   'organic': false },
  { 'name': 'carrot', 'organic': true }
];

// using "_.pluck" callback shorthand
_.last(food, 'organic');
// => [{ 'name': 'carrot', 'organic': true }]

var food = [
  { 'name': 'banana', 'type': 'fruit' },
  { 'name': 'beet',   'type': 'vegetable' },
  { 'name': 'carrot', 'type': 'vegetable' }
];

// using "_.where" callback shorthand
_.last(food, { 'type': 'vegetable' });
// => [{ 'name': 'beet', 'type': 'vegetable' }, { 'name': 'carrot', 'type': 'vegetable' }]

`_.lastIndexOf(array, value [, fromIndex=array.length-1])`

# Ⓢ Ⓣ

Gets the index at which the last occurrence of value is found using strict equality for comparisons, i.e. ===. If fromIndex is negative, it is used as the offset from the end of the collection.

Arguments

array (Array): The array to search.
value (Mixed): The value to search for.
[fromIndex=array.length-1] (Number): The index to search from.

Returns

(Number): Returns the index of the matched value or -1.

Example

_.lastIndexOf([1, 2, 3, 1, 2, 3], 2);
// => 4

_.lastIndexOf([1, 2, 3, 1, 2, 3], 2, 3);
// => 1

`_.range([start=0], end [, step=1])`

# Ⓢ Ⓣ

Creates an array of numbers (positive and/or negative) progressing from start up to but not including end.

Arguments

[start=0] (Number): The start of the range.
end (Number): The end of the range.
[step=1] (Number): The value to increment or decrement by.

Returns

(Array): Returns a new range array.

Example

_.range(10);
// => [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]

_.range(1, 11);
// => [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]

_.range(0, 30, 5);
// => [0, 5, 10, 15, 20, 25]

_.range(0, -10, -1);
// => [0, -1, -2, -3, -4, -5, -6, -7, -8, -9]

_.range(0);
// => []

`_.rest(array [, callback|n=1, thisArg])`

# Ⓢ Ⓣ

The opposite of _.initial, this method gets all but the first value of array. If a number n is passed, the first n values are excluded from the result. If a callback function is passed, elements at the beginning of the array are excluded from the result as long as the callback returns truthy. The callback is bound to thisArg and invoked with three arguments; (value, index, array).

If a property name is passed for callback, the created "_.pluck" style callback will return the property value of the given element.

If an object is passed for callback, the created "_.where" style callback will return true for elements that have the properties of the given object, else false.

Aliases

drop, tail

Arguments

array (Array): The array to query.
[callback|n=1] (Function|Object|Number|String): The function called per element or the number of elements to exclude. If a property name or object is passed, it will be used to create a ".pluck" or ".where" style callback, respectively.
[thisArg] (Mixed): The this binding of callback.

Returns

(Array): Returns a slice of array.

Example

_.rest([1, 2, 3]);
// => [2, 3]

_.rest([1, 2, 3], 2);
// => [3]

_.rest([1, 2, 3], function(num) {
  return num < 3;
});
// => [3]

var food = [
  { 'name': 'banana', 'organic': true },
  { 'name': 'beet',   'organic': false },
];

// using "_.pluck" callback shorthand
_.rest(food, 'organic');
// => [{ 'name': 'beet', 'organic': false }]

var food = [
  { 'name': 'apple',  'type': 'fruit' },
  { 'name': 'banana', 'type': 'fruit' },
  { 'name': 'beet',   'type': 'vegetable' }
];

// using "_.where" callback shorthand
_.rest(food, { 'type': 'fruit' });
// => [{ 'name': 'beet', 'type': 'vegetable' }]

`_.sortedIndex(array, value [, callback=identity, thisArg])`

# Ⓢ Ⓣ

Uses a binary search to determine the smallest index at which the value should be inserted into array in order to maintain the sort order of the sorted array. If callback is passed, it will be executed for value and each element in array to compute their sort ranking. The callback is bound to thisArg and invoked with one argument; (value).

If a property name is passed for callback, the created "_.pluck" style callback will return the property value of the given element.

If an object is passed for callback, the created "_.where" style callback will return true for elements that have the properties of the given object, else false.

Arguments

array (Array): The array to inspect.
value (Mixed): The value to evaluate.
[callback=identity] (Function|Object|String): The function called per iteration. If a property name or object is passed, it will be used to create a ".pluck" or ".where" style callback, respectively.
[thisArg] (Mixed): The this binding of callback.

Returns

(Number): Returns the index at which the value should be inserted into array.

Example

_.sortedIndex([20, 30, 50], 40);
// => 2

// using "_.pluck" callback shorthand
_.sortedIndex([{ 'x': 20 }, { 'x': 30 }, { 'x': 50 }], { 'x': 40 }, 'x');
// => 2

var dict = {
  'wordToNumber': { 'twenty': 20, 'thirty': 30, 'fourty': 40, 'fifty': 50 }
};

_.sortedIndex(['twenty', 'thirty', 'fifty'], 'fourty', function(word) {
  return dict.wordToNumber[word];
});
// => 2

_.sortedIndex(['twenty', 'thirty', 'fifty'], 'fourty', function(word) {
  return this.wordToNumber[word];
}, dict);
// => 2

`_.union([array1, array2, ...])`

# Ⓢ Ⓣ

Computes the union of the passed-in arrays using strict equality for comparisons, i.e. ===.

Arguments

[array1, array2, ...] (Array): Arrays to process.

Returns

(Array): Returns a new array of unique values, in order, that are present in one or more of the arrays.

Example

_.union([1, 2, 3], [101, 2, 1, 10], [2, 1]);
// => [1, 2, 3, 101, 10]

`_.uniq(array [, isSorted=false, callback=identity, thisArg])`

# Ⓢ Ⓣ

Creates a duplicate-value-free version of the array using strict equality for comparisons, i.e. ===. If the array is already sorted, passing true for isSorted will run a faster algorithm. If callback is passed, each element of array is passed through a callbackbefore uniqueness is computed. Thecallbackis bound tothisArg` and invoked with three arguments; (value, index, array).

If a property name is passed for callback, the created "_.pluck" style callback will return the property value of the given element.

If an object is passed for callback, the created "_.where" style callback will return true for elements that have the properties of the given object, else false.

Aliases

unique

Arguments

array (Array): The array to process.
[isSorted=false] (Boolean): A flag to indicate that the array is already sorted.
[callback=identity] (Function|Object|String): The function called per iteration. If a property name or object is passed, it will be used to create a ".pluck" or ".where" style callback, respectively.
[thisArg] (Mixed): The this binding of callback.

Returns

(Array): Returns a duplicate-value-free array.

Example

_.uniq([1, 2, 1, 3, 1]);
// => [1, 2, 3]

_.uniq([1, 1, 2, 2, 3], true);
// => [1, 2, 3]

_.uniq([1, 2, 1.5, 3, 2.5], function(num) { return Math.floor(num); });
// => [1, 2, 3]

_.uniq([1, 2, 1.5, 3, 2.5], function(num) { return this.floor(num); }, Math);
// => [1, 2, 3]

// using "_.pluck" callback shorthand
_.uniq([{ 'x': 1 }, { 'x': 2 }, { 'x': 1 }], 'x');
// => [{ 'x': 1 }, { 'x': 2 }]

`_.unzip(array)`

# Ⓢ Ⓣ

The inverse of _.zip, this method splits groups of elements into arrays composed of elements from each group at their corresponding indexes.

Arguments

array (Array): The array to process.

Returns

(Array): Returns a new array of the composed arrays.

Example

_.unzip([['moe', 30, true], ['larry', 40, false]]);
// => [['moe', 'larry'], [30, 40], [true, false]];

`_.without(array [, value1, value2, ...])`

# Ⓢ Ⓣ

Creates an array with all occurrences of the passed values removed using strict equality for comparisons, i.e. ===.

Arguments

array (Array): The array to filter.
[value1, value2, ...] (Mixed): Values to remove.

Returns

(Array): Returns a new filtered array.

Example

_.without([1, 2, 1, 0, 3, 1, 4], 0, 1);
// => [2, 3, 4]

`_.zip([array1, array2, ...])`

# Ⓢ Ⓣ

Groups the elements of each array at their corresponding indexes. Useful for separate data sources that are coordinated through matching array indexes. For a matrix of nested arrays, _.zip.apply(...) can transpose the matrix in a similar fashion.

Arguments

[array1, array2, ...] (Array): Arrays to process.

Returns

(Array): Returns a new array of grouped elements.

Example

_.zip(['moe', 'larry'], [30, 40], [true, false]);
// => [['moe', 30, true], ['larry', 40, false]]

`_.zipObject(keys [, values=[]])`

# Ⓢ Ⓣ

Creates an object composed from arrays of keys and values. Pass either a single two dimensional array, i.e. [[key1, value1], [key2, value2]], or two arrays, one of keys and one of corresponding values.

Aliases

object

Arguments

keys (Array): The array of keys.
[values=[]] (Array): The array of values.

Returns

(Object): Returns an object composed of the given keys and corresponding values.

Example

_.zipObject(['moe', 'larry'], [30, 40]);
// => { 'moe': 30, 'larry': 40 }

`“Chaining” Methods`

`_(value)`

# Ⓢ Ⓣ

Creates a lodash object, which wraps the given value, to enable method chaining.

In addition to Lo-Dash methods, wrappers also have the following Array methods:
concat, join, pop, push, reverse, shift, slice, sort, splice, and unshift

Chaining is supported in custom builds as long as the value method is implicitly or explicitly included in the build.

The chainable wrapper functions are:
after, assign, bind, bindAll, bindKey, chain, compact, compose, concat, countBy, createCallback, debounce, defaults, defer, delay, difference, filter, flatten, forEach, forIn, forOwn, functions, groupBy, initial, intersection, invert, invoke, keys, map, max, memoize, merge, min, object, omit, once, pairs, partial, partialRight, pick, pluck, push, range, reject, rest, reverse, shuffle, slice, sort, sortBy, splice, tap, throttle, times, toArray, union, uniq, unshift, unzip, values, where, without, wrap, and zip

The non-chainable wrapper functions are:
clone, cloneDeep, contains, escape, every, find, has, identity, indexOf, isArguments, isArray, isBoolean, isDate, isElement, isEmpty, isEqual, isFinite, isFunction, isNaN, isNull, isNumber, isObject, isPlainObject, isRegExp, isString, isUndefined, join, lastIndexOf, mixin, noConflict, parseInt, pop, random, reduce, reduceRight, result, shift, size, some, sortedIndex, runInContext, template, unescape, uniqueId, and value

The wrapper functions first and last return wrapped values when n is passed, otherwise they return unwrapped values.

Arguments

value (Mixed): The value to wrap in a lodash instance.

Returns

(Object): Returns a lodash instance.

Example

var wrapped = _([1, 2, 3]);

// returns an unwrapped value
wrapped.reduce(function(sum, num) {
  return sum + num;
});
// => 6

// returns a wrapped value
var squares = wrapped.map(function(num) {
  return num * num;
});

_.isArray(squares);
// => false

_.isArray(squares.value());
// => true

`_.tap(value, interceptor)`

# Ⓢ Ⓣ

Invokes interceptor with the value as the first argument, and then returns value. The purpose of this method is to "tap into" a method chain, in order to perform operations on intermediate results within the chain.

Arguments

value (Mixed): The value to pass to interceptor.
interceptor (Function): The function to invoke.

Returns

(Mixed): Returns value.

Example

_([1, 2, 3, 4])
 .filter(function(num) { return num % 2 == 0; })
 .tap(alert)
 .map(function(num) { return num * num; })
 .value();
// => // [2, 4] (alerted)
// => [4, 16]

`_.prototype.toString()`

# Ⓢ Ⓣ

Produces the toString result of the wrapped value.

Returns

(String): Returns the string result.

Example

_([1, 2, 3]).toString();
// => '1,2,3'

`_.prototype.valueOf()`

# Ⓢ Ⓣ

Extracts the wrapped value.

Aliases

value

Returns

(Mixed): Returns the wrapped value.

Example

_([1, 2, 3]).valueOf();
// => [1, 2, 3]

`“Collections” Methods`

`_.at(collection [, index1, index2, ...])`

# Ⓢ Ⓣ

Creates an array of elements from the specified indexes, or keys, of the collection. Indexes may be specified as individual arguments or as arrays of indexes.

Arguments

collection (Array|Object|String): The collection to iterate over.
[index1, index2, ...] (Array|Number|String): The indexes of collection to retrieve, either as individual arguments or arrays.

Returns

(Array): Returns a new array of elements corresponding to the provided indexes.

Example

_.at(['a', 'b', 'c', 'd', 'e'], [0, 2, 4]);
// => ['a', 'c', 'e']

_.at(['moe', 'larry', 'curly'], 0, 2);
// => ['moe', 'curly']

`_.contains(collection, target [, fromIndex=0])`

# Ⓢ Ⓣ

Checks if a given target element is present in a collection using strict equality for comparisons, i.e. ===. If fromIndex is negative, it is used as the offset from the end of the collection.

Aliases

include

Arguments

collection (Array|Object|String): The collection to iterate over.
target (Mixed): The value to check for.
[fromIndex=0] (Number): The index to search from.

Returns

(Boolean): Returns true if the target element is found, else false.

Example

_.contains([1, 2, 3], 1);
// => true

_.contains([1, 2, 3], 1, 2);
// => false

_.contains({ 'name': 'moe', 'age': 40 }, 'moe');
// => true

_.contains('curly', 'ur');
// => true

`_.countBy(collection [, callback=identity, thisArg])`

# Ⓢ Ⓣ

Creates an object composed of keys returned from running each element of the collection through the given callback. The corresponding value of each key is the number of times the key was returned by the callback. The callback is bound to thisArg and invoked with three arguments; (value, index|key, collection).

If a property name is passed for callback, the created "_.pluck" style callback will return the property value of the given element.

If an object is passed for callback, the created "_.where" style callback will return true for elements that have the properties of the given object, else false.

Arguments

collection (Array|Object|String): The collection to iterate over.
[callback=identity] (Function|Object|String): The function called per iteration. If a property name or object is passed, it will be used to create a ".pluck" or ".where" style callback, respectively.
[thisArg] (Mixed): The this binding of callback.

Returns

(Object): Returns the composed aggregate object.

Example

_.countBy([4.3, 6.1, 6.4], function(num) { return Math.floor(num); });
// => { '4': 1, '6': 2 }

_.countBy([4.3, 6.1, 6.4], function(num) { return this.floor(num); }, Math);
// => { '4': 1, '6': 2 }

_.countBy(['one', 'two', 'three'], 'length');
// => { '3': 2, '5': 1 }

`_.every(collection [, callback=identity, thisArg])`

# Ⓢ Ⓣ

Checks if the callback returns a truthy value for all elements of a collection. The callback is bound to thisArg and invoked with three arguments; (value, index|key, collection).

If a property name is passed for callback, the created "_.pluck" style callback will return the property value of the given element.

If an object is passed for callback, the created "_.where" style callback will return true for elements that have the properties of the given object, else false.

Aliases

all

Arguments

collection (Array|Object|String): The collection to iterate over.
[callback=identity] (Function|Object|String): The function called per iteration. If a property name or object is passed, it will be used to create a ".pluck" or ".where" style callback, respectively.
[thisArg] (Mixed): The this binding of callback.

Returns

(Boolean): Returns true if all elements pass the callback check, else false.

Example

_.every([true, 1, null, 'yes'], Boolean);
// => false

var stooges = [
  { 'name': 'moe', 'age': 40 },
  { 'name': 'larry', 'age': 50 }
];

// using "_.pluck" callback shorthand
_.every(stooges, 'age');
// => true

// using "_.where" callback shorthand
_.every(stooges, { 'age': 50 });
// => false

`_.filter(collection [, callback=identity, thisArg])`

# Ⓢ Ⓣ

Examines each element in a collection, returning an array of all elements the callback returns truthy for. The callback is bound to thisArg and invoked with three arguments; (value, index|key, collection).

If a property name is passed for callback, the created "_.pluck" style callback will return the property value of the given element.

If an object is passed for callback, the created "_.where" style callback will return true for elements that have the properties of the given object, else false.

Aliases

select

Arguments

collection (Array|Object|String): The collection to iterate over.
[callback=identity] (Function|Object|String): The function called per iteration. If a property name or object is passed, it will be used to create a ".pluck" or ".where" style callback, respectively.
[thisArg] (Mixed): The this binding of callback.

Returns

(Array): Returns a new array of elements that passed the callback check.

Example

var evens = _.filter([1, 2, 3, 4, 5, 6], function(num) { return num % 2 == 0; });
// => [2, 4, 6]

var food = [
  { 'name': 'apple',  'organic': false, 'type': 'fruit' },
  { 'name': 'carrot', 'organic': true,  'type': 'vegetable' }
];

// using "_.pluck" callback shorthand
_.filter(food, 'organic');
// => [{ 'name': 'carrot', 'organic': true, 'type': 'vegetable' }]

// using "_.where" callback shorthand
_.filter(food, { 'type': 'fruit' });
// => [{ 'name': 'apple', 'organic': false, 'type': 'fruit' }]

`_.find(collection [, callback=identity, thisArg])`

# Ⓢ Ⓣ

Examines each element in a collection, returning the first that the callback returns truthy for. The callback is bound to thisArg and invoked with three arguments; (value, index|key, collection).

If a property name is passed for callback, the created "_.pluck" style callback will return the property value of the given element.

If an object is passed for callback, the created "_.where" style callback will return true for elements that have the properties of the given object, else false.

Aliases

detect

Arguments

collection (Array|Object|String): The collection to iterate over.
[callback=identity] (Function|Object|String): The function called per iteration. If a property name or object is passed, it will be used to create a ".pluck" or ".where" style callback, respectively.
[thisArg] (Mixed): The this binding of callback.

Returns

(Mixed): Returns the found element, else undefined.

Example

_.find([1, 2, 3, 4], function(num) {
  return num % 2 == 0;
});
// => 2

var food = [
  { 'name': 'apple',  'organic': false, 'type': 'fruit' },
  { 'name': 'banana', 'organic': true,  'type': 'fruit' },
  { 'name': 'beet',   'organic': false, 'type': 'vegetable' }
];

// using "_.where" callback shorthand
_.find(food, { 'type': 'vegetable' });
// => { 'name': 'beet', 'organic': false, 'type': 'vegetable' }

// using "_.pluck" callback shorthand
_.find(food, 'organic');
// => { 'name': 'banana', 'organic': true, 'type': 'fruit' }

`_.forEach(collection [, callback=identity, thisArg])`

# Ⓢ Ⓣ

Iterates over a collection, executing the callback for each element in the collection. The callback is bound to thisArg and invoked with three arguments; (value, index|key, collection). Callbacks may exit iteration early by explicitly returning false.

Aliases

each

Arguments

collection (Array|Object|String): The collection to iterate over.
[callback=identity] (Function): The function called per iteration.
[thisArg] (Mixed): The this binding of callback.

Returns

(Array, Object, String): Returns collection.

Example

_([1, 2, 3]).forEach(alert).join(',');
// => alerts each number and returns '1,2,3'

_.forEach({ 'one': 1, 'two': 2, 'three': 3 }, alert);
// => alerts each number value (order is not guaranteed)

`_.groupBy(collection [, callback=identity, thisArg])`

# Ⓢ Ⓣ

Creates an object composed of keys returned from running each element of the collection through the callback. The corresponding value of each key is an array of elements passed to callback that returned the key. The callback is bound to thisArg and invoked with three arguments; (value, index|key, collection).

If a property name is passed for callback, the created "_.pluck" style callback will return the property value of the given element.

If an object is passed for callback, the created "_.where" style callback will return true for elements that have the properties of the given object, else false

Arguments

collection (Array|Object|String): The collection to iterate over.
[callback=identity] (Function|Object|String): The function called per iteration. If a property name or object is passed, it will be used to create a ".pluck" or ".where" style callback, respectively.
[thisArg] (Mixed): The this binding of callback.

Returns

(Object): Returns the composed aggregate object.

Example

_.groupBy([4.2, 6.1, 6.4], function(num) { return Math.floor(num); });
// => { '4': [4.2], '6': [6.1, 6.4] }

_.groupBy([4.2, 6.1, 6.4], function(num) { return this.floor(num); }, Math);
// => { '4': [4.2], '6': [6.1, 6.4] }

// using "_.pluck" callback shorthand
_.groupBy(['one', 'two', 'three'], 'length');
// => { '3': ['one', 'two'], '5': ['three'] }

`_.invoke(collection, methodName [, arg1, arg2, ...])`

# Ⓢ Ⓣ

Invokes the method named by methodName on each element in the collection, returning an array of the results of each invoked method. Additional arguments will be passed to each invoked method. If methodName is a function, it will be invoked for, and this bound to, each element in the collection.

Arguments

collection (Array|Object|String): The collection to iterate over.
methodName (Function|String): The name of the method to invoke or the function invoked per iteration.
[arg1, arg2, ...] (Mixed): Arguments to invoke the method with.

Returns

(Array): Returns a new array of the results of each invoked method.

Example

_.invoke([[5, 1, 7], [3, 2, 1]], 'sort');
// => [[1, 5, 7], [1, 2, 3]]

_.invoke([123, 456], String.prototype.split, '');
// => [['1', '2', '3'], ['4', '5', '6']]

`_.map(collection [, callback=identity, thisArg])`

# Ⓢ Ⓣ

Creates an array of values by running each element in the collection through the callback. The callback is bound to thisArg and invoked with three arguments; (value, index|key, collection).

If a property name is passed for callback, the created "_.pluck" style callback will return the property value of the given element.

If an object is passed for callback, the created "_.where" style callback will return true for elements that have the properties of the given object, else false.

Aliases

collect

Arguments

collection (Array|Object|String): The collection to iterate over.
[callback=identity] (Function|Object|String): The function called per iteration. If a property name or object is passed, it will be used to create a ".pluck" or ".where" style callback, respectively.
[thisArg] (Mixed): The this binding of callback.

Returns

(Array): Returns a new array of the results of each callback execution.

Example

_.map([1, 2, 3], function(num) { return num * 3; });
// => [3, 6, 9]

_.map({ 'one': 1, 'two': 2, 'three': 3 }, function(num) { return num * 3; });
// => [3, 6, 9] (order is not guaranteed)

var stooges = [
  { 'name': 'moe', 'age': 40 },
  { 'name': 'larry', 'age': 50 }
];

// using "_.pluck" callback shorthand
_.map(stooges, 'name');
// => ['moe', 'larry']

`_.max(collection [, callback=identity, thisArg])`

# Ⓢ Ⓣ

Retrieves the maximum value of an array. If callback is passed, it will be executed for each value in the array to generate the criterion by which the value is ranked. The callback is bound to thisArg and invoked with three arguments; (value, index, collection).

If a property name is passed for callback, the created "_.pluck" style callback will return the property value of the given element.

If an object is passed for callback, the created "_.where" style callback will return true for elements that have the properties of the given object, else false.

Arguments

collection (Array|Object|String): The collection to iterate over.
[callback=identity] (Function|Object|String): The function called per iteration. If a property name or object is passed, it will be used to create a ".pluck" or ".where" style callback, respectively.
[thisArg] (Mixed): The this binding of callback.

Returns

(Mixed): Returns the maximum value.

Example

_.max([4, 2, 8, 6]);
// => 8

var stooges = [
  { 'name': 'moe', 'age': 40 },
  { 'name': 'larry', 'age': 50 }
];

_.max(stooges, function(stooge) { return stooge.age; });
// => { 'name': 'larry', 'age': 50 };

// using "_.pluck" callback shorthand
_.max(stooges, 'age');
// => { 'name': 'larry', 'age': 50 };

`_.min(collection [, callback=identity, thisArg])`

# Ⓢ Ⓣ

Retrieves the minimum value of an array. If callback is passed, it will be executed for each value in the array to generate the criterion by which the value is ranked. The callback is bound to thisArg and invoked with three arguments; (value, index, collection).

If a property name is passed for callback, the created "_.pluck" style callback will return the property value of the given element.

If an object is passed for callback, the created "_.where" style callback will return true for elements that have the properties of the given object, else false.

Arguments

collection (Array|Object|String): The collection to iterate over.
[callback=identity] (Function|Object|String): The function called per iteration. If a property name or object is passed, it will be used to create a ".pluck" or ".where" style callback, respectively.
[thisArg] (Mixed): The this binding of callback.

Returns

(Mixed): Returns the minimum value.

Example

_.min([4, 2, 8, 6]);
// => 2

var stooges = [
  { 'name': 'moe', 'age': 40 },
  { 'name': 'larry', 'age': 50 }
];

_.min(stooges, function(stooge) { return stooge.age; });
// => { 'name': 'moe', 'age': 40 };

// using "_.pluck" callback shorthand
_.min(stooges, 'age');
// => { 'name': 'moe', 'age': 40 };

`_.pluck(collection, property)`

# Ⓢ Ⓣ

Retrieves the value of a specified property from all elements in the collection.

Arguments

collection (Array|Object|String): The collection to iterate over.
property (String): The property to pluck.

Returns

(Array): Returns a new array of property values.

Example

var stooges = [
  { 'name': 'moe', 'age': 40 },
  { 'name': 'larry', 'age': 50 }
];

_.pluck(stooges, 'name');
// => ['moe', 'larry']

`_.reduce(collection [, callback=identity, accumulator, thisArg])`

# Ⓢ Ⓣ

Reduces a collection to a value which is the accumulated result of running each element in the collection through the callback, where each successive callback execution consumes the return value of the previous execution. If accumulator is not passed, the first element of the collection will be used as the initial accumulator value. The callback is bound to thisArg and invoked with four arguments; (accumulator, value, index|key, collection).

Aliases

foldl, inject

Arguments

collection (Array|Object|String): The collection to iterate over.
[callback=identity] (Function): The function called per iteration.
[accumulator] (Mixed): Initial value of the accumulator.
[thisArg] (Mixed): The this binding of callback.

Returns

(Mixed): Returns the accumulated value.

Example

var sum = _.reduce([1, 2, 3], function(sum, num) {
  return sum + num;
});
// => 6

var mapped = _.reduce({ 'a': 1, 'b': 2, 'c': 3 }, function(result, num, key) {
  result[key] = num * 3;
  return result;
}, {});
// => { 'a': 3, 'b': 6, 'c': 9 }

`_.reduceRight(collection [, callback=identity, accumulator, thisArg])`

# Ⓢ Ⓣ

This method is similar to _.reduce, except that it iterates over a collection from right to left.

Aliases

foldr

Arguments

collection (Array|Object|String): The collection to iterate over.
[callback=identity] (Function): The function called per iteration.
[accumulator] (Mixed): Initial value of the accumulator.
[thisArg] (Mixed): The this binding of callback.

Returns

(Mixed): Returns the accumulated value.

Example

var list = [[0, 1], [2, 3], [4, 5]];
var flat = _.reduceRight(list, function(a, b) { return a.concat(b); }, []);
// => [4, 5, 2, 3, 0, 1]

`_.reject(collection [, callback=identity, thisArg])`

# Ⓢ Ⓣ

The opposite of _.filter, this method returns the elements of a collection that callback does not return truthy for.

If a property name is passed for callback, the created "_.pluck" style callback will return the property value of the given element.

If an object is passed for callback, the created "_.where" style callback will return true for elements that have the properties of the given object, else false.

Arguments

collection (Array|Object|String): The collection to iterate over.
[callback=identity] (Function|Object|String): The function called per iteration. If a property name or object is passed, it will be used to create a ".pluck" or ".where" style callback, respectively.
[thisArg] (Mixed): The this binding of callback.

Returns

(Array): Returns a new array of elements that did not pass the callback check.

Example

var odds = _.reject([1, 2, 3, 4, 5, 6], function(num) { return num % 2 == 0; });
// => [1, 3, 5]

var food = [
  { 'name': 'apple',  'organic': false, 'type': 'fruit' },
  { 'name': 'carrot', 'organic': true,  'type': 'vegetable' }
];

// using "_.pluck" callback shorthand
_.reject(food, 'organic');
// => [{ 'name': 'apple', 'organic': false, 'type': 'fruit' }]

// using "_.where" callback shorthand
_.reject(food, { 'type': 'fruit' });
// => [{ 'name': 'carrot', 'organic': true, 'type': 'vegetable' }]

`_.shuffle(collection)`

# Ⓢ Ⓣ

Creates an array of shuffled array values, using a version of the Fisher-Yates shuffle. See http://en.wikipedia.org/wiki/Fisher-Yates_shuffle.

Arguments

collection (Array|Object|String): The collection to shuffle.

Returns

(Array): Returns a new shuffled collection.

Example

_.shuffle([1, 2, 3, 4, 5, 6]);
// => [4, 1, 6, 3, 5, 2]

`_.size(collection)`

# Ⓢ Ⓣ

Gets the size of the collection by returning collection.length for arrays and array-like objects or the number of own enumerable properties for objects.

Arguments

collection (Array|Object|String): The collection to inspect.

Returns

(Number): Returns collection.length or number of own enumerable properties.

Example

_.size([1, 2]);
// => 2

_.size({ 'one': 1, 'two': 2, 'three': 3 });
// => 3

_.size('curly');
// => 5

`_.some(collection [, callback=identity, thisArg])`

# Ⓢ Ⓣ

Checks if the callback returns a truthy value for any element of a collection. The function returns as soon as it finds passing value, and does not iterate over the entire collection. The callback is bound to thisArg and invoked with three arguments; (value, index|key, collection).

If a property name is passed for callback, the created "_.pluck" style callback will return the property value of the given element.

If an object is passed for callback, the created "_.where" style callback will return true for elements that have the properties of the given object, else false.

Aliases

any

Arguments

collection (Array|Object|String): The collection to iterate over.
[callback=identity] (Function|Object|String): The function called per iteration. If a property name or object is passed, it will be used to create a ".pluck" or ".where" style callback, respectively.
[thisArg] (Mixed): The this binding of callback.

Returns

(Boolean): Returns true if any element passes the callback check, else false.

Example

_.some([null, 0, 'yes', false], Boolean);
// => true

var food = [
  { 'name': 'apple',  'organic': false, 'type': 'fruit' },
  { 'name': 'carrot', 'organic': true,  'type': 'vegetable' }
];

// using "_.pluck" callback shorthand
_.some(food, 'organic');
// => true

// using "_.where" callback shorthand
_.some(food, { 'type': 'meat' });
// => false

`_.sortBy(collection [, callback=identity, thisArg])`

# Ⓢ Ⓣ

Creates an array of elements, sorted in ascending order by the results of running each element in the collection through the callback. This method performs a stable sort, that is, it will preserve the original sort order of equal elements. The callback is bound to thisArg and invoked with three arguments; (value, index|key, collection).

If a property name is passed for callback, the created "_.pluck" style callback will return the property value of the given element.

If an object is passed for callback, the created "_.where" style callback will return true for elements that have the properties of the given object, else false.

Arguments

collection (Array|Object|String): The collection to iterate over.
[callback=identity] (Function|Object|String): The function called per iteration. If a property name or object is passed, it will be used to create a ".pluck" or ".where" style callback, respectively.
[thisArg] (Mixed): The this binding of callback.

Returns

(Array): Returns a new array of sorted elements.

Example

_.sortBy([1, 2, 3], function(num) { return Math.sin(num); });
// => [3, 1, 2]

_.sortBy([1, 2, 3], function(num) { return this.sin(num); }, Math);
// => [3, 1, 2]

// using "_.pluck" callback shorthand
_.sortBy(['banana', 'strawberry', 'apple'], 'length');
// => ['apple', 'banana', 'strawberry']

`_.toArray(collection)`

# Ⓢ Ⓣ

Converts the collection to an array.

Arguments

collection (Array|Object|String): The collection to convert.

Returns

(Array): Returns the new converted array.

Example

(function() { return _.toArray(arguments).slice(1); })(1, 2, 3, 4);
// => [2, 3, 4]

`_.where(collection, properties)`

# Ⓢ Ⓣ

Examines each element in a collection, returning an array of all elements that have the given properties. When checking properties, this method performs a deep comparison between values to determine if they are equivalent to each other.

Arguments

collection (Array|Object|String): The collection to iterate over.
properties (Object): The object of property values to filter by.

Returns

(Array): Returns a new array of elements that have the given properties.

Example

var stooges = [
  { 'name': 'moe', 'age': 40 },
  { 'name': 'larry', 'age': 50 }
];

_.where(stooges, { 'age': 40 });
// => [{ 'name': 'moe', 'age': 40 }]

`“Functions” Methods`

`_.after(n, func)`

# Ⓢ Ⓣ

If n is greater than 0, a function is created that is restricted to executing func, with the this binding and arguments of the created function, only after it is called n times. If n is less than 1, func is executed immediately, without a this binding or additional arguments, and its result is returned.

Arguments

n (Number): The number of times the function must be called before it is executed.
func (Function): The function to restrict.

Returns

(Function): Returns the new restricted function.

Example

var renderNotes = _.after(notes.length, render);
_.forEach(notes, function(note) {
  note.asyncSave({ 'success': renderNotes });
});
// `renderNotes` is run once, after all notes have saved

`_.bind(func [, thisArg, arg1, arg2, ...])`

# Ⓢ Ⓣ

Creates a function that, when called, invokes func with the this binding of thisArg and prepends any additional bind arguments to those passed to the bound function.

Arguments

func (Function): The function to bind.
[thisArg] (Mixed): The this binding of func.
[arg1, arg2, ...] (Mixed): Arguments to be partially applied.

Returns

(Function): Returns the new bound function.

Example

var func = function(greeting) {
  return greeting + ' ' + this.name;
};

func = _.bind(func, { 'name': 'moe' }, 'hi');
func();
// => 'hi moe'

`_.bindAll(object [, methodName1, methodName2, ...])`

# Ⓢ Ⓣ

Binds methods on object to object, overwriting the existing method. Method names may be specified as individual arguments or as arrays of method names. If no method names are provided, all the function properties of object will be bound.

Arguments

object (Object): The object to bind and assign the bound methods to.
[methodName1, methodName2, ...] (String): Method names on the object to bind.

Returns

(Object): Returns object.

Example

var view = {
 'label': 'docs',
 'onClick': function() { alert('clicked ' + this.label); }
};

_.bindAll(view);
jQuery('#docs').on('click', view.onClick);
// => alerts 'clicked docs', when the button is clicked

`_.bindKey(object, key [, arg1, arg2, ...])`

# Ⓢ Ⓣ

Creates a function that, when called, invokes the method at object[key] and prepends any additional bindKey arguments to those passed to the bound function. This method differs from _.bind by allowing bound functions to reference methods that will be redefined or don't yet exist. See http://michaux.ca/articles/lazy-function-definition-pattern.

Arguments

object (Object): The object the method belongs to.
key (String): The key of the method.
[arg1, arg2, ...] (Mixed): Arguments to be partially applied.

Returns

(Function): Returns the new bound function.

Example

var object = {
  'name': 'moe',
  'greet': function(greeting) {
    return greeting + ' ' + this.name;
  }
};

var func = _.bindKey(object, 'greet', 'hi');
func();
// => 'hi moe'

object.greet = function(greeting) {
  return greeting + ', ' + this.name + '!';
};

func();
// => 'hi, moe!'

`_.compose([func1, func2, ...])`

# Ⓢ Ⓣ

Creates a function that is the composition of the passed functions, where each function consumes the return value of the function that follows. For example, composing the functions f(), g(), and h() produces f(g(h())). Each function is executed with the this binding of the composed function.

Arguments

[func1, func2, ...] (Function): Functions to compose.

Returns

(Function): Returns the new composed function.

Example

var greet = function(name) { return 'hi ' + name; };
var exclaim = function(statement) { return statement + '!'; };
var welcome = _.compose(exclaim, greet);
welcome('moe');
// => 'hi moe!'

`_.createCallback([func=identity, thisArg, argCount=3])`

# Ⓢ Ⓣ

Produces a callback bound to an optional thisArg. If func is a property name, the created callback will return the property value for a given element. If func is an object, the created callback will return true for elements that contain the equivalent object properties, otherwise it will return false.

Note: All Lo-Dash methods, that accept a callback argument, use _.createCallback.

Arguments

[func=identity] (Mixed): The value to convert to a callback.
[thisArg] (Mixed): The this binding of the created callback.
[argCount=3] (Number): The number of arguments the callback accepts.

Returns

(Function): Returns a callback function.

Example

var stooges = [
  { 'name': 'moe', 'age': 40 },
  { 'name': 'larry', 'age': 50 }
];

// wrap to create custom callback shorthands
_.createCallback = _.wrap(_.createCallback, function(func, callback, thisArg) {
  var match = /^(.+?)__([gl]t)(.+)$/.exec(callback);
  return !match ? func(callback, thisArg) : function(object) {
    return match[2] == 'gt' ? object[match[1]] > match[3] : object[match[1]] < match[3];
  };
});

_.filter(stooges, 'age__gt45');
// => [{ 'name': 'larry', 'age': 50 }]

// create mixins with support for "_.pluck" and "_.where" callback shorthands
_.mixin({
  'toLookup': function(collection, callback, thisArg) {
    callback = _.createCallback(callback, thisArg);
    return _.reduce(collection, function(result, value, index, collection) {
      return (result[callback(value, index, collection)] = value, result);
    }, {});
  }
});

_.toLookup(stooges, 'name');
// => { 'moe': { 'name': 'moe', 'age': 40 }, 'larry': { 'name': 'larry', 'age': 50 } }

`_.debounce(func, wait, options)`

# Ⓢ Ⓣ

Creates a function that will delay the execution of func until after wait milliseconds have elapsed since the last time it was invoked. Pass an options object to indicate that func should be invoked on the leading and/or trailing edge of the wait timeout. Subsequent calls to the debounced function will return the result of the last func call.

Arguments

func (Function): The function to debounce.
wait (Number): The number of milliseconds to delay.
options (Object): The options object. [leading=false] A boolean to specify execution on the leading edge of the timeout. [trailing=true] A boolean to specify execution on the trailing edge of the timeout.

Returns

(Function): Returns the new debounced function.

Example

var lazyLayout = _.debounce(calculateLayout, 300);
jQuery(window).on('resize', lazyLayout);

`_.defer(func [, arg1, arg2, ...])`

# Ⓢ Ⓣ

Defers executing the func function until the current call stack has cleared. Additional arguments will be passed to func when it is invoked.

Arguments

func (Function): The function to defer.
[arg1, arg2, ...] (Mixed): Arguments to invoke the function with.

Returns

(Number): Returns the timer id.

Example

_.defer(function() { alert('deferred'); });
// returns from the function before `alert` is called

`_.delay(func, wait [, arg1, arg2, ...])`

# Ⓢ Ⓣ

Executes the func function after wait milliseconds. Additional arguments will be passed to func when it is invoked.

Arguments

func (Function): The function to delay.
wait (Number): The number of milliseconds to delay execution.
[arg1, arg2, ...] (Mixed): Arguments to invoke the function with.

Returns

(Number): Returns the timer id.

Example

var log = _.bind(console.log, console);
_.delay(log, 1000, 'logged later');
// => 'logged later' (Appears after one second.)

`_.memoize(func [, resolver])`

# Ⓢ Ⓣ

Creates a function that memoizes the result of func. If resolver is passed, it will be used to determine the cache key for storing the result based on the arguments passed to the memoized function. By default, the first argument passed to the memoized function is used as the cache key. The func is executed with the this binding of the memoized function.

Arguments

func (Function): The function to have its output memoized.
[resolver] (Function): A function used to resolve the cache key.

Returns

(Function): Returns the new memoizing function.

Example

var fibonacci = _.memoize(function(n) {
  return n < 2 ? n : fibonacci(n - 1) + fibonacci(n - 2);
});

`_.once(func)`

# Ⓢ Ⓣ

Creates a function that is restricted to execute func once. Repeat calls to the function will return the value of the first call. The func is executed with the this binding of the created function.

Arguments

func (Function): The function to restrict.

Returns

(Function): Returns the new restricted function.

Example

var initialize = _.once(createApplication);
initialize();
initialize();
// `initialize` executes `createApplication` once

`_.partial(func [, arg1, arg2, ...])`

# Ⓢ Ⓣ

Creates a function that, when called, invokes func with any additional partial arguments prepended to those passed to the new function. This method is similar to _.bind, except it does not alter the this binding.

Arguments

func (Function): The function to partially apply arguments to.
[arg1, arg2, ...] (Mixed): Arguments to be partially applied.

Returns

(Function): Returns the new partially applied function.

Example

var greet = function(greeting, name) { return greeting + ' ' + name; };
var hi = _.partial(greet, 'hi');
hi('moe');
// => 'hi moe'

`_.partialRight(func [, arg1, arg2, ...])`

# Ⓢ Ⓣ

This method is similar to _.partial, except that partial arguments are appended to those passed to the new function.

Arguments

func (Function): The function to partially apply arguments to.
[arg1, arg2, ...] (Mixed): Arguments to be partially applied.

Returns

(Function): Returns the new partially applied function.

Example

var defaultsDeep = _.partialRight(_.merge, _.defaults);

var options = {
  'variable': 'data',
  'imports': { 'jq': $ }
};

defaultsDeep(options, _.templateSettings);

options.variable
// => 'data'

options.imports
// => { '_': _, 'jq': $ }

`_.throttle(func, wait, options)`

# Ⓢ Ⓣ

Creates a function that, when executed, will only call the func function at most once per every wait milliseconds. If the throttled function is invoked more than once during the wait timeout, func will also be called on the trailing edge of the timeout. Pass an options object to indicate that func should be invoked on the leading and/or trailing edge of the wait timeout. Subsequent calls to the throttled function will return the result of the last func call.

Arguments

func (Function): The function to throttle.
wait (Number): The number of milliseconds to throttle executions to.
options (Object): The options object. [leading=true] A boolean to specify execution on the leading edge of the timeout. [trailing=true] A boolean to specify execution on the trailing edge of the timeout.

Returns

(Function): Returns the new throttled function.

Example

var throttled = _.throttle(updatePosition, 100);
jQuery(window).on('scroll', throttled);

`_.wrap(value, wrapper)`

# Ⓢ Ⓣ

Creates a function that passes value to the wrapper function as its first argument. Additional arguments passed to the function are appended to those passed to the wrapper function. The wrapper is executed with the this binding of the created function.

Arguments

value (Mixed): The value to wrap.
wrapper (Function): The wrapper function.

Returns

(Function): Returns the new function.

Example

var hello = function(name) { return 'hello ' + name; };
hello = _.wrap(hello, function(func) {
  return 'before, ' + func('moe') + ', after';
});
hello();
// => 'before, hello moe, after'

`“Objects” Methods`

`_.assign(object [, source1, source2, ..., callback, thisArg])`

# Ⓢ Ⓣ

Assigns own enumerable properties of source object(s) to the destination object. Subsequent sources will overwrite property assignments of previous sources. If a callback function is passed, it will be executed to produce the assigned values. The callback is bound to thisArg and invoked with two arguments; (objectValue, sourceValue).

Aliases

extend

Arguments

object (Object): The destination object.
[source1, source2, ...] (Object): The source objects.
[callback] (Function): The function to customize assigning values.
[thisArg] (Mixed): The this binding of callback.

Returns

(Object): Returns the destination object.

Example

_.assign({ 'name': 'moe' }, { 'age': 40 });
// => { 'name': 'moe', 'age': 40 }

var defaults = _.partialRight(_.assign, function(a, b) {
  return typeof a == 'undefined' ? b : a;
});

var food = { 'name': 'apple' };
defaults(food, { 'name': 'banana', 'type': 'fruit' });
// => { 'name': 'apple', 'type': 'fruit' }

`_.clone(value [, deep=false, callback, thisArg])`

# Ⓢ Ⓣ

Creates a clone of value. If deep is true, nested objects will also be cloned, otherwise they will be assigned by reference. If a callback function is passed, it will be executed to produce the cloned values. If callback returns undefined, cloning will be handled by the method instead. The callback is bound to thisArg and invoked with one argument; (value).

Arguments

value (Mixed): The value to clone.
[deep=false] (Boolean): A flag to indicate a deep clone.
[callback] (Function): The function to customize cloning values.
[thisArg] (Mixed): The this binding of callback.

Returns

(Mixed): Returns the cloned value.

Example

var stooges = [
  { 'name': 'moe', 'age': 40 },
  { 'name': 'larry', 'age': 50 }
];

var shallow = _.clone(stooges);
shallow[0] === stooges[0];
// => true

var deep = _.clone(stooges, true);
deep[0] === stooges[0];
// => false

_.mixin({
  'clone': _.partialRight(_.clone, function(value) {
    return _.isElement(value) ? value.cloneNode(false) : undefined;
  })
});

var clone = _.clone(document.body);
clone.childNodes.length;
// => 0

`_.cloneDeep(value [, callback, thisArg])`

# Ⓢ Ⓣ

Creates a deep clone of value. If a callback function is passed, it will be executed to produce the cloned values. If callback returns undefined, cloning will be handled by the method instead. The callback is bound to thisArg and invoked with one argument; (value).

Note: This function is loosely based on the structured clone algorithm. Functions and DOM nodes are not cloned. The enumerable properties of arguments objects and objects created by constructors other than Object are cloned to plain Object objects. See http://www.w3.org/TR/html5/infrastructure.html#internal-structured-cloning-algorithm.

Arguments

value (Mixed): The value to deep clone.
[callback] (Function): The function to customize cloning values.
[thisArg] (Mixed): The this binding of callback.

Returns

(Mixed): Returns the deep cloned value.

Example

var stooges = [
  { 'name': 'moe', 'age': 40 },
  { 'name': 'larry', 'age': 50 }
];

var deep = _.cloneDeep(stooges);
deep[0] === stooges[0];
// => false

var view = {
  'label': 'docs',
  'node': element
};

var clone = _.cloneDeep(view, function(value) {
  return _.isElement(value) ? value.cloneNode(true) : undefined;
});

clone.node == view.node;
// => false

`_.defaults(object [, source1, source2, ...])`

# Ⓢ Ⓣ

Assigns own enumerable properties of source object(s) to the destination object for all destination properties that resolve to undefined. Once a property is set, additional defaults of the same property will be ignored.

Arguments

object (Object): The destination object.
[source1, source2, ...] (Object): The source objects.

Returns

(Object): Returns the destination object.

Example

var food = { 'name': 'apple' };
_.defaults(food, { 'name': 'banana', 'type': 'fruit' });
// => { 'name': 'apple', 'type': 'fruit' }

`_.findKey(object [, callback=identity, thisArg])`

# Ⓢ Ⓣ

This method is similar to _.find, except that it returns the key of the element that passes the callback check, instead of the element itself.

Arguments

object (Object): The object to search.
[callback=identity] (Function|Object|String): The function called per iteration. If a property name or object is passed, it will be used to create a ".pluck" or ".where" style callback, respectively.
[thisArg] (Mixed): The this binding of callback.

Returns

(Mixed): Returns the key of the found element, else undefined.

Example

_.findKey({ 'a': 1, 'b': 2, 'c': 3, 'd': 4 }, function(num) {
  return num % 2 == 0;
});
// => 'b'

`_.forIn(object [, callback=identity, thisArg])`

# Ⓢ Ⓣ

Iterates over object's own and inherited enumerable properties, executing the callback for each property. The callback is bound to thisArg and invoked with three arguments; (value, key, object). Callbacks may exit iteration early by explicitly returning false.

Arguments

object (Object): The object to iterate over.
[callback=identity] (Function): The function called per iteration.
[thisArg] (Mixed): The this binding of callback.

Returns

(Object): Returns object.

Example

function Dog(name) {
  this.name = name;
}

Dog.prototype.bark = function() {
  alert('Woof, woof!');
};

_.forIn(new Dog('Dagny'), function(value, key) {
  alert(key);
});
// => alerts 'name' and 'bark' (order is not guaranteed)

`_.forOwn(object [, callback=identity, thisArg])`

# Ⓢ Ⓣ

Iterates over an object's own enumerable properties, executing the callback for each property. The callback is bound to thisArg and invoked with three arguments; (value, key, object). Callbacks may exit iteration early by explicitly returning false.

Arguments

object (Object): The object to iterate over.
[callback=identity] (Function): The function called per iteration.
[thisArg] (Mixed): The this binding of callback.

Returns

(Object): Returns object.

Example

_.forOwn({ '0': 'zero', '1': 'one', 'length': 2 }, function(num, key) {
  alert(key);
});
// => alerts '0', '1', and 'length' (order is not guaranteed)

`_.functions(object)`

# Ⓢ Ⓣ

Creates a sorted array of all enumerable properties, own and inherited, of object that have function values.

Aliases

methods

Arguments

object (Object): The object to inspect.

Returns

(Array): Returns a new array of property names that have function values.

Example

_.functions(_);
// => ['all', 'any', 'bind', 'bindAll', 'clone', 'compact', 'compose', ...]

`_.has(object, property)`

# Ⓢ Ⓣ

Checks if the specified object property exists and is a direct property, instead of an inherited property.

Arguments

object (Object): The object to check.
property (String): The property to check for.

Returns

(Boolean): Returns true if key is a direct property, else false.

Example

_.has({ 'a': 1, 'b': 2, 'c': 3 }, 'b');
// => true

`_.invert(object)`

# Ⓢ Ⓣ

Creates an object composed of the inverted keys and values of the given object.

Arguments

object (Object): The object to invert.

Returns

(Object): Returns the created inverted object.

Example

_.invert({ 'first': 'moe', 'second': 'larry' });
// => { 'moe': 'first', 'larry': 'second' }

`_.isArguments(value)`

# Ⓢ Ⓣ

Checks if value is an arguments object.

Arguments

value (Mixed): The value to check.

Returns

(Boolean): Returns true, if the value is an arguments object, else false.

Example

(function() { return _.isArguments(arguments); })(1, 2, 3);
// => true

_.isArguments([1, 2, 3]);
// => false

`_.isArray(value)`

# Ⓢ Ⓣ

Checks if value is an array.

Arguments

value (Mixed): The value to check.

Returns

(Boolean): Returns true, if the value is an array, else false.

Example

(function() { return _.isArray(arguments); })();
// => false

_.isArray([1, 2, 3]);
// => true

`_.isBoolean(value)`

# Ⓢ Ⓣ

Checks if value is a boolean value.

Arguments

value (Mixed): The value to check.

Returns

(Boolean): Returns true, if the value is a boolean value, else false.

Example

_.isBoolean(null);
// => false

`_.isDate(value)`

# Ⓢ Ⓣ

Checks if value is a date.

Arguments

value (Mixed): The value to check.

Returns

(Boolean): Returns true, if the value is a date, else false.

Example

_.isDate(new Date);
// => true

`_.isElement(value)`

# Ⓢ Ⓣ

Checks if value is a DOM element.

Arguments

value (Mixed): The value to check.

Returns

(Boolean): Returns true, if the value is a DOM element, else false.

Example

_.isElement(document.body);
// => true

`_.isEmpty(value)`

# Ⓢ Ⓣ

Checks if value is empty. Arrays, strings, or arguments objects with a length of 0 and objects with no own enumerable properties are considered "empty".

Arguments

value (Array|Object|String): The value to inspect.

Returns

(Boolean): Returns true, if the value is empty, else false.

Example

_.isEmpty([1, 2, 3]);
// => false

_.isEmpty({});
// => true

_.isEmpty('');
// => true

`_.isEqual(a, b [, callback, thisArg])`

# Ⓢ Ⓣ

Performs a deep comparison between two values to determine if they are equivalent to each other. If callback is passed, it will be executed to compare values. If callback returns undefined, comparisons will be handled by the method instead. The callback is bound to thisArg and invoked with two arguments; (a, b).

Arguments

a (Mixed): The value to compare.
b (Mixed): The other value to compare.
[callback] (Function): The function to customize comparing values.
[thisArg] (Mixed): The this binding of callback.

Returns

(Boolean): Returns true, if the values are equivalent, else false.

Example

var moe = { 'name': 'moe', 'age': 40 };
var copy = { 'name': 'moe', 'age': 40 };

moe == copy;
// => false

_.isEqual(moe, copy);
// => true

var words = ['hello', 'goodbye'];
var otherWords = ['hi', 'goodbye'];

_.isEqual(words, otherWords, function(a, b) {
  var reGreet = /^(?:hello|hi)$/i,
      aGreet = _.isString(a) && reGreet.test(a),
      bGreet = _.isString(b) && reGreet.test(b);

  return (aGreet || bGreet) ? (aGreet == bGreet) : undefined;
});
// => true

`_.isFinite(value)`

# Ⓢ Ⓣ

Checks if value is, or can be coerced to, a finite number.

Note: This is not the same as native isFinite, which will return true for booleans and empty strings. See http://es5.github.com/#x15.1.2.5.

Arguments

value (Mixed): The value to check.

Returns

(Boolean): Returns true, if the value is finite, else false.

Example

_.isFinite(-101);
// => true

_.isFinite('10');
// => true

_.isFinite(true);
// => false

_.isFinite('');
// => false

_.isFinite(Infinity);
// => false

`_.isFunction(value)`

# Ⓢ Ⓣ

Checks if value is a function.

Arguments

value (Mixed): The value to check.

Returns

(Boolean): Returns true, if the value is a function, else false.

Example

_.isFunction(_);
// => true

`_.isNaN(value)`

# Ⓢ Ⓣ

Checks if value is NaN.

Note: This is not the same as native isNaN, which will return true for undefined and other values. See http://es5.github.com/#x15.1.2.4.

Arguments

value (Mixed): The value to check.

Returns

(Boolean): Returns true, if the value is NaN, else false.

Example

_.isNaN(NaN);
// => true

_.isNaN(new Number(NaN));
// => true

isNaN(undefined);
// => true

_.isNaN(undefined);
// => false

`_.isNull(value)`

# Ⓢ Ⓣ

Checks if value is null.

Arguments

value (Mixed): The value to check.

Returns

(Boolean): Returns true, if the value is null, else false.

Example

_.isNull(null);
// => true

_.isNull(undefined);
// => false

`_.isNumber(value)`

# Ⓢ Ⓣ

Checks if value is a number.

Arguments

value (Mixed): The value to check.

Returns

(Boolean): Returns true, if the value is a number, else false.

Example

_.isNumber(8.4 * 5);
// => true

`_.isObject(value)`

# Ⓢ Ⓣ

Checks if value is the language type of Object. (e.g. arrays, functions, objects, regexes, new Number(0), and new String(''))

Arguments

value (Mixed): The value to check.

Returns

(Boolean): Returns true, if the value is an object, else false.

Example

_.isObject({});
// => true

_.isObject([1, 2, 3]);
// => true

_.isObject(1);
// => false

`_.isPlainObject(value)`

# Ⓢ Ⓣ

Checks if a given value is an object created by the Object constructor.

Arguments

value (Mixed): The value to check.

Returns

(Boolean): Returns true, if value is a plain object, else false.

Example

function Stooge(name, age) {
  this.name = name;
  this.age = age;
}

_.isPlainObject(new Stooge('moe', 40));
// => false

_.isPlainObject([1, 2, 3]);
// => false

_.isPlainObject({ 'name': 'moe', 'age': 40 });
// => true

`_.isRegExp(value)`

# Ⓢ Ⓣ

Checks if value is a regular expression.

Arguments

value (Mixed): The value to check.

Returns

(Boolean): Returns true, if the value is a regular expression, else false.

Example

_.isRegExp(/moe/);
// => true

`_.isString(value)`

# Ⓢ Ⓣ

Checks if value is a string.

Arguments

value (Mixed): The value to check.

Returns

(Boolean): Returns true, if the value is a string, else false.

Example

_.isString('moe');
// => true

`_.isUndefined(value)`

# Ⓢ Ⓣ

Checks if value is undefined.

Arguments

value (Mixed): The value to check.

Returns

(Boolean): Returns true, if the value is undefined, else false.

Example

_.isUndefined(void 0);
// => true

`_.keys(object)`

# Ⓢ Ⓣ

Creates an array composed of the own enumerable property names of object.

Arguments

object (Object): The object to inspect.

Returns

(Array): Returns a new array of property names.

Example

_.keys({ 'one': 1, 'two': 2, 'three': 3 });
// => ['one', 'two', 'three'] (order is not guaranteed)

`_.merge(object [, source1, source2, ..., callback, thisArg])`

# Ⓢ Ⓣ

Recursively merges own enumerable properties of the source object(s), that don't resolve to undefined, into the destination object. Subsequent sources will overwrite property assignments of previous sources. If a callback function is passed, it will be executed to produce the merged values of the destination and source properties. If callback returns undefined, merging will be handled by the method instead. The callback is bound to thisArg and invoked with two arguments; (objectValue, sourceValue).

Arguments

object (Object): The destination object.
[source1, source2, ...] (Object): The source objects.
[callback] (Function): The function to customize merging properties.
[thisArg] (Mixed): The this binding of callback.

Returns

(Object): Returns the destination object.

Example

var names = {
  'stooges': [
    { 'name': 'moe' },
    { 'name': 'larry' }
  ]
};

var ages = {
  'stooges': [
    { 'age': 40 },
    { 'age': 50 }
  ]
};

_.merge(names, ages);
// => { 'stooges': [{ 'name': 'moe', 'age': 40 }, { 'name': 'larry', 'age': 50 }] }

var food = {
  'fruits': ['apple'],
  'vegetables': ['beet']
};

var otherFood = {
  'fruits': ['banana'],
  'vegetables': ['carrot']
};

_.merge(food, otherFood, function(a, b) {
  return _.isArray(a) ? a.concat(b) : undefined;
});
// => { 'fruits': ['apple', 'banana'], 'vegetables': ['beet', 'carrot] }

`_.omit(object, callback|[prop1, prop2, ..., thisArg])`

# Ⓢ Ⓣ

Creates a shallow clone of object excluding the specified properties. Property names may be specified as individual arguments or as arrays of property names. If a callback function is passed, it will be executed for each property in the object, omitting the properties callback returns truthy for. The callback is bound to thisArg and invoked with three arguments; (value, key, object).

Arguments

object (Object): The source object.
callback|[prop1, prop2, ...] (Function|String): The properties to omit or the function called per iteration.
[thisArg] (Mixed): The this binding of callback.

Returns

(Object): Returns an object without the omitted properties.

Example

_.omit({ 'name': 'moe', 'age': 40 }, 'age');
// => { 'name': 'moe' }

_.omit({ 'name': 'moe', 'age': 40 }, function(value) {
  return typeof value == 'number';
});
// => { 'name': 'moe' }

`_.pairs(object)`

# Ⓢ Ⓣ

Creates a two dimensional array of the given object's key-value pairs, i.e. [[key1, value1], [key2, value2]].

Arguments

object (Object): The object to inspect.

Returns

(Array): Returns new array of key-value pairs.

Example

_.pairs({ 'moe': 30, 'larry': 40 });
// => [['moe', 30], ['larry', 40]] (order is not guaranteed)

`_.pick(object, callback|[prop1, prop2, ..., thisArg])`

# Ⓢ Ⓣ

Creates a shallow clone of object composed of the specified properties. Property names may be specified as individual arguments or as arrays of property names. If callback is passed, it will be executed for each property in the object, picking the properties callback returns truthy for. The callback is bound to thisArg and invoked with three arguments; (value, key, object).

Arguments

object (Object): The source object.
callback|[prop1, prop2, ...] (Array|Function|String): The function called per iteration or properties to pick, either as individual arguments or arrays.
[thisArg] (Mixed): The this binding of callback.

Returns

(Object): Returns an object composed of the picked properties.

Example

_.pick({ 'name': 'moe', '_userid': 'moe1' }, 'name');
// => { 'name': 'moe' }

_.pick({ 'name': 'moe', '_userid': 'moe1' }, function(value, key) {
  return key.charAt(0) != '_';
});
// => { 'name': 'moe' }

`_.values(object)`

# Ⓢ Ⓣ

Creates an array composed of the own enumerable property values of object.

Arguments

object (Object): The object to inspect.

Returns

(Array): Returns a new array of property values.

Example

_.values({ 'one': 1, 'two': 2, 'three': 3 });
// => [1, 2, 3] (order is not guaranteed)

`“Utilities” Methods`

`_.escape(string)`

# Ⓢ Ⓣ

Converts the characters &, <, >, ", and ' in string to their corresponding HTML entities.

Arguments

string (String): The string to escape.

Returns

(String): Returns the escaped string.

Example

_.escape('Moe, Larry & Curly');
// => 'Moe, Larry &amp; Curly'

`_.identity(value)`

# Ⓢ Ⓣ

This function returns the first argument passed to it.

Arguments

value (Mixed): Any value.

Returns

(Mixed): Returns value.

Example

var moe = { 'name': 'moe' };
moe === _.identity(moe);
// => true

`_.mixin(object)`

# Ⓢ Ⓣ

Adds functions properties of object to the lodash function and chainable wrapper.

Arguments

object (Object): The object of function properties to add to lodash.

Example

_.mixin({
  'capitalize': function(string) {
    return string.charAt(0).toUpperCase() + string.slice(1).toLowerCase();
  }
});

_.capitalize('moe');
// => 'Moe'

_('moe').capitalize();
// => 'Moe'

`_.noConflict()`

# Ⓢ Ⓣ

Reverts the '_' variable to its previous value and returns a reference to the lodash function.

Returns

(Function): Returns the lodash function.

Example

var lodash = _.noConflict();

`_.parseInt(value)`

# Ⓢ Ⓣ

Converts the given value into an integer of the specified radix.

Note: This method avoids differences in native ES3 and ES5 parseInt implementations. See http://es5.github.com/#E.

Arguments

value (Mixed): The value to parse.

Returns

(Number): Returns the new integer value.

Example

_.parseInt('08');
// => 8

`_.random([min=0, max=1])`

# Ⓢ Ⓣ

Produces a random number between min and max (inclusive). If only one argument is passed, a number between 0 and the given number will be returned.

Arguments

[min=0] (Number): The minimum possible value.
[max=1] (Number): The maximum possible value.

Returns

(Number): Returns a random number.

Example

_.random(0, 5);
// => a number between 0 and 5

_.random(5);
// => also a number between 0 and 5

`_.result(object, property)`

# Ⓢ Ⓣ

Resolves the value of property on object. If property is a function, it will be invoked with the this binding of object and its result returned, else the property value is returned. If object is falsey, then undefined is returned.

Arguments

object (Object): The object to inspect.
property (String): The property to get the value of.

Returns

(Mixed): Returns the resolved value.

Example

var object = {
  'cheese': 'crumpets',
  'stuff': function() {
    return 'nonsense';
  }
};

_.result(object, 'cheese');
// => 'crumpets'

_.result(object, 'stuff');
// => 'nonsense'

`_.runInContext([context=window])`

# Ⓢ Ⓣ

Create a new lodash function using the given context object.

Arguments

[context=window] (Object): The context object.

Returns

(Function): Returns the lodash function.

`_.template(text, data, options)`

# Ⓢ Ⓣ

A micro-templating method that handles arbitrary delimiters, preserves whitespace, and correctly escapes quotes within interpolated code.

Note: In the development build, _.template utilizes sourceURLs for easier debugging. See http://www.html5rocks.com/en/tutorials/developertools/sourcemaps/#toc-sourceurl

For more information on precompiling templates see:
http://lodash.com/#custom-builds

For more information on Chrome extension sandboxes see:
http://developer.chrome.com/stable/extensions/sandboxingEval.html

Arguments

text (String): The template text.
data (Object): The data object used to populate the text.
options (Object): The options object. escape - The "escape" delimiter regexp. evaluate - The "evaluate" delimiter regexp. interpolate - The "interpolate" delimiter regexp. sourceURL - The sourceURL of the template's compiled source. variable - The data object variable name.

Returns

(Function, String): Returns a compiled function when no data object is given, else it returns the interpolated text.

Example

// using a compiled template
var compiled = _.template('hello <%= name %>');
compiled({ 'name': 'moe' });
// => 'hello moe'

var list = '<% _.forEach(people, function(name) { %><li><%= name %></li><% }); %>';
_.template(list, { 'people': ['moe', 'larry'] });
// => '<li>moe</li><li>larry</li>'

// using the "escape" delimiter to escape HTML in data property values
_.template('<b><%- value %></b>', { 'value': '<script>' });
// => '<b>&lt;script&gt;</b>'

// using the ES6 delimiter as an alternative to the default "interpolate" delimiter
_.template('hello ${ name }', { 'name': 'curly' });
// => 'hello curly'

// using the internal `print` function in "evaluate" delimiters
_.template('<% print("hello " + epithet); %>!', { 'epithet': 'stooge' });
// => 'hello stooge!'

// using custom template delimiters
_.templateSettings = {
  'interpolate': /{{([\s\S]+?)}}/g
};

_.template('hello {{ name }}!', { 'name': 'mustache' });
// => 'hello mustache!'

// using the `sourceURL` option to specify a custom sourceURL for the template
var compiled = _.template('hello <%= name %>', null, { 'sourceURL': '/basic/greeting.jst' });
compiled(data);
// => find the source of "greeting.jst" under the Sources tab or Resources panel of the web inspector

// using the `variable` option to ensure a with-statement isn't used in the compiled template
var compiled = _.template('hi <%= data.name %>!', null, { 'variable': 'data' });
compiled.source;
// => function(data) {
  var __t, __p = '', __e = _.escape;
  __p += 'hi ' + ((__t = ( data.name )) == null ? '' : __t) + '!';
  return __p;
}

// using the `source` property to inline compiled templates for meaningful
// line numbers in error messages and a stack trace
fs.writeFileSync(path.join(cwd, 'jst.js'), '\
  var JST = {\
    "main": ' + _.template(mainText).source + '\
  };\
');

`_.times(n, callback [, thisArg])`

# Ⓢ Ⓣ

Executes the callback function n times, returning an array of the results of each callback execution. The callback is bound to thisArg and invoked with one argument; (index).

Arguments

n (Number): The number of times to execute the callback.
callback (Function): The function called per iteration.
[thisArg] (Mixed): The this binding of callback.

Returns

(Array): Returns a new array of the results of each callback execution.

Example

var diceRolls = _.times(3, _.partial(_.random, 1, 6));
// => [3, 6, 4]

_.times(3, function(n) { mage.castSpell(n); });
// => calls `mage.castSpell(n)` three times, passing `n` of `0`, `1`, and `2` respectively

_.times(3, function(n) { this.cast(n); }, mage);
// => also calls `mage.castSpell(n)` three times

`_.unescape(string)`

# Ⓢ Ⓣ

The inverse of _.escape, this method converts the HTML entities &, <, >, ", and ' in string to their corresponding characters.

Arguments

string (String): The string to unescape.

Returns

(String): Returns the unescaped string.

Example

_.unescape('Moe, Larry &amp; Curly');
// => 'Moe, Larry & Curly'

`_.uniqueId([prefix])`

# Ⓢ Ⓣ

Generates a unique ID. If prefix is passed, the ID will be appended to it.

Arguments

[prefix] (String): The value to prefix the ID with.

Returns

(String): Returns the unique ID.

Example

_.uniqueId('contact_');
// => 'contact_104'

_.uniqueId();
// => '105'

`Methods`

`_.templateSettings.imports._`

# Ⓢ Ⓣ

A reference to the lodash function.

`Properties`

`_.VERSION`

# Ⓢ Ⓣ

(String): The semantic version number.

`_.support`

# Ⓢ Ⓣ

(Object): An object used to flag environments features.

`_.support.argsClass`

# Ⓢ Ⓣ

(Boolean): Detect if an arguments object's [[Class]] is resolvable (all but Firefox < 4, IE < 9).

`_.support.argsObject`

# Ⓢ Ⓣ

(Boolean): Detect if arguments objects are Object objects (all but Narwhal and Opera < 10.5).

`_.support.enumPrototypes`

# Ⓢ Ⓣ

(Boolean): Detect if prototype properties are enumerable by default.

Firefox < 3.6, Opera > 9.50 - Opera < 11.60, and Safari < 5.1 (if the prototype or a property on the prototype has been set) incorrectly sets a function's prototype property [[Enumerable]] value to true.

`_.support.fastBind`

# Ⓢ Ⓣ

(Boolean): Detect if Function#bind exists and is inferred to be fast (all but V8).

`_.support.nonEnumArgs`

# Ⓢ Ⓣ

(Boolean): Detect if arguments object indexes are non-enumerable (Firefox < 4, IE < 9, PhantomJS, Safari < 5.1).

`_.support.nonEnumShadows`

# Ⓢ Ⓣ

(Boolean): Detect if properties shadowing those on Object.prototype are non-enumerable.

In IE < 9 an objects own properties, shadowing non-enumerable ones, are made non-enumerable as well (a.k.a the JScript [[DontEnum]] bug).

`_.support.ownLast`

# Ⓢ Ⓣ

(Boolean): Detect if own properties are iterated after inherited properties (all but IE < 9).

`_.support.spliceObjects`

# Ⓢ Ⓣ

(Boolean): Detect if Array#shift and Array#splice augment array-like objects correctly.

Firefox < 10, IE compatibility mode, and IE < 9 have buggy Array shift() and splice() functions that fail to remove the last element, value[0], of array-like objects even though the length property is set to 0. The shift() method is buggy in IE 8 compatibility mode, while splice() is buggy regardless of mode in IE < 9 and buggy in compatibility mode in IE 9.

`_.support.unindexedChars`

# Ⓢ Ⓣ

(Boolean): Detect lack of support for accessing string characters by index.

IE < 8 can't access characters by index and IE 8 can only access characters by index on string literals.

`_.templateSettings`

# Ⓢ Ⓣ

(Object): By default, the template delimiters used by Lo-Dash are similar to those in embedded Ruby (ERB). Change the following template settings to use alternative delimiters.

`_.templateSettings.escape`

# Ⓢ Ⓣ

(RegExp): Used to detect data property values to be HTML-escaped.

`_.templateSettings.evaluate`

# Ⓢ Ⓣ

(RegExp): Used to detect code to be evaluated.

`_.templateSettings.interpolate`

# Ⓢ Ⓣ

(RegExp): Used to detect data property values to inject.

`_.templateSettings.variable`

# Ⓢ Ⓣ

(String): Used to reference the data object in the template text.

`_.templateSettings.imports`

# Ⓢ Ⓣ

(Object): Used to import variables into the compiled template.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!