Skip to content

Instantly share code, notes, and snippets.

@jfmengels

jfmengels/lodash-fp-documentation.md

Last active July 25, 2024 05:02
Show Gist options
  • Save jfmengels/6b973b69c491375117dc to your computer and use it in GitHub Desktop.
Save jfmengels/6b973b69c491375117dc to your computer and use it in GitHub Desktop.
Download ZIP
Generated docs for Lodash/fp. Help make them better at https://github.com/jfmengels/lodash-fp-docs
Raw
lodash-fp-documentation.md

lodash v4.17.20

Array

Collection

Date

Function

Lang

Math

Number

Object

Seq

String

Util

Properties

Methods

“Array” Methods

_.chunk(size, array)

# Ⓢ Ⓣ Ⓝ

Creates an array of elements split into groups the length of size. If array can't be split evenly, the final chunk will be the remaining elements.

Since

3.0.0

Arguments

  1. size (number): The length of each chunk
  2. array (Array): The array to process.

Returns

(Array): Returns the new array of chunks.

Example

_.chunk(2, ['a', 'b', 'c', 'd']);
// => [['a', 'b'], ['c', 'd']]

_.chunk(3, ['a', 'b', 'c', 'd']);
// => [['a', 'b', 'c'], ['d']]

_.compact(array)

# Ⓢ Ⓣ Ⓝ

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

Since

0.1.0

Arguments

  1. array (Array): The array to compact.

Returns

(Array): Returns the new array of filtered values.

Example

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

_.concat(array, values)

# Ⓢ Ⓣ Ⓝ

Creates a new array concatenating array with any additional arrays and/or values.

Since

4.0.0

Arguments

  1. array (Array): The array to concatenate.
  2. values (*|*[]): The values to concatenate.

Returns

(Array): Returns the new concatenated array.

Example

var array = [1];
var other = _.concat(array, [2, [3], [[4]]]);

// => [1, 2, 3, [4]]

// => [1]

_.difference(array, values)

# Ⓢ Ⓣ Ⓝ

Creates an array of array values not included in the other given arrays using SameValueZero for equality comparisons. The order and references of result values are determined by the first array.

Note: Unlike _.pullAll, this method returns a new array.

Since

0.1.0

Arguments

  1. array (Array): The array to inspect.
  2. values (Array|Array[]): The values to exclude.

Returns

(Array): Returns the new array of filtered values.

Example

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

_.differenceBy(iteratee, array, values)

# Ⓢ Ⓣ Ⓝ

This method is like _.difference except that it accepts iteratee which is invoked for each element of array and values to generate the criterion by which they're compared. The order and references of result values are determined by the first array. The iteratee is invoked with one argument:
(value).

Note: Unlike _.pullAllBy, this method returns a new array.

Since

4.0.0

Arguments

  1. iteratee (Function): The iteratee invoked per element.
  2. array (Array): The array to inspect.
  3. values (Array|Array[]): The values to exclude.

Returns

(Array): Returns the new array of filtered values.

Example

_.differenceBy(Math.floor, [2.1, 1.2], [2.3, 3.4]);
// => [1.2]

// The `_.property` iteratee shorthand.
_.differenceBy('x', [{ 'x': 2 }, { 'x': 1 }], [{ 'x': 1 }]);
// => [{ 'x': 2 }]

_.differenceWith(comparator, array, values)

# Ⓢ Ⓣ Ⓝ

This method is like _.difference except that it accepts comparator which is invoked to compare elements of array to values. The order and references of result values are determined by the first array. The comparator is invoked with two arguments: (arrVal, othVal).

Note: Unlike _.pullAllWith, this method returns a new array.

Since

4.0.0

Arguments

  1. comparator (Function): The comparator invoked per element.
  2. array (Array): The array to inspect.
  3. values (Array|Array[]): The values to exclude.

Returns

(Array): Returns the new array of filtered values.

Example

var objects = [{ 'x': 1, 'y': 2 }, { 'x': 2, 'y': 1 }];

_.differenceWith(_.isEqual, objects, [{ 'x': 1, 'y': 2 }]);
// => [{ 'x': 2, 'y': 1 }]

_.drop(n, array)

# Ⓢ Ⓣ Ⓝ

Creates a slice of array with n elements dropped from the beginning.

Since

0.5.0

Arguments

  1. n (number): The number of elements to drop.
  2. array (Array): The array to query.

Returns

(Array): Returns the slice of array.

Example

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

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

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

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

_.dropRight(n, array)

# Ⓢ Ⓣ Ⓝ

Creates a slice of array with n elements dropped from the end.

Since

3.0.0

Arguments

  1. n (number): The number of elements to drop.
  2. array (Array): The array to query.

Returns

(Array): Returns the slice of array.

Example

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

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

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

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

_.dropRightWhile(predicate, array)

# Ⓢ Ⓣ Ⓝ

Creates a slice of array excluding elements dropped from the end. Elements are dropped until predicate returns falsey. The predicate is invoked with three arguments: (value, index, array).

Since

3.0.0

Arguments

  1. predicate (Function): The function invoked per iteration.
  2. array (Array): The array to query.

Returns

(Array): Returns the slice of array.

Example

var users = [
  { 'user': 'barney',  'active': true },
  { 'user': 'fred',    'active': false },
  { 'user': 'pebbles', 'active': false }
];

_.dropRightWhile(function(o) { return !o.active; }, users);
// => objects for ['barney']

// The `_.matches` iteratee shorthand.
_.dropRightWhile({ 'user': 'pebbles', 'active': false }, users);
// => objects for ['barney', 'fred']

// The `_.matchesProperty` iteratee shorthand.
_.dropRightWhile(['active', false], users);
// => objects for ['barney']

// The `_.property` iteratee shorthand.
_.dropRightWhile('active', users);
// => objects for ['barney', 'fred', 'pebbles']

_.dropWhile(predicate, array)

# Ⓢ Ⓣ Ⓝ

Creates a slice of array excluding elements dropped from the beginning. Elements are dropped until predicate returns falsey. The predicate is invoked with three arguments: (value, index, array).

Since

3.0.0

Arguments

  1. predicate (Function): The function invoked per iteration.
  2. array (Array): The array to query.

Returns

(Array): Returns the slice of array.

Example

var users = [
  { 'user': 'barney',  'active': false },
  { 'user': 'fred',    'active': false },
  { 'user': 'pebbles', 'active': true }
];

_.dropWhile(function(o) { return !o.active; }, users);
// => objects for ['pebbles']

// The `_.matches` iteratee shorthand.
_.dropWhile({ 'user': 'barney', 'active': false }, users);
// => objects for ['fred', 'pebbles']

// The `_.matchesProperty` iteratee shorthand.
_.dropWhile(['active', false], users);
// => objects for ['pebbles']

// The `_.property` iteratee shorthand.
_.dropWhile('active', users);
// => objects for ['barney', 'fred', 'pebbles']

_.fill(start, end, value, array)

# Ⓢ Ⓣ Ⓝ

Fills elements of array with value from start up to, but not including, end.

Since

3.2.0

Arguments

  1. start (number): The start position.
  2. end (number): The end position.
  3. value (*): The value to fill array with.
  4. array (Array): The array to fill.

Returns

(Array): Returns array.

Example

var array = [1, 2, 3];

_.fill(0, array.length, 'a', array);
// => ['a', 'a', 'a']

_.fill(0, Array(3).length, 2, Array(3));
// => [2, 2, 2]

_.fill(1, 3, '*', [4, 6, 8, 10]);
// => [4, '*', '*', 10]

_.findIndex(predicate, array)

# Ⓢ Ⓣ Ⓝ

This method is like _.find except that it returns the index of the first element predicate returns truthy for instead of the element itself.

Since

1.1.0

Arguments

  1. predicate (Function): The function invoked per iteration.
  2. array (Array): The array to inspect.

Returns

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

Example

var users = [
  { 'user': 'barney',  'active': false },
  { 'user': 'fred',    'active': false },
  { 'user': 'pebbles', 'active': true }
];

_.findIndex(function(o) { return o.user == 'barney'; }, users);
// => 0

// The `_.matches` iteratee shorthand.
_.findIndex({ 'user': 'fred', 'active': false }, users);
// => 1

// The `_.matchesProperty` iteratee shorthand.
_.findIndex(['active', false], users);
// => 0

// The `_.property` iteratee shorthand.
_.findIndex('active', users);
// => 2

_.findLastIndex(predicate, array)

# Ⓢ Ⓣ Ⓝ

This method is like _.findIndex except that it iterates over elements of collection from right to left.

Since

2.0.0

Arguments

  1. predicate (Function): The function invoked per iteration.
  2. array (Array): The array to inspect.

Returns

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

Example

var users = [
  { 'user': 'barney',  'active': true },
  { 'user': 'fred',    'active': false },
  { 'user': 'pebbles', 'active': false }
];

_.findLastIndex(function(o) { return o.user == 'pebbles'; }, users);
// => 2

// The `_.matches` iteratee shorthand.
_.findLastIndex({ 'user': 'barney', 'active': true }, users);
// => 0

// The `_.matchesProperty` iteratee shorthand.
_.findLastIndex(['active', false], users);
// => 2

// The `_.property` iteratee shorthand.
_.findLastIndex('active', users);
// => 0

_.flatten(array)

# Ⓢ Ⓣ Ⓝ

Flattens array a single level deep.

Since

0.1.0

Arguments

  1. array (Array): The array to flatten.

Returns

(Array): Returns the new flattened array.

Example

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

_.flattenDeep(array)

# Ⓢ Ⓣ Ⓝ

Recursively flattens array.

Since

3.0.0

Arguments

  1. array (Array): The array to flatten.

Returns

(Array): Returns the new flattened array.

Example

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

_.flattenDepth(depth, array)

# Ⓢ Ⓣ Ⓝ

Recursively flatten array up to depth times.

Since

4.4.0

Arguments

  1. depth (number): The maximum recursion depth.
  2. array (Array): The array to flatten.

Returns

(Array): Returns the new flattened array.

Example

var array = [1, [2, [3, [4]], 5]];

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

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

_.fromPairs(pairs)

# Ⓢ Ⓣ Ⓝ

The inverse of _.toPairs; this method returns an object composed from key-value pairs.

Since

4.0.0

Arguments

  1. pairs (Array): The key-value pairs.

Returns

(Object): Returns the new object.

Example

_.fromPairs([['a', 1], ['b', 2]]);
// => { 'a': 1, 'b': 2 }

_.head(array)

# Ⓢ Ⓣ Ⓝ

Gets the first element of array.

Since

0.1.0

Aliases

_.first

Arguments

  1. array (Array): The array to query.

Returns

(*): Returns the first element of array.

Example

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

_.head([]);
// => undefined

_.indexOf(value, array)

# Ⓢ Ⓣ Ⓝ

Gets the index at which the first occurrence of value is found in array using SameValueZero for equality comparisons. If fromIndex is negative, it's used as the offset from the end of array.

Since

0.1.0

Arguments

  1. value (*): The value to search for.
  2. array (Array): The array to inspect.

Returns

(number): Returns the index of the matched value, else -1.

Example

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

// Search from the `fromIndex`.
_.indexOf([2, 2], [1, 2, 1, 2]);
// => 3

_.initial(array)

# Ⓢ Ⓣ Ⓝ

Gets all but the last element of array.

Since

0.1.0

Arguments

  1. array (Array): The array to query.

Returns

(Array): Returns the slice of array.

Example

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

_.intersection(arrays, arrays)

# Ⓢ Ⓣ Ⓝ

Creates an array of unique values that are included in all given arrays using SameValueZero for equality comparisons. The order and references of result values are determined by the first array.

Since

0.1.0

Arguments

  1. arrays (Array): The arrays to inspect.
  2. arrays (Array): The arrays to inspect.

Returns

(Array): Returns the new array of intersecting values.

Example

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

_.intersectionBy(iteratee, arrays, arrays)

# Ⓢ Ⓣ Ⓝ

This method is like _.intersection except that it accepts iteratee which is invoked for each element of each arrays to generate the criterion by which they're compared. The order and references of result values are determined by the first array. The iteratee is invoked with one argument:
(value).

Since

4.0.0

Arguments

  1. iteratee (Function): The iteratee invoked per element.
  2. arrays (Array): The arrays to inspect.
  3. arrays (Array): The arrays to inspect.

Returns

(Array): Returns the new array of intersecting values.

Example

_.intersectionBy(Math.floor, [2.1, 1.2], [2.3, 3.4]);
// => [2.1]

// The `_.property` iteratee shorthand.
_.intersectionBy('x', [{ 'x': 1 }], [{ 'x': 2 }, { 'x': 1 }]);
// => [{ 'x': 1 }]

_.intersectionWith(comparator, arrays, arrays)

# Ⓢ Ⓣ Ⓝ

This method is like _.intersection except that it accepts comparator which is invoked to compare elements of arrays. The order and references of result values are determined by the first array. The comparator is invoked with two arguments: (arrVal, othVal).

Since

4.0.0

Arguments

  1. comparator (Function): The comparator invoked per element.
  2. arrays (Array): The arrays to inspect.
  3. arrays (Array): The arrays to inspect.

Returns

(Array): Returns the new array of intersecting values.

Example

var objects = [{ 'x': 1, 'y': 2 }, { 'x': 2, 'y': 1 }];
var others = [{ 'x': 1, 'y': 1 }, { 'x': 1, 'y': 2 }];

_.intersectionWith(_.isEqual, objects, others);
// => [{ 'x': 1, 'y': 2 }]

_.join(separator, array)

# Ⓢ Ⓣ Ⓝ

Converts all elements in array into a string separated by separator.

Since

4.0.0

Arguments

  1. separator (string): The element separator.
  2. array (Array): The array to convert.

Returns

(string): Returns the joined string.

Example

_.join('~', ['a', 'b', 'c']);
// => 'a~b~c'

_.last(array)

# Ⓢ Ⓣ Ⓝ

Gets the last element of array.

Since

0.1.0

Arguments

  1. array (Array): The array to query.

Returns

(*): Returns the last element of array.

Example

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

_.lastIndexOf(value, array)

# Ⓢ Ⓣ Ⓝ

This method is like _.indexOf except that it iterates over elements of array from right to left.

Since

0.1.0

Arguments

  1. value (*): The value to search for.
  2. array (Array): The array to inspect.

Returns

(number): Returns the index of the matched value, else -1.

Example

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

// Search from the `fromIndex`.
_.lastIndexOf([2, 2], [1, 2, 1, 2]);
// => 1

_.nth(n, array)

# Ⓢ Ⓣ Ⓝ

Gets the element at index n of array. If n is negative, the nth element from the end is returned.

Since

4.11.0

Arguments

  1. n (number): The index of the element to return.
  2. array (Array): The array to query.

Returns

(*): Returns the nth element of array.

Example

var array = ['a', 'b', 'c', 'd'];

_.nth(1, array);
// => 'b'

_.nth(-2, array);
// => 'c';

_.pull(values, array)

# Ⓢ Ⓣ Ⓝ

Removes all given values from array using SameValueZero for equality comparisons.

Since

2.0.0

Arguments

  1. values (*|*[]): The values to remove.
  2. array (Array): The array to modify.

Returns

(Array): Returns array.

Example

var array = ['a', 'b', 'c', 'a', 'b', 'c'];

_.pull(['a', 'c'], array);
// => ['b', 'b']

_.pullAll(values, array)

# Ⓢ Ⓣ Ⓝ

This method is like _.pull except that it accepts an array of values to remove.

Since

4.0.0

Arguments

  1. values (Array): The values to remove.
  2. array (Array): The array to modify.

Returns

(Array): Returns array.

Example

var array = ['a', 'b', 'c', 'a', 'b', 'c'];

_.pullAll(['a', 'c'], array);
// => ['b', 'b']

_.pullAllBy(iteratee, values, array)

# Ⓢ Ⓣ Ⓝ

This method is like _.pullAll except that it accepts iteratee which is invoked for each element of array and values to generate the criterion by which they're compared. The iteratee is invoked with one argument: (value).

Since

4.0.0

Arguments

  1. iteratee (Function): The iteratee invoked per element.
  2. values (Array): The values to remove.
  3. array (Array): The array to modify.

Returns

(Array): Returns array.

Example

var array = [{ 'x': 1 }, { 'x': 2 }, { 'x': 3 }, { 'x': 1 }];

_.pullAllBy('x', [{ 'x': 1 }, { 'x': 3 }], array);
// => [{ 'x': 2 }]

_.pullAllWith(comparator, values, array)

# Ⓢ Ⓣ Ⓝ

This method is like _.pullAll except that it accepts comparator which is invoked to compare elements of array to values. The comparator is invoked with two arguments: (arrVal, othVal).

Since

4.6.0

Arguments

  1. comparator (Function): The comparator invoked per element.
  2. values (Array): The values to remove.
  3. array (Array): The array to modify.

Returns

(Array): Returns array.

Example

var array = [{ 'x': 1, 'y': 2 }, { 'x': 3, 'y': 4 }, { 'x': 5, 'y': 6 }];

_.pullAllWith(_.isEqual, [{ 'x': 3, 'y': 4 }], array);
// => [{ 'x': 1, 'y': 2 }, { 'x': 5, 'y': 6 }]

_.pullAt(indexes, array)

# Ⓢ Ⓣ Ⓝ

Removes elements from array corresponding to indexes and returns an array of removed elements.

Since

3.0.0

Arguments

  1. indexes (number|number[]): The indexes of elements to remove.
  2. array (Array): The array to modify.

Returns

(Array): Returns the new array of removed elements.

Example

var array = ['a', 'b', 'c', 'd'];
var pulled = _.pullAt([1, 3], array);

// => ['a', 'c']

// => ['b', 'd']

_.remove(predicate, array)

# Ⓢ Ⓣ Ⓝ

Removes all elements from array that predicate returns truthy for and returns an array of the removed elements. The predicate is invoked with three arguments: (value, index, array).

Since

2.0.0

Arguments

  1. predicate (Function): The function invoked per iteration.
  2. array (Array): The array to modify.

Returns

(Array): Returns the new array of removed elements.

Example

var array = [1, 2, 3, 4];
var evens = _.remove(function(n) {
  return n % 2 == 0;
}, array);

// => [1, 3]

// => [2, 4]

_.reverse(array)

# Ⓢ Ⓣ Ⓝ

Reverses array so that the first element becomes the last, the second element becomes the second to last, and so on.

Since

4.0.0

Arguments

  1. array (Array): The array to modify.

Returns

(Array): Returns array.

Example

var array = [1, 2, 3];

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

// => [3, 2, 1]

_.slice(start, end, array)

# Ⓢ Ⓣ Ⓝ

Creates a slice of array from start up to, but not including, end.

Note: This method is used instead of Array#slice to ensure dense arrays are returned.

Since

3.0.0

Arguments

  1. start (number): The start position.
  2. end (number): The end position.
  3. array (Array): The array to slice.

Returns

(Array): Returns the slice of array.

_.sortedIndex(value, array)

# Ⓢ Ⓣ Ⓝ

Uses a binary search to determine the lowest index at which value should be inserted into array in order to maintain its sort order.

Since

0.1.0

Arguments

  1. value (*): The value to evaluate.
  2. array (Array): The sorted array to inspect.

Returns

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

Example

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

_.sortedIndexBy(iteratee, value, array)

# Ⓢ Ⓣ Ⓝ

This method is like _.sortedIndex except that it accepts iteratee which is invoked for value and each element of array to compute their sort ranking. The iteratee is invoked with one argument: (value).

Since

4.0.0

Arguments

  1. iteratee (Function): The iteratee invoked per element.
  2. value (*): The value to evaluate.
  3. array (Array): The sorted array to inspect.

Returns

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

Example

var objects = [{ 'x': 4 }, { 'x': 5 }];

_.sortedIndexBy(function(o) { return o.x; }, { 'x': 4 }, objects);
// => 0

// The `_.property` iteratee shorthand.
_.sortedIndexBy('x', { 'x': 4 }, objects);
// => 0

_.sortedIndexOf(value, array)

# Ⓢ Ⓣ Ⓝ

This method is like _.indexOf except that it performs a binary search on a sorted array.

Since

4.0.0

Arguments

  1. value (*): The value to search for.
  2. array (Array): The array to inspect.

Returns

(number): Returns the index of the matched value, else -1.

Example

_.sortedIndexOf(5, [4, 5, 5, 5, 6]);
// => 1

_.sortedLastIndex(value, array)

# Ⓢ Ⓣ Ⓝ

This method is like _.sortedIndex except that it returns the highest index at which value should be inserted into array in order to maintain its sort order.

Since

3.0.0

Arguments

  1. value (*): The value to evaluate.
  2. array (Array): The sorted array to inspect.

Returns

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

Example

_.sortedLastIndex(5, [4, 5, 5, 5, 6]);
// => 4

_.sortedLastIndexBy(iteratee, value, array)

# Ⓢ Ⓣ Ⓝ

This method is like _.sortedLastIndex except that it accepts iteratee which is invoked for value and each element of array to compute their sort ranking. The iteratee is invoked with one argument: (value).

Since

4.0.0

Arguments

  1. iteratee (Function): The iteratee invoked per element.
  2. value (*): The value to evaluate.
  3. array (Array): The sorted array to inspect.

Returns

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

Example

var objects = [{ 'x': 4 }, { 'x': 5 }];

_.sortedLastIndexBy(function(o) { return o.x; }, { 'x': 4 }, objects);
// => 1

// The `_.property` iteratee shorthand.
_.sortedLastIndexBy('x', { 'x': 4 }, objects);
// => 1

_.sortedLastIndexOf(value, array)

# Ⓢ Ⓣ Ⓝ

This method is like _.lastIndexOf except that it performs a binary search on a sorted array.

Since

4.0.0

Arguments

  1. value (*): The value to search for.
  2. array (Array): The array to inspect.

Returns

(number): Returns the index of the matched value, else -1.

Example

_.sortedLastIndexOf(5, [4, 5, 5, 5, 6]);
// => 3

_.sortedUniq(array)

# Ⓢ Ⓣ Ⓝ

This method is like _.uniq except that it's designed and optimized for sorted arrays.

Since

4.0.0

Arguments

  1. array (Array): The array to inspect.

Returns

(Array): Returns the new duplicate free array.

Example

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

_.sortedUniqBy(iteratee, array)

# Ⓢ Ⓣ Ⓝ

This method is like _.uniqBy except that it's designed and optimized for sorted arrays.

Since

4.0.0

Arguments

  1. iteratee (Function): The iteratee invoked per element.
  2. array (Array): The array to inspect.

Returns

(Array): Returns the new duplicate free array.

Example

_.sortedUniqBy(Math.floor, [1.1, 1.2, 2.3, 2.4]);
// => [1.1, 2.3]

_.tail(array)

# Ⓢ Ⓣ Ⓝ

Gets all but the first element of array.

Since

4.0.0

Arguments

  1. array (Array): The array to query.

Returns

(Array): Returns the slice of array.

Example

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

_.take(n, array)

# Ⓢ Ⓣ Ⓝ

Creates a slice of array with n elements taken from the beginning.

Since

0.1.0

Arguments

  1. n (number): The number of elements to take.
  2. array (Array): The array to query.

Returns

(Array): Returns the slice of array.

Example

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

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

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

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

_.takeRight(n, array)

# Ⓢ Ⓣ Ⓝ

Creates a slice of array with n elements taken from the end.

Since

3.0.0

Arguments

  1. n (number): The number of elements to take.
  2. array (Array): The array to query.

Returns

(Array): Returns the slice of array.

Example

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

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

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

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

_.takeRightWhile(predicate, array)

# Ⓢ Ⓣ Ⓝ

Creates a slice of array with elements taken from the end. Elements are taken until predicate returns falsey. The predicate is invoked with three arguments: (value, index, array).

Since

3.0.0

Arguments

  1. predicate (Function): The function invoked per iteration.
  2. array (Array): The array to query.

Returns

(Array): Returns the slice of array.

Example

var users = [
  { 'user': 'barney',  'active': true },
  { 'user': 'fred',    'active': false },
  { 'user': 'pebbles', 'active': false }
];

_.takeRightWhile(function(o) { return !o.active; }, users);
// => objects for ['fred', 'pebbles']

// The `_.matches` iteratee shorthand.
_.takeRightWhile({ 'user': 'pebbles', 'active': false }, users);
// => objects for ['pebbles']

// The `_.matchesProperty` iteratee shorthand.
_.takeRightWhile(['active', false], users);
// => objects for ['fred', 'pebbles']

// The `_.property` iteratee shorthand.
_.takeRightWhile('active', users);
// => []

_.takeWhile(predicate, array)

# Ⓢ Ⓣ Ⓝ

Creates a slice of array with elements taken from the beginning. Elements are taken until predicate returns falsey. The predicate is invoked with three arguments: (value, index, array).

Since

3.0.0

Arguments

  1. predicate (Function): The function invoked per iteration.
  2. array (Array): The array to query.

Returns

(Array): Returns the slice of array.

Example

var users = [
  { 'user': 'barney',  'active': false },
  { 'user': 'fred',    'active': false },
  { 'user': 'pebbles', 'active': true }
];

_.takeWhile(function(o) { return !o.active; }, users);
// => objects for ['barney', 'fred']

// The `_.matches` iteratee shorthand.
_.takeWhile({ 'user': 'barney', 'active': false }, users);
// => objects for ['barney']

// The `_.matchesProperty` iteratee shorthand.
_.takeWhile(['active', false], users);
// => objects for ['barney', 'fred']

// The `_.property` iteratee shorthand.
_.takeWhile('active', users);
// => []

_.union(arrays, arrays)

# Ⓢ Ⓣ Ⓝ

Creates an array of unique values, in order, from all given arrays using SameValueZero for equality comparisons.

Since

0.1.0

Arguments

  1. arrays (Array): The arrays to inspect.
  2. arrays (Array): The arrays to inspect.

Returns

(Array): Returns the new array of combined values.

Example

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

_.unionBy(iteratee, arrays, arrays)

# Ⓢ Ⓣ Ⓝ

This method is like _.union except that it accepts iteratee which is invoked for each element of each arrays to generate the criterion by which uniqueness is computed. Result values are chosen from the first array in which the value occurs. The iteratee is invoked with one argument:
(value).

Since

4.0.0

Arguments

  1. iteratee (Function): The iteratee invoked per element.
  2. arrays (Array): The arrays to inspect.
  3. arrays (Array): The arrays to inspect.

Returns

(Array): Returns the new array of combined values.

Example

_.unionBy(Math.floor, [2.1], [1.2, 2.3]);
// => [2.1, 1.2]

// The `_.property` iteratee shorthand.
_.unionBy('x', [{ 'x': 1 }], [{ 'x': 2 }, { 'x': 1 }]);
// => [{ 'x': 1 }, { 'x': 2 }]

_.unionWith(comparator, arrays, arrays)

# Ⓢ Ⓣ Ⓝ

This method is like _.union except that it accepts comparator which is invoked to compare elements of arrays. Result values are chosen from the first array in which the value occurs. The comparator is invoked with two arguments: (arrVal, othVal).

Since

4.0.0

Arguments

  1. comparator (Function): The comparator invoked per element.
  2. arrays (Array): The arrays to inspect.
  3. arrays (Array): The arrays to inspect.

Returns

(Array): Returns the new array of combined values.

Example

var objects = [{ 'x': 1, 'y': 2 }, { 'x': 2, 'y': 1 }];
var others = [{ 'x': 1, 'y': 1 }, { 'x': 1, 'y': 2 }];

_.unionWith(_.isEqual, objects, others);
// => [{ 'x': 1, 'y': 2 }, { 'x': 2, 'y': 1 }, { 'x': 1, 'y': 1 }]

_.uniq(array)

# Ⓢ Ⓣ Ⓝ

Creates a duplicate-free version of an array, using SameValueZero for equality comparisons, in which only the first occurrence of each element is kept. The order of result values is determined by the order they occur in the array.

Since

0.1.0

Arguments

  1. array (Array): The array to inspect.

Returns

(Array): Returns the new duplicate free array.

Example

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

_.uniqBy(iteratee, array)

# Ⓢ Ⓣ Ⓝ

This method is like _.uniq except that it accepts iteratee which is invoked for each element in array to generate the criterion by which uniqueness is computed. The order of result values is determined by the order they occur in the array. The iteratee is invoked with one argument:
(value).

Since

4.0.0

Arguments

  1. iteratee (Function): The iteratee invoked per element.
  2. array (Array): The array to inspect.

Returns

(Array): Returns the new duplicate free array.

Example

_.uniqBy(Math.floor, [2.1, 1.2, 2.3]);
// => [2.1, 1.2]

// The `_.property` iteratee shorthand.
_.uniqBy('x', [{ 'x': 1 }, { 'x': 2 }, { 'x': 1 }]);
// => [{ 'x': 1 }, { 'x': 2 }]

_.uniqWith(comparator, array)

# Ⓢ Ⓣ Ⓝ

This method is like _.uniq except that it accepts comparator which is invoked to compare elements of array. The order of result values is determined by the order they occur in the array.The comparator is invoked with two arguments: (arrVal, othVal).

Since

4.0.0

Arguments

  1. comparator (Function): The comparator invoked per element.
  2. array (Array): The array to inspect.

Returns

(Array): Returns the new duplicate free array.

Example

var objects = [{ 'x': 1, 'y': 2 }, { 'x': 2, 'y': 1 }, { 'x': 1, 'y': 2 }];

_.uniqWith(_.isEqual, objects);
// => [{ 'x': 1, 'y': 2 }, { 'x': 2, 'y': 1 }]

_.unzip(array)

# Ⓢ Ⓣ Ⓝ

This method is like _.zip except that it accepts an array of grouped elements and creates an array regrouping the elements to their pre-zip configuration.

Since

1.2.0

Arguments

  1. array (Array): The array of grouped elements to process.

Returns

(Array): Returns the new array of regrouped elements.

Example

var zipped = _.zip(['a', 'b'], [[1, 2], [true, false]]);
// => [['a', 1, true], ['b', 2, false]]

_.unzip(zipped);
// => [['a', 'b'], [1, 2], [true, false]]

_.unzipWith(iteratee, array)

# Ⓢ Ⓣ Ⓝ

This method is like _.unzip except that it accepts iteratee to specify how regrouped values should be combined. The iteratee is invoked with the elements of each group: (...group).

Since

3.8.0

Arguments

  1. iteratee (Function): The function to combine regrouped values.
  2. array (Array): The array of grouped elements to process.

Returns

(Array): Returns the new array of regrouped elements.

Example

var zipped = _.zip([1, 2], [[10, 20], [100, 200]]);
// => [[1, 10, 100], [2, 20, 200]]

_.unzipWith(_.add, zipped);
// => [3, 30, 300]

_.without(values, array)

# Ⓢ Ⓣ Ⓝ

Creates an array excluding all given values using SameValueZero for equality comparisons.

Note: Unlike _.pull, this method returns a new array.

Since

0.1.0

Arguments

  1. values (*|*[]): The values to exclude.
  2. array (Array): The array to inspect.

Returns

(Array): Returns the new array of filtered values.

Example

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

_.xor(arrays, arrays)

# Ⓢ Ⓣ Ⓝ

Creates an array of unique values that is the symmetric difference of the given arrays. The order of result values is determined by the order they occur in the arrays.

Since

2.4.0

Arguments

  1. arrays (Array): The arrays to inspect.
  2. arrays (Array): The arrays to inspect.

Returns

(Array): Returns the new array of filtered values.

Example

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

_.xorBy(iteratee, arrays, arrays)

# Ⓢ Ⓣ Ⓝ

This method is like _.xor except that it accepts iteratee which is invoked for each element of each arrays to generate the criterion by which by which they're compared. The order of result values is determined by the order they occur in the arrays. The iteratee is invoked with one argument: (value).

Since

4.0.0

Arguments

  1. iteratee (Function): The iteratee invoked per element.
  2. arrays (Array): The arrays to inspect.
  3. arrays (Array): The arrays to inspect.

Returns

(Array): Returns the new array of filtered values.

Example

_.xorBy(Math.floor, [2.1, 1.2], [2.3, 3.4]);
// => [1.2, 3.4]

// The `_.property` iteratee shorthand.
_.xorBy('x', [{ 'x': 1 }], [{ 'x': 2 }, { 'x': 1 }]);
// => [{ 'x': 2 }]

_.xorWith(comparator, arrays, arrays)

# Ⓢ Ⓣ Ⓝ

This method is like _.xor except that it accepts comparator which is invoked to compare elements of arrays. The order of result values is determined by the order they occur in the arrays. The comparator is invoked with two arguments: (arrVal, othVal).

Since

4.0.0

Arguments

  1. comparator (Function): The comparator invoked per element.
  2. arrays (Array): The arrays to inspect.
  3. arrays (Array): The arrays to inspect.

Returns

(Array): Returns the new array of filtered values.

Example

var objects = [{ 'x': 1, 'y': 2 }, { 'x': 2, 'y': 1 }];
var others = [{ 'x': 1, 'y': 1 }, { 'x': 1, 'y': 2 }];

_.xorWith(_.isEqual, objects, others);
// => [{ 'x': 2, 'y': 1 }, { 'x': 1, 'y': 1 }]

_.zip(arrays, arrays)

# Ⓢ Ⓣ Ⓝ

Creates an array of grouped elements, the first of which contains the first elements of the given arrays, the second of which contains the second elements of the given arrays, and so on.

Since

0.1.0

Arguments

  1. arrays (Array): The arrays to process.
  2. arrays (Array): The arrays to process.

Returns

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

Example

_.zip(['a', 'b'], [[1, 2], [true, false]]);
// => [['a', 1, true], ['b', 2, false]]

_.zipObject(props, values)

# Ⓢ Ⓣ Ⓝ

This method is like _.fromPairs except that it accepts two arrays, one of property identifiers and one of corresponding values.

Since

0.4.0

Arguments

  1. props (Array): The property identifiers.
  2. values (Array): The property values.

Returns

(Object): Returns the new object.

Example

_.zipObject(['a', 'b'], [1, 2]);
// => { 'a': 1, 'b': 2 }

_.zipObjectDeep(props, values)

# Ⓢ Ⓣ Ⓝ

This method is like _.zipObject except that it supports property paths.

Since

4.1.0

Arguments

  1. props (Array): The property identifiers.
  2. values (Array): The property values.

Returns

(Object): Returns the new object.

Example

_.zipObjectDeep(['a.b[0].c', 'a.b[1].d'], [1, 2]);
// => { 'a': { 'b': [{ 'c': 1 }, { 'd': 2 }] } }

_.zipWith(iteratee, arrays, arrays)

# Ⓢ Ⓣ Ⓝ

This method is like _.zip except that it accepts iteratee to specify how grouped values should be combined. The iteratee is invoked with the elements of each group: (...group).

Since

3.8.0

Arguments

  1. iteratee (Function): The function to combine grouped values.
  2. arrays (Array): The arrays to process.
  3. arrays (Array): The arrays to process.

Returns

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

Example

_.zipWith([[100, 200], function(a, b, c) {
  return a + b + c;
}], [1, 2], [10, 20]);
// => [111, 222]

“Collection” Methods

_.countBy(iteratee, collection)

# Ⓢ Ⓣ Ⓝ

Creates an object composed of keys generated from the results of running each element of collection thru iteratee. The corresponding value of each key is the number of times the key was returned by iteratee. The iteratee is invoked with one argument: (value).

Since

0.5.0

Arguments

  1. iteratee (Function): The iteratee to transform keys.
  2. collection (Array|Object): The collection to iterate over.

Returns

(Object): Returns the composed aggregate object.

Example

_.countBy(Math.floor, [6.1, 4.2, 6.3]);
// => { '4': 1, '6': 2 }

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

_.every(predicate, collection)

# Ⓢ Ⓣ Ⓝ

Checks if predicate returns truthy for all elements of collection. Iteration is stopped once predicate returns falsey. The predicate is invoked with three arguments: (value, index|key, collection).

Note: This method returns true for empty collections because everything is true of elements of empty collections.

Since

0.1.0

Arguments

  1. predicate (Function): The function invoked per iteration.
  2. collection (Array|Object): The collection to iterate over.

Returns

(boolean): Returns true if all elements pass the predicate check, else false.

Example

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

var users = [
  { 'user': 'barney', 'age': 36, 'active': false },
  { 'user': 'fred',   'age': 40, 'active': false }
];

// The `_.matches` iteratee shorthand.
_.every({ 'user': 'barney', 'active': false }, users);
// => false

// The `_.matchesProperty` iteratee shorthand.
_.every(['active', false], users);
// => true

// The `_.property` iteratee shorthand.
_.every('active', users);
// => false

_.filter(predicate, collection)

# Ⓢ Ⓣ Ⓝ

Iterates over elements of collection, returning an array of all elements predicate returns truthy for. The predicate is invoked with three arguments: (value, index|key, collection).

Note: Unlike _.remove, this method returns a new array.

Since

0.1.0

Arguments

  1. predicate (Function): The function invoked per iteration.
  2. collection (Array|Object): The collection to iterate over.

Returns

(Array): Returns the new filtered array.

Example

var users = [
  { 'user': 'barney', 'age': 36, 'active': true },
  { 'user': 'fred',   'age': 40, 'active': false }
];

_.filter(function(o) { return !o.active; }, users);
// => objects for ['fred']

// The `_.matches` iteratee shorthand.
_.filter({ 'age': 36, 'active': true }, users);
// => objects for ['barney']

// The `_.matchesProperty` iteratee shorthand.
_.filter(['active', false], users);
// => objects for ['fred']

// The `_.property` iteratee shorthand.
_.filter('active', users);
// => objects for ['barney']

// Combining several predicates using `_.overEvery` or `_.overSome`.
_.filter(_.overSome([{ 'age': 36 }, ['age', 40]]), users);
// => objects for ['fred', 'barney']

_.find(predicate, collection)

# Ⓢ Ⓣ Ⓝ

Iterates over elements of collection, returning the first element predicate returns truthy for. The predicate is invoked with three arguments: (value, index|key, collection).

Since

0.1.0

Arguments

  1. predicate (Function): The function invoked per iteration.
  2. collection (Array|Object): The collection to inspect.

Returns

(*): Returns the matched element, else undefined.

Example

var users = [
  { 'user': 'barney',  'age': 36, 'active': true },
  { 'user': 'fred',    'age': 40, 'active': false },
  { 'user': 'pebbles', 'age': 1,  'active': true }
];

_.find(function(o) { return o.age < 40; }, users);
// => object for 'barney'

// The `_.matches` iteratee shorthand.
_.find({ 'age': 1, 'active': true }, users);
// => object for 'pebbles'

// The `_.matchesProperty` iteratee shorthand.
_.find(['active', false], users);
// => object for 'fred'

// The `_.property` iteratee shorthand.
_.find('active', users);
// => object for 'barney'

_.findLast(predicate, collection)

# Ⓢ Ⓣ Ⓝ

This method is like _.find except that it iterates over elements of collection from right to left.

Since

2.0.0

Arguments

  1. predicate (Function): The function invoked per iteration.
  2. collection (Array|Object): The collection to inspect.

Returns

(*): Returns the matched element, else undefined.

Example

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

_.flatMap(iteratee, collection)

# Ⓢ Ⓣ Ⓝ

Creates a flattened array of values by running each element in collection thru iteratee and flattening the mapped results. The iteratee is invoked with three arguments: (value, index|key, collection).

Since

4.0.0

Arguments

  1. iteratee (Function): The function invoked per iteration.
  2. collection (Array|Object): The collection to iterate over.

Returns

(Array): Returns the new flattened array.

Example

function duplicate(n) {
  return [n, n];
}

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

_.flatMapDeep(iteratee, collection)

# Ⓢ Ⓣ Ⓝ

This method is like _.flatMap except that it recursively flattens the mapped results.

Since

4.7.0

Arguments

  1. iteratee (Function): The function invoked per iteration.
  2. collection (Array|Object): The collection to iterate over.

Returns

(Array): Returns the new flattened array.

Example

function duplicate(n) {
  return [[[n, n]]];
}

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

_.flatMapDepth(iteratee, depth, collection)

# Ⓢ Ⓣ Ⓝ

This method is like _.flatMap except that it recursively flattens the mapped results up to depth times.

Since

4.7.0

Arguments

  1. iteratee (Function): The function invoked per iteration.
  2. depth (number): The maximum recursion depth.
  3. collection (Array|Object): The collection to iterate over.

Returns

(Array): Returns the new flattened array.

Example

function duplicate(n) {
  return [[[n, n]]];
}

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

_.forEach(iteratee, collection)

# Ⓢ Ⓣ Ⓝ

Iterates over elements of collection and invokes iteratee for each element. The iteratee is 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 use _.forIn or _.forOwn for object iteration.

Since

0.1.0

Aliases

_.each

Arguments

  1. iteratee (Function): The function invoked per iteration.
  2. collection (Array|Object): The collection to iterate over.

Returns

(*): Returns collection.

Example

_.forEach(function(value) {
  console.log(value);
}, [1, 2]);
// => Logs `1` then `2`.

_.forEach(function(value, key) {
  console.log(key);
}, { 'a': 1, 'b': 2 });
// => Logs 'a' then 'b' (iteration order is not guaranteed).

_.forEachRight(iteratee, collection)

# Ⓢ Ⓣ Ⓝ

This method is like _.forEach except that it iterates over elements of collection from right to left.

Since

2.0.0

Aliases

_.eachRight

Arguments

  1. iteratee (Function): The function invoked per iteration.
  2. collection (Array|Object): The collection to iterate over.

Returns

(*): Returns collection.

Example

_.forEachRight(function(value) {
  console.log(value);
}, [1, 2]);
// => Logs `2` then `1`.

_.groupBy(iteratee, collection)

# Ⓢ Ⓣ Ⓝ

Creates an object composed of keys generated from the results of running each element of collection thru iteratee. The order of grouped values is determined by the order they occur in collection. The corresponding value of each key is an array of elements responsible for generating the key. The iteratee is invoked with one argument: (value).

Since

0.1.0

Arguments

  1. iteratee (Function): The iteratee to transform keys.
  2. collection (Array|Object): The collection to iterate over.

Returns

(Object): Returns the composed aggregate object.

Example

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

// The `_.property` iteratee shorthand.
_.groupBy('length', ['one', 'two', 'three']);
// => { '3': ['one', 'two'], '5': ['three'] }

_.includes(value, collection)

# Ⓢ Ⓣ Ⓝ

Checks if value is in collection. If collection is a string, it's checked for a substring of value, otherwise SameValueZero is used for equality comparisons. If fromIndex is negative, it's used as the offset from the end of collection.

Since

0.1.0

Arguments

  1. value (*): The value to search for.
  2. collection (Array|Object|string): The collection to inspect.

Returns

(boolean): Returns true if value is found, else false.

Example

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

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

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

_.includes('bc', 'abcd');
// => true

_.invokeMap(path, collection)

# Ⓢ Ⓣ Ⓝ

Invokes the method at path of each element in collection, returning an array of the results of each invoked method. Any additional arguments are provided to each invoked method. If path is a function, it's invoked for, and this bound to, each element in collection.

Since

4.0.0

Arguments

  1. path (Array|Function|string): The path of the method to invoke or the function invoked per iteration.
  2. collection (Array|Object): The collection to iterate over.

Returns

(Array): Returns the array of results.

Example

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

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

_.keyBy(iteratee, collection)

# Ⓢ Ⓣ Ⓝ

Creates an object composed of keys generated from the results of running each element of collection thru iteratee. The corresponding value of each key is the last element responsible for generating the key. The iteratee is invoked with one argument: (value).

Since

4.0.0

Arguments

  1. iteratee (Function): The iteratee to transform keys.
  2. collection (Array|Object): The collection to iterate over.

Returns

(Object): Returns the composed aggregate object.

Example

var array = [
  { 'dir': 'left', 'code': 97 },
  { 'dir': 'right', 'code': 100 }
];

_.keyBy(function(o) {
  return String.fromCharCode(o.code);
}, array);
// => { 'a': { 'dir': 'left', 'code': 97 }, 'd': { 'dir': 'right', 'code': 100 } }

_.keyBy('dir', array);
// => { 'left': { 'dir': 'left', 'code': 97 }, 'right': { 'dir': 'right', 'code': 100 } }

_.map(iteratee, collection)

# Ⓢ Ⓣ Ⓝ

Creates an array of values by running each element in collection thru iteratee. The iteratee is invoked with three arguments:
(value, index|key, collection).

Many lodash methods are guarded to work as iteratees for methods like _.every, _.filter, _.map, _.mapValues, _.reject, and _.some.

The guarded methods are:
ary, chunk, curry, curryRight, drop, dropRight, every, fill, invert, parseInt, random, range, rangeRight, repeat, sampleSize, slice, some, sortBy, split, take, takeRight, template, trim, trimEnd, trimStart, and words

Since

0.1.0

Arguments

  1. iteratee (Function): The function invoked per iteration.
  2. collection (Array|Object): The collection to iterate over.

Returns

(Array): Returns the new mapped array.

Example

function square(n) {
  return n * n;
}

_.map(square, [4, 8]);
// => [16, 64]

_.map(square, { 'a': 4, 'b': 8 });
// => [16, 64] (iteration order is not guaranteed)

var users = [
  { 'user': 'barney' },
  { 'user': 'fred' }
];

// The `_.property` iteratee shorthand.
_.map('user', users);
// => ['barney', 'fred']

_.orderBy(iteratees, orders, collection)

# Ⓢ Ⓣ Ⓝ

This method is like _.sortBy except that it allows specifying the sort orders of the iteratees to sort by. If orders is unspecified, all values are sorted in ascending order. Otherwise, specify an order of "desc" for descending or "asc" for ascending sort order of corresponding values.

Since

4.0.0

Arguments

  1. iteratees (Array[]|Function[]|Object[]|string[]): The iteratees to sort by.
  2. orders (string[]): The sort orders of iteratees.
  3. collection (Array|Object): The collection to iterate over.

Returns

(Array): Returns the new sorted array.

Example

var users = [
  { 'user': 'fred',   'age': 48 },
  { 'user': 'barney', 'age': 34 },
  { 'user': 'fred',   'age': 40 },
  { 'user': 'barney', 'age': 36 }
];

// Sort by `user` in ascending order and by `age` in descending order.
_.orderBy(['user', 'age'], ['asc', 'desc'], users);
// => objects for [['barney', 36], ['barney', 34], ['fred', 48], ['fred', 40]]

_.partition(predicate, collection)

# Ⓢ Ⓣ Ⓝ

Creates an array of elements split into two groups, the first of which contains elements predicate returns truthy for, the second of which contains elements predicate returns falsey for. The predicate is invoked with one argument: (value).

Since

3.0.0

Arguments

  1. predicate (Function): The function invoked per iteration.
  2. collection (Array|Object): The collection to iterate over.

Returns

(Array): Returns the array of grouped elements.

Example

var users = [
  { 'user': 'barney',  'age': 36, 'active': false },
  { 'user': 'fred',    'age': 40, 'active': true },
  { 'user': 'pebbles', 'age': 1,  'active': false }
];

_.partition(function(o) { return o.active; }, users);
// => objects for [['fred'], ['barney', 'pebbles']]

// The `_.matches` iteratee shorthand.
_.partition({ 'age': 1, 'active': false }, users);
// => objects for [['pebbles'], ['barney', 'fred']]

// The `_.matchesProperty` iteratee shorthand.
_.partition(['active', false], users);
// => objects for [['barney', 'pebbles'], ['fred']]

// The `_.property` iteratee shorthand.
_.partition('active', users);
// => objects for [['fred'], ['barney', 'pebbles']]

_.reduce(iteratee, accumulator, collection)

# Ⓢ Ⓣ Ⓝ

Reduces collection to a value which is the accumulated result of running each element in collection thru iteratee, where each successive invocation is supplied the return value of the previous. If accumulator is not given, the first element of collection is used as the initial value. The iteratee is invoked with four arguments:
(accumulator, value, index|key, collection).

Many lodash methods are guarded to work as iteratees for methods like _.reduce, _.reduceRight, and _.transform.

The guarded methods are:
assign, defaults, defaultsDeep, includes, merge, orderBy, and sortBy

Since

0.1.0

Arguments

  1. iteratee (Function): The function invoked per iteration.
  2. accumulator (*): The initial value.
  3. collection (Array|Object): The collection to iterate over.

Returns

(*): Returns the accumulated value.

Example

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

_.reduce(function(result, value, key) {
  (result[value] || (result[value] = [])).push(key);
  return result;
}, {}, { 'a': 1, 'b': 2, 'c': 1 });
// => { '1': ['a', 'c'], '2': ['b'] } (iteration order is not guaranteed)

_.reduceRight(iteratee, accumulator, collection)

# Ⓢ Ⓣ Ⓝ

This method is like _.reduce except that it iterates over elements of collection from right to left.

Since

0.1.0

Arguments

  1. iteratee (Function): The function invoked per iteration.
  2. accumulator (*): The initial value.
  3. collection (Array|Object): The collection to iterate over.

Returns

(*): Returns the accumulated value.

Example

var array = [[0, 1], [2, 3], [4, 5]];

_.reduceRight(function(flattened, other) {
  return flattened.concat(other);
}, [], array);
// => [4, 5, 2, 3, 0, 1]

_.reject(predicate, collection)

# Ⓢ Ⓣ Ⓝ

The opposite of _.filter; this method returns the elements of collection that predicate does not return truthy for.

Since

0.1.0

Arguments

  1. predicate (Function): The function invoked per iteration.
  2. collection (Array|Object): The collection to iterate over.

Returns

(Array): Returns the new filtered array.

Example

var users = [
  { 'user': 'barney', 'age': 36, 'active': false },
  { 'user': 'fred',   'age': 40, 'active': true }
];

_.reject(function(o) { return !o.active; }, users);
// => objects for ['fred']

// The `_.matches` iteratee shorthand.
_.reject({ 'age': 40, 'active': true }, users);
// => objects for ['barney']

// The `_.matchesProperty` iteratee shorthand.
_.reject(['active', false], users);
// => objects for ['fred']

// The `_.property` iteratee shorthand.
_.reject('active', users);
// => objects for ['barney']

_.sample(collection)

# Ⓢ Ⓣ Ⓝ

Gets a random element from collection.

Since

2.0.0

Arguments

  1. collection (Array|Object): The collection to sample.

Returns

(*): Returns the random element.

Example

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

_.sampleSize(n, collection)

# Ⓢ Ⓣ Ⓝ

Gets n random elements at unique keys from collection up to the size of collection.

Since

4.0.0

Arguments

  1. n (number): The number of elements to sample.
  2. collection (Array|Object): The collection to sample.

Returns

(Array): Returns the random elements.

Example

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

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

_.shuffle(collection)

# Ⓢ Ⓣ Ⓝ

Creates an array of shuffled values, using a version of the Fisher-Yates shuffle.

Since

0.1.0

Arguments

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

Returns

(Array): Returns the new shuffled array.

Example

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

_.size(collection)

# Ⓢ Ⓣ Ⓝ

Gets the size of collection by returning its length for array-like values or the number of own enumerable string keyed properties for objects.

Since

0.1.0

Arguments

  1. collection (Array|Object|string): The collection to inspect.

Returns

(number): Returns the collection size.

Example

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

_.size({ 'a': 1, 'b': 2 });
// => 2

_.size('pebbles');
// => 7

_.some(predicate, collection)

# Ⓢ Ⓣ Ⓝ

Checks if predicate returns truthy for any element of collection. Iteration is stopped once predicate returns truthy. The predicate is invoked with three arguments: (value, index|key, collection).

Since

0.1.0

Arguments

  1. predicate (Function): The function invoked per iteration.
  2. collection (Array|Object): The collection to iterate over.

Returns

(boolean): Returns true if any element passes the predicate check, else false.

Example

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

var users = [
  { 'user': 'barney', 'active': true },
  { 'user': 'fred',   'active': false }
];

// The `_.matches` iteratee shorthand.
_.some({ 'user': 'barney', 'active': false }, users);
// => false

// The `_.matchesProperty` iteratee shorthand.
_.some(['active', false], users);
// => true

// The `_.property` iteratee shorthand.
_.some('active', users);
// => true

_.sortBy(iteratees, collection)

# Ⓢ Ⓣ Ⓝ

Creates an array of elements, sorted in ascending order by the results of running each element in a collection thru each iteratee. This method performs a stable sort, that is, it preserves the original sort order of equal elements. The iteratees are invoked with one argument: (value).

Since

0.1.0

Arguments

  1. iteratees (Function|Function[]): The iteratees to sort by.
  2. collection (Array|Object): The collection to iterate over.

Returns

(Array): Returns the new sorted array.

Example

var users = [
  { 'user': 'fred',   'age': 48 },
  { 'user': 'barney', 'age': 36 },
  { 'user': 'fred',   'age': 30 },
  { 'user': 'barney', 'age': 34 }
];

_.sortBy([function(o) { return o.user; }], users);
// => objects for [['barney', 36], ['barney', 34], ['fred', 48], ['fred', 30]]

_.sortBy(['user', 'age'], users);
// => objects for [['barney', 34], ['barney', 36], ['fred', 30], ['fred', 48]]

“Date” Methods

_.now()

# Ⓢ Ⓣ Ⓝ

Gets the timestamp of the number of milliseconds that have elapsed since the Unix epoch (1 January 1970 00:00:00 UTC).

Since

2.4.0

Returns

(number): Returns the timestamp.

Example

_.defer([function(stamp) {
  console.log(_.now(null) - stamp);
}, _.now()]);
// => Logs the number of milliseconds it took for the deferred invocation.

“Function” Methods

_.after(func, n)

# Ⓢ Ⓣ Ⓝ

The opposite of _.before; this method creates a function that invokes func once it's called n or more times.

Since

0.1.0

Arguments

  1. func (Function): The function to restrict.
  2. n (number): The number of calls before func is invoked.

Returns

(Function): Returns the new restricted function.

Example

var saves = ['profile', 'settings'];

var done = _.after(function() {
  console.log('done saving!');
}, saves.length);

_.forEach(function(type) {
  asyncSave({ 'type': type, 'complete': done });
}, saves);
// => Logs 'done saving!' after the two async saves have completed.

_.ary(n, func)

# Ⓢ Ⓣ Ⓝ

Creates a function that invokes func, with up to n arguments, ignoring any additional arguments.

Since

3.0.0

Arguments

  1. n (number): The arity cap.
  2. func (Function): The function to cap arguments for.

Returns

(Function): Returns the new capped function.

Example

_.map(_.ary(parseInt, 1), ['6', '8', '10']);
// => [6, 8, 10]

_.before(func, n)

# Ⓢ Ⓣ Ⓝ

Creates a function that invokes func, with the this binding and arguments of the created function, while it's called less than n times. Subsequent calls to the created function return the result of the last func invocation.

Since

3.0.0

Arguments

  1. func (Function): The function to restrict.
  2. n (number): The number of calls at which func is no longer invoked.

Returns

(Function): Returns the new restricted function.

Example

jQuery(element).on('click', _.before(addContactToList, 5));
// => Allows adding up to 4 contacts to the list.

_.bind(func, thisArg)

# Ⓢ Ⓣ Ⓝ

Creates a function that invokes func with the this binding of thisArg and partials prepended to the arguments it receives.

The _.bind.placeholder value, which defaults to _ in monolithic builds, may be used as a placeholder for partially applied arguments.

Note: Unlike native Function#bind, this method doesn't set the "length" property of bound functions.

Since

0.1.0

Arguments

  1. func (Function): The function to bind.
  2. thisArg (*): The this binding of func.

Returns

(Function): Returns the new bound function.

Example

function greet(greeting, punctuation) {
  return greeting + ' ' + this.user + punctuation;
}

var object = { 'user': 'fred' };

var bound = _.bind(greet, [object, 'hi']);
bound('!');
// => 'hi fred!'

// Bound with placeholders.
var bound = _.bind(greet, [object, _, '!']);
bound('hi');
// => 'hi fred!'

_.bindKey(object, key)

# Ⓢ Ⓣ Ⓝ

Creates a function that invokes the method at object[key] with partials prepended to the arguments it receives.

This method differs from _.bind by allowing bound functions to reference methods that may be redefined or don't yet exist. See Peter Michaux's article for more details.

The _.bindKey.placeholder value, which defaults to _ in monolithic builds, may be used as a placeholder for partially applied arguments.

Since

0.10.0

Arguments

  1. object (Object): The object to invoke the method on.
  2. key (string): The key of the method.

Returns

(Function): Returns the new bound function.

Example

var object = {
  'user': 'fred',
  'greet': function(greeting, punctuation) {
    return greeting + ' ' + this.user + punctuation;
  }
};

var bound = _.bindKey(object, ['greet', 'hi']);
bound('!');
// => 'hi fred!'

object.greet = function(greeting, punctuation) {
  return greeting + 'ya ' + this.user + punctuation;
};

bound('!');
// => 'hiya fred!'

// Bound with placeholders.
var bound = _.bindKey(object, ['greet', _, '!']);
bound('hi');
// => 'hiya fred!'

_.curry(func)

# Ⓢ Ⓣ Ⓝ

Creates a function that accepts arguments of func and either invokes func returning its result, if at least arity number of arguments have been provided, or returns a function that accepts the remaining func arguments, and so on. The arity of func may be specified if func.length is not sufficient.

The _.curry.placeholder value, which defaults to _ in monolithic builds, may be used as a placeholder for provided arguments.

Note: This method doesn't set the "length" property of curried functions.

Since

2.0.0

Arguments

  1. func (Function): The function to curry.

Returns

(Function): Returns the new curried function.

Example

var abc = function(a, b, c) {
  return [a, b, c];
};

var curried = _.curry(abc);

curried(1)(2)(3);
// => [1, 2, 3]

curried(1, 2)(3);
// => [1, 2, 3]

curried(1, 2, 3);
// => [1, 2, 3]

// Curried with placeholders.
curried(1)(_, 3)(2);
// => [1, 2, 3]

_.curryRight(func)

# Ⓢ Ⓣ Ⓝ

This method is like _.curry except that arguments are applied to func in the manner of _.partialRight instead of _.partial.

The _.curryRight.placeholder value, which defaults to _ in monolithic builds, may be used as a placeholder for provided arguments.

Note: This method doesn't set the "length" property of curried functions.

Since

3.0.0

Arguments

  1. func (Function): The function to curry.

Returns

(Function): Returns the new curried function.

Example

var abc = function(a, b, c) {
  return [a, b, c];
};

var curried = _.curryRight(abc);

curried(3)(2)(1);
// => [1, 2, 3]

curried(2, 3)(1);
// => [1, 2, 3]

curried(1, 2, 3);
// => [1, 2, 3]

// Curried with placeholders.
curried(3)(1, _)(2);
// => [1, 2, 3]

_.debounce(wait, func)

# Ⓢ Ⓣ Ⓝ

Creates a debounced function that delays invoking func until after wait milliseconds have elapsed since the last time the debounced function was invoked. The debounced function comes with a cancel method to cancel delayed func invocations and a flush method to immediately invoke them. Provide options to indicate whether func should be invoked on the leading and/or trailing edge of the wait timeout. The func is invoked with the last arguments provided to the debounced function. Subsequent calls to the debounced function return the result of the last func invocation.

Note: If leading and trailing options are true, func is invoked on the trailing edge of the timeout only if the debounced function is invoked more than once during the wait timeout.

If wait is 0 and leading is false, func invocation is deferred until to the next tick, similar to setTimeout with a timeout of 0.

See David Corbacho's article for details over the differences between _.debounce and _.throttle.

Since

0.1.0

Arguments

  1. wait (number): The number of milliseconds to delay.
  2. func (Function): The function to debounce.

Returns

(Function): Returns the new debounced function.

Example

// Avoid costly calculations while the window size is in flux.
jQuery(window).on('resize', _.debounce(150, calculateLayout));

// Invoke `sendMail` when clicked, debouncing subsequent calls.
jQuery(element).on('click', _.debounce([300, {
  'leading': true,
  'trailing': false
}], sendMail));

// Ensure `batchLog` is invoked once after 1 second of debounced calls.
var debounced = _.debounce([250, { 'maxWait': 1000 }], batchLog);
var source = new EventSource('/stream');
jQuery(source).on('message', debounced);

// Cancel the trailing debounced invocation.
jQuery(window).on('popstate', debounced.cancel);

_.defer(func)

# Ⓢ Ⓣ Ⓝ

Defers invoking the func until the current call stack has cleared. Any additional arguments are provided to func when it's invoked.

Since

0.1.0

Arguments

  1. func (Function): The function to defer.

Returns

(number): Returns the timer id.

Example

_.defer([function(text) {
  console.log(text);
}, 'deferred']);
// => Logs 'deferred' after one millisecond.

_.delay(wait, func)

# Ⓢ Ⓣ Ⓝ

Invokes func after wait milliseconds. Any additional arguments are provided to func when it's invoked.

Since

0.1.0

Arguments

  1. wait (number): The number of milliseconds to delay invocation.
  2. func (Function): The function to delay.

Returns

(number): Returns the timer id.

Example

_.delay([1000, 'later'], function(text) {
  console.log(text);
});
// => Logs 'later' after one second.

_.flip(func)

# Ⓢ Ⓣ Ⓝ

Creates a function that invokes func with arguments reversed.

Since

4.0.0

Arguments

  1. func (Function): The function to flip arguments for.

Returns

(Function): Returns the new flipped function.

Example

var flipped = _.flip(function() {
  return _.toArray(arguments);
});

flipped('a', 'b', 'c', 'd');
// => ['d', 'c', 'b', 'a']

_.memoize(func)

# Ⓢ Ⓣ Ⓝ

Creates a function that memoizes the result of func. If resolver is provided, it determines the cache key for storing the result based on the arguments provided to the memoized function. By default, the first argument provided to the memoized function is used as the map cache key. The func is invoked with the this binding of the memoized function.

Note: The cache is exposed as the cache property on the memoized function. Its creation may be customized by replacing the _.memoize.Cache constructor with one whose instances implement the Map method interface of clear, delete, get, has, and set.

Since

0.1.0

Arguments

  1. func (Function): The function to have its output memoized.

Returns

(Function): Returns the new memoized function.

Example

var object = { 'a': 1, 'b': 2 };
var other = { 'c': 3, 'd': 4 };

var values = _.memoize(_.values);
values(object);
// => [1, 2]

values(other);
// => [3, 4]

object.a = 2;
values(object);
// => [1, 2]

// Modify the result cache.
values.cache.set(object, ['a', 'b']);
values(object);
// => ['a', 'b']

// Replace `_.memoize.Cache`.
_.memoize.Cache = WeakMap;

_.negate(predicate)

# Ⓢ Ⓣ Ⓝ

Creates a function that negates the result of the predicate func. The func predicate is invoked with the this binding and arguments of the created function.

Since

3.0.0

Arguments

  1. predicate (Function): The predicate to negate.

Returns

(Function): Returns the new negated function.

Example

function isEven(n) {
  return n % 2 == 0;
}

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

_.once(func)

# Ⓢ Ⓣ Ⓝ

Creates a function that is restricted to invoking func once. Repeat calls to the function return the value of the first invocation. The func is invoked with the this binding and arguments of the created function.

Since

0.1.0

Arguments

  1. func (Function): The function to restrict.

Returns

(Function): Returns the new restricted function.

Example

var initialize = _.once(createApplication);
initialize();
initialize();
// => `createApplication` is invoked once

_.overArgs(func, transforms)

# Ⓢ Ⓣ Ⓝ

Creates a function that invokes func with its arguments transformed.

Since

4.0.0

Arguments

  1. func (Function): The function to wrap.
  2. transforms (Function|Function[]): The argument transforms.

Returns

(Function): Returns the new function.

Example

function doubled(n) {
  return n * 2;
}

function square(n) {
  return n * n;
}

var func = _.overArgs(function(x, y) {
  return [x, y];
}, [square, doubled]);

func(9, 3);
// => [81, 6]

func(10, 5);
// => [100, 10]

_.partial(func, partials)

# Ⓢ Ⓣ Ⓝ

Creates a function that invokes func with partials prepended to the arguments it receives. This method is like _.bind except it does not alter the this binding.

The _.partial.placeholder value, which defaults to _ in monolithic builds, may be used as a placeholder for partially applied arguments.

Note: This method doesn't set the "length" property of partially applied functions.

Since

0.2.0

Arguments

  1. func (Function): The function to partially apply arguments to.
  2. partials (*|*[]): The arguments to be partially applied.

Returns

(Function): Returns the new partially applied function.

Example

function greet(greeting, name) {
  return greeting + ' ' + name;
}

var sayHelloTo = _.partial(greet, 'hello');
sayHelloTo('fred');
// => 'hello fred'

// Partially applied with placeholders.
var greetFred = _.partial(greet, [_, 'fred']);
greetFred('hi');
// => 'hi fred'

_.partialRight(func, partials)

# Ⓢ Ⓣ Ⓝ

This method is like _.partial except that partially applied arguments are appended to the arguments it receives.

The _.partialRight.placeholder value, which defaults to _ in monolithic builds, may be used as a placeholder for partially applied arguments.

Note: This method doesn't set the "length" property of partially applied functions.

Since

1.0.0

Arguments

  1. func (Function): The function to partially apply arguments to.
  2. partials (*|*[]): The arguments to be partially applied.

Returns

(Function): Returns the new partially applied function.

Example

function greet(greeting, name) {
  return greeting + ' ' + name;
}

var greetFred = _.partialRight(greet, 'fred');
greetFred('hi');
// => 'hi fred'

// Partially applied with placeholders.
var sayHelloTo = _.partialRight(greet, ['hello', _]);
sayHelloTo('fred');
// => 'hello fred'

_.rearg(indexes, func)

# Ⓢ Ⓣ Ⓝ

Creates a function that invokes func with arguments arranged according to the specified indexes where the argument value at the first index is provided as the first argument, the argument value at the second index is provided as the second argument, and so on.

Since

3.0.0

Arguments

  1. indexes (number|number[]): The arranged argument indexes.
  2. func (Function): The function to rearrange arguments for.

Returns

(Function): Returns the new function.

Example

var rearged = _.rearg([2, 0, 1], function(a, b, c) {
  return [a, b, c];
});

rearged('b', 'c', 'a')
// => ['a', 'b', 'c']

_.rest(func)

# Ⓢ Ⓣ Ⓝ

Creates a function that invokes func with the this binding of the created function and arguments from start and beyond provided as an array.

Note: This method is based on the rest parameter.

Since

4.0.0

Arguments

  1. func (Function): The function to apply a rest parameter to.

Returns

(Function): Returns the new function.

Example

var say = _.rest(function(what, names) {
  return what + ' ' + _.initial(names).join(', ') +
    (_.size(names) > 1 ? ', & ' : '') + _.last(names);
});

say('hello', 'fred', 'barney', 'pebbles');
// => 'hello fred, barney, & pebbles'

_.spread(func)

# Ⓢ Ⓣ Ⓝ

Creates a function that invokes func with the this binding of the create function and an array of arguments much like Function#apply.

Note: This method is based on the spread operator.

Since

3.2.0

Arguments

  1. func (Function): The function to spread arguments over.

Returns

(Function): Returns the new function.

Example

var say = _.spread(function(who, what) {
  return who + ' says ' + what;
});

say(['fred', 'hello']);
// => 'fred says hello'

var numbers = Promise.all([
  Promise.resolve(40),
  Promise.resolve(36)
]);

numbers.then(_.spread(function(x, y) {
  return x + y;
}));
// => a Promise of 76

_.throttle(wait, func)

# Ⓢ Ⓣ Ⓝ

Creates a throttled function that only invokes func at most once per every wait milliseconds. The throttled function comes with a cancel method to cancel delayed func invocations and a flush method to immediately invoke them. Provide options to indicate whether func should be invoked on the leading and/or trailing edge of the wait timeout. The func is invoked with the last arguments provided to the throttled function. Subsequent calls to the throttled function return the result of the last func invocation.

Note: If leading and trailing options are true, func is invoked on the trailing edge of the timeout only if the throttled function is invoked more than once during the wait timeout.

If wait is 0 and leading is false, func invocation is deferred until to the next tick, similar to setTimeout with a timeout of 0.

See David Corbacho's article for details over the differences between _.throttle and _.debounce.

Since

0.1.0

Arguments

  1. wait (number): The number of milliseconds to throttle invocations to.
  2. func (Function): The function to throttle.

Returns

(Function): Returns the new throttled function.

Example

// Avoid excessively updating the position while scrolling.
jQuery(window).on('scroll', _.throttle(100, updatePosition));

// Invoke `renewToken` when the click event is fired, but not more than once every 5 minutes.
var throttled = _.throttle([300000, { 'trailing': false }], renewToken);
jQuery(element).on('click', throttled);

// Cancel the trailing throttled invocation.
jQuery(window).on('popstate', throttled.cancel);

_.unary(func)

# Ⓢ Ⓣ Ⓝ

Creates a function that accepts up to one argument, ignoring any additional arguments.

Since

4.0.0

Arguments

  1. func (Function): The function to cap arguments for.

Returns

(Function): Returns the new capped function.

Example

_.map(_.unary(parseInt), ['6', '8', '10']);
// => [6, 8, 10]

_.wrap(wrapper, value)

# Ⓢ Ⓣ Ⓝ

Creates a function that provides value to wrapper as its first argument. Any additional arguments provided to the function are appended to those provided to the wrapper. The wrapper is invoked with the this binding of the created function.

Since

0.1.0

Arguments

  1. wrapper (Function): The wrapper function.
  2. value (*): The value to wrap.

Returns

(Function): Returns the new function.

Example

var p = _.wrap(function(func, text) {
  return '<p>' + func(text) + '</p>';
}, _.escape);

p('fred, barney, & pebbles');
// => '<p>fred, barney, &amp; pebbles</p>'

“Lang” Methods

_.castArray(value)

# Ⓢ Ⓣ Ⓝ

Casts value as an array if it's not one.

Since

4.4.0

Arguments

  1. value (*): The value to inspect.

Returns

(Array): Returns the cast array.

Example

_.castArray(1);
// => [1]

_.castArray({ 'a': 1 });
// => [{ 'a': 1 }]

_.castArray('abc');
// => ['abc']

_.castArray(null);
// => [null]

_.castArray(undefined);
// => [undefined]

_.castArray(null);
// => []

var array = [1, 2, 3];
// => true

_.clone(value)

# Ⓢ Ⓣ Ⓝ

Creates a shallow clone of value.

Note: This method is loosely based on the structured clone algorithm and supports cloning arrays, array buffers, booleans, date objects, maps, numbers, Object objects, regexes, sets, strings, symbols, and typed arrays. The own enumerable properties of arguments objects are cloned as plain objects. An empty object is returned for uncloneable values such as error objects, functions, DOM nodes, and WeakMaps.

Since

0.1.0

Arguments

  1. value (*): The value to clone.

Returns

(*): Returns the cloned value.

Example

var objects = [{ 'a': 1 }, { 'b': 2 }];

var shallow = _.clone(objects);
// => true

_.cloneDeep(value)

# Ⓢ Ⓣ Ⓝ

This method is like _.clone except that it recursively clones value.

Since

1.0.0

Arguments

  1. value (*): The value to recursively clone.

Returns

(*): Returns the deep cloned value.

Example

var objects = [{ 'a': 1 }, { 'b': 2 }];

var deep = _.cloneDeep(objects);
// => false

_.cloneDeepWith(customizer, value)

# Ⓢ Ⓣ Ⓝ

This method is like _.cloneWith except that it recursively clones value.

Since

4.0.0

Arguments

  1. customizer (Function): The function to customize cloning.
  2. value (*): The value to recursively clone.

Returns

(*): Returns the deep cloned value.

Example

function customizer(value) {
  if (_.isElement(value)) {
    return value.cloneNode(true);
  }
}

var el = _.cloneDeepWith(customizer, document.body);

// => false
// => 'BODY'
// => 20

_.cloneWith(customizer, value)

# Ⓢ Ⓣ Ⓝ

This method is like _.clone except that it accepts customizer which is invoked to produce the cloned value. If customizer returns undefined, cloning is handled by the method instead. The customizer is invoked with up to four arguments; (value [, index|key, object, stack]).

Since

4.0.0

Arguments

  1. customizer (Function): The function to customize cloning.
  2. value (*): The value to clone.

Returns

(*): Returns the cloned value.

Example

function customizer(value) {
  if (_.isElement(value)) {
    return value.cloneNode(false);
  }
}

var el = _.cloneWith(customizer, document.body);

// => false
// => 'BODY'
// => 0

_.conformsTo(source, object)

# Ⓢ Ⓣ Ⓝ

Checks if object conforms to source by invoking the predicate properties of source with the corresponding property values of object.

Note: This method is equivalent to _.conforms when source is partially applied.

Since

4.14.0

Arguments

  1. source (Object): The object of property predicates to conform to.
  2. object (Object): The object to inspect.

Returns

(boolean): Returns true if object conforms, else false.

Example

var object = { 'a': 1, 'b': 2 };

_.conformsTo({ 'b': function(n) { return n > 1; } }, object);
// => true

_.conformsTo({ 'b': function(n) { return n > 2; } }, object);
// => false

_.eq(value, other)

# Ⓢ Ⓣ Ⓝ

Performs a SameValueZero comparison between two values to determine if they are equivalent.

Since

4.0.0

Arguments

  1. value (*): The value to compare.
  2. other (*): The other value to compare.

Returns

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

Example

var object = { 'a': 1 };
var other = { 'a': 1 };

_.eq(object, object);
// => true

_.eq(object, other);
// => false

_.eq('a', 'a');
// => true

_.eq('a', Object('a'));
// => false

_.eq(NaN, NaN);
// => true

_.gt(value, other)

# Ⓢ Ⓣ Ⓝ

Checks if value is greater than other.

Since

3.9.0

Arguments

  1. value (*): The value to compare.
  2. other (*): The other value to compare.

Returns

(boolean): Returns true if value is greater than other, else false.

Example

_.gt(3, 1);
// => true

_.gt(3, 3);
// => false

_.gt(1, 3);
// => false

_.gte(value, other)

# Ⓢ Ⓣ Ⓝ

Checks if value is greater than or equal to other.

Since

3.9.0

Arguments

  1. value (*): The value to compare.
  2. other (*): The other value to compare.

Returns

(boolean): Returns true if value is greater than or equal to other, else false.

Example

_.gte(3, 1);
// => true

_.gte(3, 3);
// => true

_.gte(1, 3);
// => false

_.isArguments(value)

# Ⓢ Ⓣ Ⓝ

Checks if value is likely an arguments object.

Since

0.1.0

Arguments

  1. value (*): The value to check.

Returns

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

Example

_.isArguments(function() { return arguments; }());
// => true

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

_.isArray(value)

# Ⓢ Ⓣ Ⓝ

Checks if value is classified as an Array object.

Since

0.1.0

Arguments

  1. value (*): The value to check.

Returns

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

Example

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

_.isArray(document.body.children);
// => false

_.isArray('abc');
// => false

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

_.isArrayBuffer(value)

# Ⓢ Ⓣ Ⓝ

Checks if value is classified as an ArrayBuffer object.

Since

4.3.0

Arguments

  1. value (*): The value to check.

Returns

(boolean): Returns true if value is an array buffer, else false.

Example

_.isArrayBuffer(new ArrayBuffer(2));
// => true

_.isArrayBuffer(new Array(2));
// => false

_.isArrayLike(value)

# Ⓢ Ⓣ Ⓝ

Checks if value is array-like. A value is considered array-like if it's not a function and has a value.length that's an integer greater than or equal to 0 and less than or equal to Number.MAX_SAFE_INTEGER.

Since

4.0.0

Arguments

  1. value (*): The value to check.

Returns

(boolean): Returns true if value is array-like, else false.

Example

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

_.isArrayLike(document.body.children);
// => true

_.isArrayLike('abc');
// => true

_.isArrayLike(_.noop);
// => false

_.isArrayLikeObject(value)

# Ⓢ Ⓣ Ⓝ

This method is like _.isArrayLike except that it also checks if value is an object.

Since

4.0.0

Arguments

  1. value (*): The value to check.

Returns

(boolean): Returns true if value is an array-like object, else false.

Example

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

_.isArrayLikeObject(document.body.children);
// => true

_.isArrayLikeObject('abc');
// => false

_.isArrayLikeObject(_.noop);
// => false

_.isBoolean(value)

# Ⓢ Ⓣ Ⓝ

Checks if value is classified as a boolean primitive or object.

Since

0.1.0

Arguments

  1. value (*): The value to check.

Returns

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

Example

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

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

_.isBuffer(value)

# Ⓢ Ⓣ Ⓝ

Checks if value is a buffer.

Since

4.3.0

Arguments

  1. value (*): The value to check.

Returns

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

Example

_.isBuffer(new Buffer(2));
// => true

_.isBuffer(new Uint8Array(2));
// => false

_.isDate(value)

# Ⓢ Ⓣ Ⓝ

Checks if value is classified as a Date object.

Since

0.1.0

Arguments

  1. value (*): The value to check.

Returns

(boolean): Returns true if value is a date object, else false.

Example

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

_.isDate('Mon April 23 2012');
// => false

_.isElement(value)

# Ⓢ Ⓣ Ⓝ

Checks if value is likely a DOM element.

Since

0.1.0

Arguments

  1. value (*): The value to check.

Returns

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

Example

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

_.isElement('<body>');
// => false

_.isEmpty(value)

# Ⓢ Ⓣ Ⓝ

Checks if value is an empty object, collection, map, or set.

Objects are considered empty if they have no own enumerable string keyed properties.

Array-like values such as arguments objects, arrays, buffers, strings, or jQuery-like collections are considered empty if they have a length of 0. Similarly, maps and sets are considered empty if they have a size of 0.

Since

0.1.0

Arguments

  1. value (*): The value to check.

Returns

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

Example

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

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

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

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

_.isEmpty({ 'a': 1 });
// => false

_.isEqual(value, other)

# Ⓢ Ⓣ Ⓝ

Performs a deep comparison between two values to determine if they are equivalent.

Note: This method supports comparing arrays, array buffers, booleans, date objects, error objects, maps, numbers, Object objects, regexes, sets, strings, symbols, and typed arrays. Object objects are compared by their own, not inherited, enumerable properties. Functions and DOM nodes are compared by strict equality, i.e. ===.

Since

0.1.0

Arguments

  1. value (*): The value to compare.
  2. other (*): The other value to compare.

Returns

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

Example

var object = { 'a': 1 };
var other = { 'a': 1 };

_.isEqual(object, other);
// => true

object === other;
// => false

_.isEqualWith(customizer, value, other)

# Ⓢ Ⓣ Ⓝ

This method is like _.isEqual except that it accepts customizer which is invoked to compare values. If customizer returns undefined, comparisons are handled by the method instead. The customizer is invoked with up to six arguments: (objValue, othValue [, index|key, object, other, stack]).

Since

4.0.0

Arguments

  1. customizer (Function): The function to customize comparisons.
  2. value (*): The value to compare.
  3. other (*): The other value to compare.

Returns

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

Example

function isGreeting(value) {
  return /^h(?:i|ello)$/.test(value);
}

function customizer(objValue, othValue) {
  if (isGreeting(objValue) && isGreeting(othValue)) {
    return true;
  }
}

var array = ['hello', 'goodbye'];
var other = ['hi', 'goodbye'];

_.isEqualWith(customizer, array, other);
// => true

_.isError(value)

# Ⓢ Ⓣ Ⓝ

Checks if value is an Error, EvalError, RangeError, ReferenceError, SyntaxError, TypeError, or URIError object.

Since

3.0.0

Arguments

  1. value (*): The value to check.

Returns

(boolean): Returns true if value is an error object, else false.

Example

_.isError(new Error);
// => true

_.isError(Error);
// => false

_.isFinite(value)

# Ⓢ Ⓣ Ⓝ

Checks if value is a finite primitive number.

Note: This method is based on Number.isFinite.

Since

0.1.0

Arguments

  1. value (*): The value to check.

Returns

(boolean): Returns true if value is a finite number, else false.

Example

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

_.isFinite(Number.MIN_VALUE);
// => true

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

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

_.isFunction(value)

# Ⓢ Ⓣ Ⓝ

Checks if value is classified as a Function object.

Since

0.1.0

Arguments

  1. value (*): The value to check.

Returns

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

Example

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

_.isFunction(/abc/);
// => false

_.isInteger(value)

# Ⓢ Ⓣ Ⓝ

Checks if value is an integer.

Note: This method is based on Number.isInteger.

Since

4.0.0

Arguments

  1. value (*): The value to check.

Returns

(boolean): Returns true if value is an integer, else false.

Example

_.isInteger(3);
// => true

_.isInteger(Number.MIN_VALUE);
// => false

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

_.isInteger('3');
// => false

_.isLength(value)

# Ⓢ Ⓣ Ⓝ

Checks if value is a valid array-like length.

Note: This method is loosely based on ToLength.

Since

4.0.0

Arguments

  1. value (*): The value to check.

Returns

(boolean): Returns true if value is a valid length, else false.

Example

_.isLength(3);
// => true

_.isLength(Number.MIN_VALUE);
// => false

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

_.isLength('3');
// => false

_.isMap(value)

# Ⓢ Ⓣ Ⓝ

Checks if value is classified as a Map object.

Since

4.3.0

Arguments

  1. value (*): The value to check.

Returns

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

Example

_.isMap(new Map);
// => true

_.isMap(new WeakMap);
// => false

_.isMatch(source, object)

# Ⓢ Ⓣ Ⓝ

Performs a partial deep comparison between object and source to determine if object contains equivalent property values.

Note: This method is equivalent to _.matches when source is partially applied.

Partial comparisons will match empty array and empty object source values against any array or object value, respectively. See _.isEqual for a list of supported value comparisons.

Since

3.0.0

Arguments

  1. source (Object): The object of property values to match.
  2. object (Object): The object to inspect.

Returns

(boolean): Returns true if object is a match, else false.

Example

var object = { 'a': 1, 'b': 2 };

_.isMatch({ 'b': 2 }, object);
// => true

_.isMatch({ 'b': 1 }, object);
// => false

_.isMatchWith(customizer, source, object)

# Ⓢ Ⓣ Ⓝ

This method is like _.isMatch except that it accepts customizer which is invoked to compare values. If customizer returns undefined, comparisons are handled by the method instead. The customizer is invoked with five arguments: (objValue, srcValue, index|key, object, source).

Since

4.0.0

Arguments

  1. customizer (Function): The function to customize comparisons.
  2. source (Object): The object of property values to match.
  3. object (Object): The object to inspect.

Returns

(boolean): Returns true if object is a match, else false.

Example

function isGreeting(value) {
  return /^h(?:i|ello)$/.test(value);
}

function customizer(objValue, srcValue) {
  if (isGreeting(objValue) && isGreeting(srcValue)) {
    return true;
  }
}

var object = { 'greeting': 'hello' };
var source = { 'greeting': 'hi' };

_.isMatchWith(customizer, source, object);
// => true

_.isNaN(value)

# Ⓢ Ⓣ Ⓝ

Checks if value is NaN.

Note: This method is based on Number.isNaN and is not the same as global isNaN which returns true for undefined and other non-number values.

Since

0.1.0

Arguments

  1. value (*): The value to check.

Returns

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

Example

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

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

isNaN(undefined);
// => true

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

_.isNative(value)

# Ⓢ Ⓣ Ⓝ

Checks if value is a pristine native function.

Note: This method can't reliably detect native functions in the presence of the core-js package because core-js circumvents this kind of detection. Despite multiple requests, the core-js maintainer has made it clear: any attempt to fix the detection will be obstructed. As a result, we're left with little choice but to throw an error. Unfortunately, this also affects packages, like babel-polyfill, which rely on core-js.

Since

3.0.0

Arguments

  1. value (*): The value to check.

Returns

(boolean): Returns true if value is a native function, else false.

Example

_.isNative(Array.prototype.push);
// => true

_.isNative(_);
// => false

_.isNil(value)

# Ⓢ Ⓣ Ⓝ

Checks if value is null or undefined.

Since

4.0.0

Arguments

  1. value (*): The value to check.

Returns

(boolean): Returns true if value is nullish, else false.

Example

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

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

_.isNil(NaN);
// => false

_.isNull(value)

# Ⓢ Ⓣ Ⓝ

Checks if value is null.

Since

0.1.0

Arguments

  1. value (*): The value to check.

Returns

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

Example

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

_.isNull(void 0);
// => false

_.isNumber(value)

# Ⓢ Ⓣ Ⓝ

Checks if value is classified as a Number primitive or object.

Note: To exclude Infinity, -Infinity, and NaN, which are classified as numbers, use the _.isFinite method.

Since

0.1.0

Arguments

  1. value (*): The value to check.

Returns

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

Example

_.isNumber(3);
// => true

_.isNumber(Number.MIN_VALUE);
// => true

_.isNumber(Infinity);
// => true

_.isNumber('3');
// => false

_.isObject(value)

# Ⓢ Ⓣ Ⓝ

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

Since

0.1.0

Arguments

  1. value (*): The value to check.

Returns

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

Example

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

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

_.isObject(_.noop);
// => true

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

_.isObjectLike(value)

# Ⓢ Ⓣ Ⓝ

Checks if value is object-like. A value is object-like if it's not null and has a typeof result of "object".

Since

4.0.0

Arguments

  1. value (*): The value to check.

Returns

(boolean): Returns true if value is object-like, else false.

Example

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

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

_.isObjectLike(_.noop);
// => false

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

_.isPlainObject(value)

# Ⓢ Ⓣ Ⓝ

Checks if value is a plain object, that is, an object created by the Object constructor or one with a [[Prototype]] of null.

Since

0.8.0

Arguments

  1. value (*): The value to check.

Returns

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

Example

function Foo() {
  this.a = 1;
}

_.isPlainObject(new Foo);
// => false

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

_.isPlainObject({ 'x': 0, 'y': 0 });
// => true

_.isPlainObject(Object.create(null));
// => true

_.isRegExp(value)

# Ⓢ Ⓣ Ⓝ

Checks if value is classified as a RegExp object.

Since

0.1.0

Arguments

  1. value (*): The value to check.

Returns

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

Example

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

_.isRegExp('/abc/');
// => false

_.isSafeInteger(value)

# Ⓢ Ⓣ Ⓝ

Checks if value is a safe integer. An integer is safe if it's an IEEE-754 double precision number which isn't the result of a rounded unsafe integer.

Note: This method is based on Number.isSafeInteger.

Since

4.0.0

Arguments

  1. value (*): The value to check.

Returns

(boolean): Returns true if value is a safe integer, else false.

Example

_.isSafeInteger(3);
// => true

_.isSafeInteger(Number.MIN_VALUE);
// => false

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

_.isSafeInteger('3');
// => false

_.isSet(value)

# Ⓢ Ⓣ Ⓝ

Checks if value is classified as a Set object.

Since

4.3.0

Arguments

  1. value (*): The value to check.

Returns

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

Example

_.isSet(new Set);
// => true

_.isSet(new WeakSet);
// => false

_.isString(value)

# Ⓢ Ⓣ Ⓝ

Checks if value is classified as a String primitive or object.

Since

0.1.0

Arguments

  1. value (*): The value to check.

Returns

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

Example

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

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

_.isSymbol(value)

# Ⓢ Ⓣ Ⓝ

Checks if value is classified as a Symbol primitive or object.

Since

4.0.0

Arguments

  1. value (*): The value to check.

Returns

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

Example

_.isSymbol(Symbol.iterator);
// => true

_.isSymbol('abc');
// => false

_.isTypedArray(value)

# Ⓢ Ⓣ Ⓝ

Checks if value is classified as a typed array.

Since

3.0.0

Arguments

  1. value (*): The value to check.

Returns

(boolean): Returns true if value is a typed array, else false.

Example

_.isTypedArray(new Uint8Array);
// => true

_.isTypedArray([]);
// => false

_.isUndefined(value)

# Ⓢ Ⓣ Ⓝ

Checks if value is undefined.

Since

0.1.0

Arguments

  1. value (*): The value to check.

Returns

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

Example

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

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

_.isWeakMap(value)

# Ⓢ Ⓣ Ⓝ

Checks if value is classified as a WeakMap object.

Since

4.3.0

Arguments

  1. value (*): The value to check.

Returns

(boolean): Returns true if value is a weak map, else false.

Example

_.isWeakMap(new WeakMap);
// => true

_.isWeakMap(new Map);
// => false

_.isWeakSet(value)

# Ⓢ Ⓣ Ⓝ

Checks if value is classified as a WeakSet object.

Since

4.3.0

Arguments

  1. value (*): The value to check.

Returns

(boolean): Returns true if value is a weak set, else false.

Example

_.isWeakSet(new WeakSet);
// => true

_.isWeakSet(new Set);
// => false

_.lt(value, other)

# Ⓢ Ⓣ Ⓝ

Checks if value is less than other.

Since

3.9.0

Arguments

  1. value (*): The value to compare.
  2. other (*): The other value to compare.

Returns

(boolean): Returns true if value is less than other, else false.

Example

_.lt(1, 3);
// => true

_.lt(3, 3);
// => false

_.lt(3, 1);
// => false

_.lte(value, other)

# Ⓢ Ⓣ Ⓝ

Checks if value is less than or equal to other.

Since

3.9.0

Arguments

  1. value (*): The value to compare.
  2. other (*): The other value to compare.

Returns

(boolean): Returns true if value is less than or equal to other, else false.

Example

_.lte(1, 3);
// => true

_.lte(3, 3);
// => true

_.lte(3, 1);
// => false

_.toArray(value)

# Ⓢ Ⓣ Ⓝ

Converts value to an array.

Since

0.1.0

Arguments

  1. value (*): The value to convert.

Returns

(Array): Returns the converted array.

Example

_.toArray({ 'a': 1, 'b': 2 });
// => [1, 2]

_.toArray('abc');
// => ['a', 'b', 'c']

_.toArray(1);
// => []

_.toArray(null);
// => []

_.toFinite(value)

# Ⓢ Ⓣ Ⓝ

Converts value to a finite number.

Since

4.12.0

Arguments

  1. value (*): The value to convert.

Returns

(number): Returns the converted number.

Example

_.toFinite(3.2);
// => 3.2

_.toFinite(Number.MIN_VALUE);
// => 5e-324

_.toFinite(Infinity);
// => 1.7976931348623157e+308

_.toFinite('3.2');
// => 3.2

_.toInteger(value)

# Ⓢ Ⓣ Ⓝ

Converts value to an integer.

Note: This method is loosely based on ToInteger.

Since

4.0.0

Arguments

  1. value (*): The value to convert.

Returns

(number): Returns the converted integer.

Example

_.toInteger(3.2);
// => 3

_.toInteger(Number.MIN_VALUE);
// => 0

_.toInteger(Infinity);
// => 1.7976931348623157e+308

_.toInteger('3.2');
// => 3

_.toLength(value)

# Ⓢ Ⓣ Ⓝ

Converts value to an integer suitable for use as the length of an array-like object.

Note: This method is based on ToLength.

Since

4.0.0

Arguments

  1. value (*): The value to convert.

Returns

(number): Returns the converted integer.

Example

_.toLength(3.2);
// => 3

_.toLength(Number.MIN_VALUE);
// => 0

_.toLength(Infinity);
// => 4294967295

_.toLength('3.2');
// => 3

_.toNumber(value)

# Ⓢ Ⓣ Ⓝ

Converts value to a number.

Since

4.0.0

Arguments

  1. value (*): The value to process.

Returns

(number): Returns the number.

Example

_.toNumber(3.2);
// => 3.2

_.toNumber(Number.MIN_VALUE);
// => 5e-324

_.toNumber(Infinity);
// => Infinity

_.toNumber('3.2');
// => 3.2

_.toPlainObject(value)

# Ⓢ Ⓣ Ⓝ

Converts value to a plain object flattening inherited enumerable string keyed properties of value to own properties of the plain object.

Since

3.0.0

Arguments

  1. value (*): The value to convert.

Returns

(Object): Returns the converted plain object.

Example

function Foo() {
  this.b = 2;
}

Foo.prototype.c = 3;

_.assign({ 'a': 1 }, new Foo);
// => { 'a': 1, 'b': 2 }

_.assign({ 'a': 1 }, _.toPlainObject(new Foo));
// => { 'a': 1, 'b': 2, 'c': 3 }

_.toSafeInteger(value)

# Ⓢ Ⓣ Ⓝ

Converts value to a safe integer. A safe integer can be compared and represented correctly.

Since

4.0.0

Arguments

  1. value (*): The value to convert.

Returns

(number): Returns the converted integer.

Example

_.toSafeInteger(3.2);
// => 3

_.toSafeInteger(Number.MIN_VALUE);
// => 0

_.toSafeInteger(Infinity);
// => 9007199254740991

_.toSafeInteger('3.2');
// => 3

_.toString(value)

# Ⓢ Ⓣ Ⓝ

Converts value to a string. An empty string is returned for null and undefined values. The sign of -0 is preserved.

Since

4.0.0

Arguments

  1. value (*): The value to convert.

Returns

(string): Returns the converted string.

Example

_.toString(null);
// => ''

_.toString(-0);
// => '-0'

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

“Math” Methods

_.add(augend, addend)

# Ⓢ Ⓣ Ⓝ

Adds two numbers.

Since

3.4.0

Arguments

  1. augend (number): The first number in an addition.
  2. addend (number): The second number in an addition.

Returns

(number): Returns the total.

Example

_.add(6, 4);
// => 10

_.ceil(number)

# Ⓢ Ⓣ Ⓝ

Computes number rounded up to precision.

Since

3.10.0

Arguments

  1. number (number): The number to round up.

Returns

(number): Returns the rounded up number.

Example

_.ceil(4.006);
// => 5

_.ceil([6.004, 2]);
// => 6.01

_.ceil([6040, -2]);
// => 6100

_.divide(dividend, divisor)

# Ⓢ Ⓣ Ⓝ

Divide two numbers.

Since

4.7.0

Arguments

  1. dividend (number): The first number in a division.
  2. divisor (number): The second number in a division.

Returns

(number): Returns the quotient.

Example

_.divide(6, 4);
// => 1.5

_.floor(number)

# Ⓢ Ⓣ Ⓝ

Computes number rounded down to precision.

Since

3.10.0

Arguments

  1. number (number): The number to round down.

Returns

(number): Returns the rounded down number.

Example

_.floor(4.006);
// => 4

_.floor([0.046, 2]);
// => 0.04

_.floor([4060, -2]);
// => 4000

_.max(array)

# Ⓢ Ⓣ Ⓝ

Computes the maximum value of array. If array is empty or falsey, undefined is returned.

Since

0.1.0

Arguments

  1. array (Array): The array to iterate over.

Returns

(*): Returns the maximum value.

Example

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

_.max([]);
// => undefined

_.maxBy(iteratee, array)

# Ⓢ Ⓣ Ⓝ

This method is like _.max except that it accepts iteratee which is invoked for each element in array to generate the criterion by which the value is ranked. The iteratee is invoked with one argument: (value).

Since

4.0.0

Arguments

  1. iteratee (Function): The iteratee invoked per element.
  2. array (Array): The array to iterate over.

Returns

(*): Returns the maximum value.

Example

var objects = [{ 'n': 1 }, { 'n': 2 }];

_.maxBy(function(o) { return o.n; }, objects);
// => { 'n': 2 }

// The `_.property` iteratee shorthand.
_.maxBy('n', objects);
// => { 'n': 2 }

_.mean(array)

# Ⓢ Ⓣ Ⓝ

Computes the mean of the values in array.

Since

4.0.0

Arguments

  1. array (Array): The array to iterate over.

Returns

(number): Returns the mean.

Example

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

_.meanBy(iteratee, array)

# Ⓢ Ⓣ Ⓝ

This method is like _.mean except that it accepts iteratee which is invoked for each element in array to generate the value to be averaged. The iteratee is invoked with one argument: (value).

Since

4.7.0

Arguments

  1. iteratee (Function): The iteratee invoked per element.
  2. array (Array): The array to iterate over.

Returns

(number): Returns the mean.

Example

var objects = [{ 'n': 4 }, { 'n': 2 }, { 'n': 8 }, { 'n': 6 }];

_.meanBy(function(o) { return o.n; }, objects);
// => 5

// The `_.property` iteratee shorthand.
_.meanBy('n', objects);
// => 5

_.min(array)

# Ⓢ Ⓣ Ⓝ

Computes the minimum value of array. If array is empty or falsey, undefined is returned.

Since

0.1.0

Arguments

  1. array (Array): The array to iterate over.

Returns

(*): Returns the minimum value.

Example

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

_.min([]);
// => undefined

_.minBy(iteratee, array)

# Ⓢ Ⓣ Ⓝ

This method is like _.min except that it accepts iteratee which is invoked for each element in array to generate the criterion by which the value is ranked. The iteratee is invoked with one argument: (value).

Since

4.0.0

Arguments

  1. iteratee (Function): The iteratee invoked per element.
  2. array (Array): The array to iterate over.

Returns

(*): Returns the minimum value.

Example

var objects = [{ 'n': 1 }, { 'n': 2 }];

_.minBy(function(o) { return o.n; }, objects);
// => { 'n': 1 }

// The `_.property` iteratee shorthand.
_.minBy('n', objects);
// => { 'n': 1 }

_.multiply(multiplier, multiplicand)

# Ⓢ Ⓣ Ⓝ

Multiply two numbers.

Since

4.7.0

Arguments

  1. multiplier (number): The first number in a multiplication.
  2. multiplicand (number): The second number in a multiplication.

Returns

(number): Returns the product.

Example

_.multiply(6, 4);
// => 24

_.round(number)

# Ⓢ Ⓣ Ⓝ

Computes number rounded to precision.

Since

3.10.0

Arguments

  1. number (number): The number to round.

Returns

(number): Returns the rounded number.

Example

_.round(4.006);
// => 4

_.round([4.006, 2]);
// => 4.01

_.round([4060, -2]);
// => 4100

_.subtract(minuend, subtrahend)

# Ⓢ Ⓣ Ⓝ

Subtract two numbers.

Since

4.0.0

Arguments

  1. minuend (number): The first number in a subtraction.
  2. subtrahend (number): The second number in a subtraction.

Returns

(number): Returns the difference.

Example

_.subtract(6, 4);
// => 2

_.sum(array)

# Ⓢ Ⓣ Ⓝ

Computes the sum of the values in array.

Since

3.4.0

Arguments

  1. array (Array): The array to iterate over.

Returns

(number): Returns the sum.

Example

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

_.sumBy(iteratee, array)

# Ⓢ Ⓣ Ⓝ

This method is like _.sum except that it accepts iteratee which is invoked for each element in array to generate the value to be summed. The iteratee is invoked with one argument: (value).

Since

4.0.0

Arguments

  1. iteratee (Function): The iteratee invoked per element.
  2. array (Array): The array to iterate over.

Returns

(number): Returns the sum.

Example

var objects = [{ 'n': 4 }, { 'n': 2 }, { 'n': 8 }, { 'n': 6 }];

_.sumBy(function(o) { return o.n; }, objects);
// => 20

// The `_.property` iteratee shorthand.
_.sumBy('n', objects);
// => 20

“Number” Methods

_.clamp(lower, upper, number)

# Ⓢ Ⓣ Ⓝ

Clamps number within the inclusive lower and upper bounds.

Since

4.0.0

Arguments

  1. lower (number): The lower bound.
  2. upper (number): The upper bound.
  3. number (number): The number to clamp.

Returns

(number): Returns the clamped number.

Example

_.clamp(-5, 5, -10);
// => -5

_.clamp(-5, 5, 10);
// => 5

_.inRange(start, end, number)

# Ⓢ Ⓣ Ⓝ

Checks if n is between start and up to, but not including, end. If end is not specified, it's set to start with start then set to 0. If start is greater than end the params are swapped to support negative ranges.

Since

3.3.0

Arguments

  1. start (number): The start of the range.
  2. end (number): The end of the range.
  3. number (number): The number to check.

Returns

(boolean): Returns true if number is in the range, else false.

Example

_.inRange(2, 4, 3);
// => true

_.inRange(0, 8, 4);
// => true

_.inRange(0, 2, 4);
// => false

_.inRange(0, 2, 2);
// => false

_.inRange(0, 2, 1.2);
// => true

_.inRange(0, 4, 5.2);
// => false

_.inRange(-2, -6, -3);
// => true

_.random(lower, upper)

# Ⓢ Ⓣ Ⓝ

Produces a random number between the inclusive lower and upper bounds. If only one argument is provided a number between 0 and the given number is returned. If floating is true, or either lower or upper are floats, a floating-point number is returned instead of an integer.

Note: JavaScript follows the IEEE-754 standard for resolving floating-point values which can produce unexpected results.

Since

0.7.0

Arguments

  1. lower (number): The lower bound.
  2. upper (number): The upper bound.

Returns

(number): Returns the random number.

Example

_.random(0, 5);
// => an integer between 0 and 5

_.random(5, 1);
// => also an integer between 0 and 5

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

_.random(1.2, 5.2);
// => a floating-point number between 1.2 and 5.2

“Object” Methods

_.assign(object, sources)

# Ⓢ Ⓣ Ⓝ

Assigns own enumerable string keyed properties of source objects to the destination object. Source objects are applied from left to right. Subsequent sources overwrite property assignments of previous sources.

Since

0.10.0

Arguments

  1. object (Object): The destination object.
  2. sources (Object|Object[]): The source objects.

Returns

(Object): Returns object.

Example

function Foo() {
  this.a = 1;
}

function Bar() {
  this.c = 3;
}

Foo.prototype.b = 2;
Bar.prototype.d = 4;

_.assign({ 'a': 0 }, [new Foo, new Bar]);
// => { 'a': 1, 'c': 3 }

_.assignIn(object, sources)

# Ⓢ Ⓣ Ⓝ

This method is like _.assign except that it iterates over own and inherited source properties.

Since

4.0.0

Aliases

_.extend

Arguments

  1. object (Object): The destination object.
  2. sources (Object|Object[]): The source objects.

Returns

(Object): Returns object.

Example

function Foo() {
  this.a = 1;
}

function Bar() {
  this.c = 3;
}

Foo.prototype.b = 2;
Bar.prototype.d = 4;

_.assignIn({ 'a': 0 }, [new Foo, new Bar]);
// => { 'a': 1, 'b': 2, 'c': 3, 'd': 4 }

_.assignInWith(customizer, object, sources)

# Ⓢ Ⓣ Ⓝ

This method is like _.assignIn except that it accepts customizer which is invoked to produce the assigned values. If customizer returns undefined, assignment is handled by the method instead. The customizer is invoked with five arguments: (objValue, srcValue, key, object, source).

Since

4.0.0

Aliases

_.extendWith

Arguments

  1. customizer (Function): The function to customize assigned values.
  2. object (Object): The destination object.
  3. sources (Object|Object[]): The source objects.

Returns

(Object): Returns object.

Example

function customizer(objValue, srcValue) {
  return _.isUndefined(objValue) ? srcValue : objValue;
}

var defaults = _.partialRight(_.assignInWith, customizer);

defaults({ 'a': 1 }, { 'b': 2 }, { 'a': 3 });
// => { 'a': 1, 'b': 2 }

_.assignWith(customizer, object, sources)

# Ⓢ Ⓣ Ⓝ

This method is like _.assign except that it accepts customizer which is invoked to produce the assigned values. If customizer returns undefined, assignment is handled by the method instead. The customizer is invoked with five arguments: (objValue, srcValue, key, object, source).

Since

4.0.0

Arguments

  1. customizer (Function): The function to customize assigned values.
  2. object (Object): The destination object.
  3. sources (Object|Object[]): The source objects.

Returns

(Object): Returns object.

Example

function customizer(objValue, srcValue) {
  return _.isUndefined(objValue) ? srcValue : objValue;
}

var defaults = _.partialRight(_.assignWith, customizer);

defaults({ 'a': 1 }, { 'b': 2 }, { 'a': 3 });
// => { 'a': 1, 'b': 2 }

_.at(paths, object)

# Ⓢ Ⓣ Ⓝ

Creates an array of values corresponding to paths of object.

Since

1.0.0

Arguments

  1. paths (string|string[]): The property paths to pick.
  2. object (Object): The object to iterate over.

Returns

(Array): Returns the picked values.

Example

var object = { 'a': [{ 'b': { 'c': 3 } }, 4] };

_.at(['a[0].b.c', 'a[1]'], object);
// => [3, 4]

_.create(prototype)

# Ⓢ Ⓣ Ⓝ

Creates an object that inherits from the prototype object. If a properties object is given, its own enumerable string keyed properties are assigned to the created object.

Since

2.3.0

Arguments

  1. prototype (Object): The object to inherit from.

Returns

(Object): Returns the new object.

Example

function Shape() {
  this.x = 0;
  this.y = 0;
}

function Circle() {
  Shape.call(this);
}

Circle.prototype = _.create([Shape.prototype, {
  'constructor': Circle
}]);

var circle = new Circle;
circle instanceof Circle;
// => true

circle instanceof Shape;
// => true

_.defaults(sources, object)

# Ⓢ Ⓣ Ⓝ

Assigns own and inherited enumerable string keyed properties of source objects to the destination object for all destination properties that resolve to undefined. Source objects are applied from left to right. Once a property is set, additional values of the same property are ignored.

Since

0.1.0

Arguments

  1. sources (Object|Object[]): The source objects.
  2. object (Object): The destination object.

Returns

(Object): Returns object.

Example

_.defaults([{ 'b': 2 }, { 'a': 3 }], { 'a': 1 });
// => { 'a': 1, 'b': 2 }

_.defaultsDeep(sources, object)

# Ⓢ Ⓣ Ⓝ

This method is like _.defaults except that it recursively assigns default properties.

Since

3.10.0

Arguments

  1. sources (Object|Object[]): The source objects.
  2. object (Object): The destination object.

Returns

(Object): Returns object.

Example

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

_.findKey(predicate, object)

# Ⓢ Ⓣ Ⓝ

This method is like _.find except that it returns the key of the first element predicate returns truthy for instead of the element itself.

Since

1.1.0

Arguments

  1. predicate (Function): The function invoked per iteration.
  2. object (Object): The object to inspect.

Returns

(*): Returns the key of the matched element, else undefined.

Example

var users = {
  'barney':  { 'age': 36, 'active': true },
  'fred':    { 'age': 40, 'active': false },
  'pebbles': { 'age': 1,  'active': true }
};

_.findKey(function(o) { return o.age < 40; }, users);
// => 'barney' (iteration order is not guaranteed)

// The `_.matches` iteratee shorthand.
_.findKey({ 'age': 1, 'active': true }, users);
// => 'pebbles'

// The `_.matchesProperty` iteratee shorthand.
_.findKey(['active', false], users);
// => 'fred'

// The `_.property` iteratee shorthand.
_.findKey('active', users);
// => 'barney'

_.findLastKey(predicate, object)

# Ⓢ Ⓣ Ⓝ

This method is like _.findKey except that it iterates over elements of a collection in the opposite order.

Since

2.0.0

Arguments

  1. predicate (Function): The function invoked per iteration.
  2. object (Object): The object to inspect.

Returns

(*): Returns the key of the matched element, else undefined.

Example

var users = {
  'barney':  { 'age': 36, 'active': true },
  'fred':    { 'age': 40, 'active': false },
  'pebbles': { 'age': 1,  'active': true }
};

_.findLastKey(function(o) { return o.age < 40; }, users);
// => returns 'pebbles' assuming `_.findKey` returns 'barney'

// The `_.matches` iteratee shorthand.
_.findLastKey({ 'age': 36, 'active': true }, users);
// => 'barney'

// The `_.matchesProperty` iteratee shorthand.
_.findLastKey(['active', false], users);
// => 'fred'

// The `_.property` iteratee shorthand.
_.findLastKey('active', users);
// => 'pebbles'

_.forIn(iteratee, object)

# Ⓢ Ⓣ Ⓝ

Iterates over own and inherited enumerable string keyed properties of an object and invokes iteratee for each property. The iteratee is invoked with three arguments: (value, key, object). Iteratee functions may exit iteration early by explicitly returning false.

Since

0.3.0

Arguments

  1. iteratee (Function): The function invoked per iteration.
  2. object (Object): The object to iterate over.

Returns

(Object): Returns object.

Example

function Foo() {
  this.a = 1;
  this.b = 2;
}

Foo.prototype.c = 3;

_.forIn(function(value, key) {
  console.log(key);
}, new Foo);
// => Logs 'a', 'b', then 'c' (iteration order is not guaranteed).

_.forInRight(iteratee, object)

# Ⓢ Ⓣ Ⓝ

This method is like _.forIn except that it iterates over properties of object in the opposite order.

Since

2.0.0

Arguments

  1. iteratee (Function): The function invoked per iteration.
  2. object (Object): The object to iterate over.

Returns

(Object): Returns object.

Example

function Foo() {
  this.a = 1;
  this.b = 2;
}

Foo.prototype.c = 3;

_.forInRight(function(value, key) {
  console.log(key);
}, new Foo);
// => Logs 'c', 'b', then 'a' assuming `_.forIn` logs 'a', 'b', then 'c'.

_.forOwn(iteratee, object)

# Ⓢ Ⓣ Ⓝ

Iterates over own enumerable string keyed properties of an object and invokes iteratee for each property. The iteratee is invoked with three arguments: (value, key, object). Iteratee functions may exit iteration early by explicitly returning false.

Since

0.3.0

Arguments

  1. iteratee (Function): The function invoked per iteration.
  2. object (Object): The object to iterate over.

Returns

(Object): Returns object.

Example

function Foo() {
  this.a = 1;
  this.b = 2;
}

Foo.prototype.c = 3;

_.forOwn(function(value, key) {
  console.log(key);
}, new Foo);
// => Logs 'a' then 'b' (iteration order is not guaranteed).

_.forOwnRight(iteratee, object)

# Ⓢ Ⓣ Ⓝ

This method is like _.forOwn except that it iterates over properties of object in the opposite order.

Since

2.0.0

Arguments

  1. iteratee (Function): The function invoked per iteration.
  2. object (Object): The object to iterate over.

Returns

(Object): Returns object.

Example

function Foo() {
  this.a = 1;
  this.b = 2;
}

Foo.prototype.c = 3;

_.forOwnRight(function(value, key) {
  console.log(key);
}, new Foo);
// => Logs 'b' then 'a' assuming `_.forOwn` logs 'a' then 'b'.

_.functions(object)

# Ⓢ Ⓣ Ⓝ

Creates an array of function property names from own enumerable properties of object.

Since

0.1.0

Arguments

  1. object (Object): The object to inspect.

Returns

(Array): Returns the function names.

Example

function Foo() {
  this.a = _.constant('a');
  this.b = _.constant('b');
}

Foo.prototype.c = _.constant('c');

_.functions(new Foo);
// => ['a', 'b']

_.functionsIn(object)

# Ⓢ Ⓣ Ⓝ

Creates an array of function property names from own and inherited enumerable properties of object.

Since

4.0.0

Arguments

  1. object (Object): The object to inspect.

Returns

(Array): Returns the function names.

Example

function Foo() {
  this.a = _.constant('a');
  this.b = _.constant('b');
}

Foo.prototype.c = _.constant('c');

_.functionsIn(new Foo);
// => ['a', 'b', 'c']

_.get(path, object)

# Ⓢ Ⓣ Ⓝ

Gets the value at path of object. If the resolved value is undefined, the defaultValue is returned in its place.

Since

3.7.0

Arguments

  1. path (Array|string): The path of the property to get.
  2. object (Object): The object to query.

Returns

(*): Returns the resolved value.

Example

var object = { 'a': [{ 'b': { 'c': 3 } }] };

_.get('a[0].b.c', object);
// => 3

_.get(['a', '0', 'b', 'c'], object);
// => 3

_.get(['a.b.c', 'default'], object);
// => 'default'

_.has(path, object)

# Ⓢ Ⓣ Ⓝ

Checks if path is a direct property of object.

Since

0.1.0

Arguments

  1. path (Array|string): The path to check.
  2. object (Object): The object to query.

Returns

(boolean): Returns true if path exists, else false.

Example

var object = { 'a': { 'b': 2 } };
var other = _.create({ 'a': _.create({ 'b': 2 }) });

_.has('a', object);
// => true

_.has('a.b', object);
// => true

_.has(['a', 'b'], object);
// => true

_.has('a', other);
// => false

_.hasIn(path, object)

# Ⓢ Ⓣ Ⓝ

Checks if path is a direct or inherited property of object.

Since

4.0.0

Arguments

  1. path (Array|string): The path to check.
  2. object (Object): The object to query.

Returns

(boolean): Returns true if path exists, else false.

Example

var object = _.create({ 'a': _.create({ 'b': 2 }) });

_.hasIn('a', object);
// => true

_.hasIn('a.b', object);
// => true

_.hasIn(['a', 'b'], object);
// => true

_.hasIn('b', object);
// => false

_.invert(object)

# Ⓢ Ⓣ Ⓝ

Creates an object composed of the inverted keys and values of object. If object contains duplicate values, subsequent values overwrite property assignments of previous values.

Since

0.7.0

Arguments

  1. object (Object): The object to invert.

Returns

(Object): Returns the new inverted object.

Example

var object = { 'a': 1, 'b': 2, 'c': 1 };

_.invert(object);
// => { '1': 'c', '2': 'b' }

_.invertBy(iteratee, object)

# Ⓢ Ⓣ Ⓝ

This method is like _.invert except that the inverted object is generated from the results of running each element of object thru iteratee. The corresponding inverted value of each inverted key is an array of keys responsible for generating the inverted value. The iteratee is invoked with one argument: (value).

Since

4.1.0

Arguments

  1. iteratee (Function): The iteratee invoked per element.
  2. object (Object): The object to invert.

Returns

(Object): Returns the new inverted object.

Example

var object = { 'a': 1, 'b': 2, 'c': 1 };

_.invertBy(_.identity, object);
// => { '1': ['a', 'c'], '2': ['b'] }

_.invertBy(function(value) {
  return 'group' + value;
}, object);
// => { 'group1': ['a', 'c'], 'group2': ['b'] }

_.invoke(path, object)

# Ⓢ Ⓣ Ⓝ

Invokes the method at path of object.

Since

4.0.0

Arguments

  1. path (Array|string): The path of the method to invoke.
  2. object (Object): The object to query.

Returns

(*): Returns the result of the invoked method.

Example

var object = { 'a': [{ 'b': { 'c': [1, 2, 3, 4] } }] };

_.invoke(['a[0].b.c.slice', 1, 3], object);
// => [2, 3]

_.keys(object)

# Ⓢ Ⓣ Ⓝ

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

Note: Non-object values are coerced to objects. See the ES spec for more details.

Since

0.1.0

Arguments

  1. object (Object): The object to query.

Returns

(Array): Returns the array of property names.

Example

function Foo() {
  this.a = 1;
  this.b = 2;
}

Foo.prototype.c = 3;

_.keys(new Foo);
// => ['a', 'b'] (iteration order is not guaranteed)

_.keys('hi');
// => ['0', '1']

_.keysIn(object)

# Ⓢ Ⓣ Ⓝ

Creates an array of the own and inherited enumerable property names of object.

Note: Non-object values are coerced to objects.

Since

3.0.0

Arguments

  1. object (Object): The object to query.

Returns

(Array): Returns the array of property names.

Example

function Foo() {
  this.a = 1;
  this.b = 2;
}

Foo.prototype.c = 3;

_.keysIn(new Foo);
// => ['a', 'b', 'c'] (iteration order is not guaranteed)

_.mapKeys(iteratee, object)

# Ⓢ Ⓣ Ⓝ

The opposite of _.mapValues; this method creates an object with the same values as object and keys generated by running each own enumerable string keyed property of object thru iteratee. The iteratee is invoked with three arguments: (value, key, object).

Since

3.8.0

Arguments

  1. iteratee (Function): The function invoked per iteration.
  2. object (Object): The object to iterate over.

Returns

(Object): Returns the new mapped object.

Example

_.mapKeys(function(value, key) {
  return key + value;
}, { 'a': 1, 'b': 2 });
// => { 'a1': 1, 'b2': 2 }

_.mapValues(iteratee, object)

# Ⓢ Ⓣ Ⓝ

Creates an object with the same keys as object and values generated by running each own enumerable string keyed property of object thru iteratee. The iteratee is invoked with three arguments:
(value, key, object).

Since

2.4.0

Arguments

  1. iteratee (Function): The function invoked per iteration.
  2. object (Object): The object to iterate over.

Returns

(Object): Returns the new mapped object.

Example

var users = {
  'fred':    { 'user': 'fred',    'age': 40 },
  'pebbles': { 'user': 'pebbles', 'age': 1 }
};

_.mapValues(function(o) { return o.age; }, users);
// => { 'fred': 40, 'pebbles': 1 } (iteration order is not guaranteed)

// The `_.property` iteratee shorthand.
_.mapValues('age', users);
// => { 'fred': 40, 'pebbles': 1 } (iteration order is not guaranteed)

_.merge(object, sources)

# Ⓢ Ⓣ Ⓝ

This method is like _.assign except that it recursively merges own and inherited enumerable string keyed properties of source objects into the destination object. Source properties that resolve to undefined are skipped if a destination value exists. Array and plain object properties are merged recursively. Other objects and value types are overridden by assignment. Source objects are applied from left to right. Subsequent sources overwrite property assignments of previous sources.

Since

0.5.0

Arguments

  1. object (Object): The destination object.
  2. sources (Object|Object[]): The source objects.

Returns

(Object): Returns object.

Example

var object = {
  'a': [{ 'b': 2 }, { 'd': 4 }]
};

var other = {
  'a': [{ 'c': 3 }, { 'e': 5 }]
};

_.merge(object, other);
// => { 'a': [{ 'b': 2, 'c': 3 }, { 'd': 4, 'e': 5 }] }

_.mergeWith(customizer, object, sources)

# Ⓢ Ⓣ Ⓝ

This method is like _.merge except that it accepts customizer which is invoked to produce the merged values of the destination and source properties. If customizer returns undefined, merging is handled by the method instead. The customizer is invoked with six arguments:
(objValue, srcValue, key, object, source, stack).

Since

4.0.0

Arguments

  1. customizer (Function): The function to customize assigned values.
  2. object (Object): The destination object.
  3. sources (Object|Object[]): The source objects.

Returns

(Object): Returns object.

Example

function customizer(objValue, srcValue) {
  if (_.isArray(objValue)) {
    return objValue.concat(srcValue);
  }
}

var object = { 'a': [1], 'b': [2] };
var other = { 'a': [3], 'b': [4] };

_.mergeWith(customizer, object, other);
// => { 'a': [1, 3], 'b': [2, 4] }

_.omit(paths, object)

# Ⓢ Ⓣ Ⓝ

The opposite of _.pick; this method creates an object composed of the own and inherited enumerable property paths of object that are not omitted.

Note: This method is considerably slower than _.pick.

Since

0.1.0

Arguments

  1. paths (string|string[]): The property paths to omit.
  2. object (Object): The source object.

Returns

(Object): Returns the new object.

Example

var object = { 'a': 1, 'b': '2', 'c': 3 };

_.omit(['a', 'c'], object);
// => { 'b': '2' }

_.omitBy(predicate, object)

# Ⓢ Ⓣ Ⓝ

The opposite of _.pickBy; this method creates an object composed of the own and inherited enumerable string keyed properties of object that predicate doesn't return truthy for. The predicate is invoked with two arguments: (value, key).

Since

4.0.0

Arguments

  1. predicate (Function): The function invoked per property.
  2. object (Object): The source object.

Returns

(Object): Returns the new object.

Example

var object = { 'a': 1, 'b': '2', 'c': 3 };

_.omitBy(_.isNumber, object);
// => { 'b': '2' }

_.pick(paths, object)

# Ⓢ Ⓣ Ⓝ

Creates an object composed of the picked object properties.

Since

0.1.0

Arguments

  1. paths (string|string[]): The property paths to pick.
  2. object (Object): The source object.

Returns

(Object): Returns the new object.

Example

var object = { 'a': 1, 'b': '2', 'c': 3 };

_.pick(['a', 'c'], object);
// => { 'a': 1, 'c': 3 }

_.pickBy(predicate, object)

# Ⓢ Ⓣ Ⓝ

Creates an object composed of the object properties predicate returns truthy for. The predicate is invoked with two arguments: (value, key).

Since

4.0.0

Arguments

  1. predicate (Function): The function invoked per property.
  2. object (Object): The source object.

Returns

(Object): Returns the new object.

Example

var object = { 'a': 1, 'b': '2', 'c': 3 };

_.pickBy(_.isNumber, object);
// => { 'a': 1, 'c': 3 }

_.result(path, object)

# Ⓢ Ⓣ Ⓝ

This method is like _.get except that if the resolved value is a function it's invoked with the this binding of its parent object and its result is returned.

Since

0.1.0

Arguments

  1. path (Array|string): The path of the property to resolve.
  2. object (Object): The object to query.

Returns

(*): Returns the resolved value.

Example

var object = { 'a': [{ 'b': { 'c1': 3, 'c2': _.constant(4) } }] };

_.result('a[0].b.c1', object);
// => 3

_.result('a[0].b.c2', object);
// => 4

_.result(['a[0].b.c3', 'default'], object);
// => 'default'

_.result(['a[0].b.c3', _.constant('default')], object);
// => 'default'

_.set(path, value, object)

# Ⓢ Ⓣ Ⓝ

Sets the value at path of object. If a portion of path doesn't exist, it's created. Arrays are created for missing index properties while objects are created for all other missing properties. Use _.setWith to customize path creation.

Since

3.7.0

Arguments

  1. path (Array|string): The path of the property to set.
  2. value (*): The value to set.
  3. object (Object): The object to modify.

Returns

(Object): Returns object.

Example

var object = { 'a': [{ 'b': { 'c': 3 } }] };

_.set('a[0].b.c', 4, object);
// => 4

_.set(['x', '0', 'y', 'z'], 5, object);
// => 5

_.setWith(customizer, path, value, object)

# Ⓢ Ⓣ Ⓝ

This method is like _.set except that it accepts customizer which is invoked to produce the objects of path. If customizer returns undefined path creation is handled by the method instead. The customizer is invoked with three arguments: (nsValue, key, nsObject).

Since

4.0.0

Arguments

  1. customizer (Function): The function to customize assigned values.
  2. path (Array|string): The path of the property to set.
  3. value (*): The value to set.
  4. object (Object): The object to modify.

Returns

(Object): Returns object.

Example

var object = {};

_.setWith(Object, '[0][1]', 'a', object);
// => { '0': { '1': 'a' } }

_.toPairs(object)

# Ⓢ Ⓣ Ⓝ

Creates an array of own enumerable string keyed-value pairs for object which can be consumed by _.fromPairs. If object is a map or set, its entries are returned.

Since

4.0.0

Aliases

_.entries

Arguments

  1. object (Object): The object to query.

Returns

(Array): Returns the key-value pairs.

Example

function Foo() {
  this.a = 1;
  this.b = 2;
}

Foo.prototype.c = 3;

_.toPairs(new Foo);
// => [['a', 1], ['b', 2]] (iteration order is not guaranteed)

_.toPairsIn(object)

# Ⓢ Ⓣ Ⓝ

Creates an array of own and inherited enumerable string keyed-value pairs for object which can be consumed by _.fromPairs. If object is a map or set, its entries are returned.

Since

4.0.0

Aliases

_.entriesIn

Arguments

  1. object (Object): The object to query.

Returns

(Array): Returns the key-value pairs.

Example

function Foo() {
  this.a = 1;
  this.b = 2;
}

Foo.prototype.c = 3;

_.toPairsIn(new Foo);
// => [['a', 1], ['b', 2], ['c', 3]] (iteration order is not guaranteed)

_.transform(iteratee, accumulator, object)

# Ⓢ Ⓣ Ⓝ

An alternative to _.reduce; this method transforms object to a new accumulator object which is the result of running each of its own enumerable string keyed properties thru iteratee, with each invocation potentially mutating the accumulator object. If accumulator is not provided, a new object with the same [[Prototype]] will be used. The iteratee is invoked with four arguments: (accumulator, value, key, object). Iteratee functions may exit iteration early by explicitly returning false.

Since

1.3.0

Arguments

  1. iteratee (Function): The function invoked per iteration.
  2. accumulator (*): The custom accumulator value.
  3. object (Object): The object to iterate over.

Returns

(*): Returns the accumulated value.

Example

_.transform(function(result, n) {
  result.push(n *= n);
  return n % 2 == 0;
}, [], [2, 3, 4]);
// => [4, 9]

_.transform(function(result, value, key) {
  (result[value] || (result[value] = [])).push(key);
}, {}, { 'a': 1, 'b': 2, 'c': 1 });
// => { '1': ['a', 'c'], '2': ['b'] }

_.unset(path, object)

# Ⓢ Ⓣ Ⓝ

Removes the property at path of object.

Since

4.0.0

Arguments

  1. path (Array|string): The path of the property to unset.
  2. object (Object): The object to modify.

Returns

(boolean): Returns true if the property is deleted, else false.

Example

var object = { 'a': [{ 'b': { 'c': 7 } }] };
_.unset('a[0].b.c', object);
// => true

// => { 'a': [{ 'b': {} }] };

_.unset(['a', '0', 'b', 'c'], object);
// => true

// => { 'a': [{ 'b': {} }] };

_.update(path, updater, object)

# Ⓢ Ⓣ Ⓝ

This method is like _.set except that accepts updater to produce the value to set. Use _.updateWith to customize path creation. The updater is invoked with one argument: (value).

Since

4.6.0

Arguments

  1. path (Array|string): The path of the property to set.
  2. updater (Function): The function to produce the updated value.
  3. object (Object): The object to modify.

Returns

(Object): Returns object.

Example

var object = { 'a': [{ 'b': { 'c': 3 } }] };

_.update('a[0].b.c', function(n) { return n * n; }, object);
// => 9

_.update('x[0].y.z', function(n) { return n ? n + 1 : 0; }, object);
// => 0

_.updateWith(customizer, path, updater, object)

# Ⓢ Ⓣ Ⓝ

This method is like _.update except that it accepts customizer which is invoked to produce the objects of path. If customizer returns undefined path creation is handled by the method instead. The customizer is invoked with three arguments: (nsValue, key, nsObject).

Since

4.6.0

Arguments

  1. customizer (Function): The function to customize assigned values.
  2. path (Array|string): The path of the property to set.
  3. updater (Function): The function to produce the updated value.
  4. object (Object): The object to modify.

Returns

(Object): Returns object.

Example

var object = {};

_.updateWith(Object, '[0][1]', _.constant('a'), object);
// => { '0': { '1': 'a' } }

_.values(object)

# Ⓢ Ⓣ Ⓝ

Creates an array of the own enumerable string keyed property values of object.

Note: Non-object values are coerced to objects.

Since

0.1.0

Arguments

  1. object (Object): The object to query.

Returns

(Array): Returns the array of property values.

Example

function Foo() {
  this.a = 1;
  this.b = 2;
}

Foo.prototype.c = 3;

_.values(new Foo);
// => [1, 2] (iteration order is not guaranteed)

_.values('hi');
// => ['h', 'i']

_.valuesIn(object)

# Ⓢ Ⓣ Ⓝ

Creates an array of the own and inherited enumerable string keyed property values of object.

Note: Non-object values are coerced to objects.

Since

3.0.0

Arguments

  1. object (Object): The object to query.

Returns

(Array): Returns the array of property values.

Example

function Foo() {
  this.a = 1;
  this.b = 2;
}

Foo.prototype.c = 3;

_.valuesIn(new Foo);
// => [1, 2, 3] (iteration order is not guaranteed)

“Seq” Methods

_()

# Ⓢ Ⓣ

Creates a lodash object which wraps value to enable implicit method chain sequences. Methods that operate on and return arrays, collections, and functions can be chained together. Methods that retrieve a single value or may return a primitive value will automatically end the chain sequence and return the unwrapped value. Otherwise, the value must be unwrapped with _#value.

Explicit chain sequences, which must be unwrapped with _#value, may be enabled using _.chain.

The execution of chained methods is lazy, that is, it's deferred until _#value is implicitly or explicitly called.

Lazy evaluation allows several methods to support shortcut fusion. Shortcut fusion is an optimization to merge iteratee calls; this avoids the creation of intermediate arrays and can greatly reduce the number of iteratee executions. Sections of a chain sequence qualify for shortcut fusion if the section is applied to an array and iteratees accept only one argument. The heuristic for whether a section qualifies for shortcut fusion is subject to change.

Chaining is supported in custom builds as long as the _#value method is directly or indirectly included in the build.

In addition to lodash methods, wrappers have Array and String methods.

The wrapper Array methods are:
concat, join, pop, push, shift, sort, splice, and unshift

The wrapper String methods are:
replace and split

The wrapper methods that support shortcut fusion are:
at, compact, drop, dropRight, dropWhile, filter, find, findLast, head, initial, last, map, reject, reverse, slice, tail, take, takeRight, takeRightWhile, takeWhile, and toArray

The chainable wrapper methods are:
after, ary, assign, assignIn, assignInWith, assignWith, at, before, bind, bindAll, bindKey, castArray, chain, chunk, commit, compact, concat, conforms, constant, countBy, create, curry, debounce, defaults, defaultsDeep, defer, delay, difference, differenceBy, differenceWith, drop, dropRight, dropRightWhile, dropWhile, extend, extendWith, fill, filter, flatMap, flatMapDeep, flatMapDepth, flatten, flattenDeep, flattenDepth, flip, flow, flowRight, fromPairs, functions, functionsIn, groupBy, initial, intersection, intersectionBy, intersectionWith, invert, invertBy, invokeMap, iteratee, keyBy, keys, keysIn, map, mapKeys, mapValues, matches, matchesProperty, memoize, merge, mergeWith, method, methodOf, mixin, negate, nthArg, omit, omitBy, once, orderBy, over, overArgs, overEvery, overSome, partial, partialRight, partition, pick, pickBy, plant, property, propertyOf, pull, pullAll, pullAllBy, pullAllWith, pullAt, push, range, rangeRight, rearg, reject, remove, rest, reverse, sampleSize, set, setWith, shuffle, slice, sort, sortBy, splice, spread, tail, take, takeRight, takeRightWhile, takeWhile, tap, throttle, thru, toArray, toPairs, toPairsIn, toPath, toPlainObject, transform, unary, union, unionBy, unionWith, uniq, uniqBy, uniqWith, unset, unshift, unzip, unzipWith, update, updateWith, values, valuesIn, without, wrap, xor, xorBy, xorWith, zip, zipObject, zipObjectDeep, and zipWith

The wrapper methods that are not chainable by default are:
add, attempt, camelCase, capitalize, ceil, clamp, clone, cloneDeep, cloneDeepWith, cloneWith, conformsTo, deburr, defaultTo, divide, each, eachRight, endsWith, eq, escape, escapeRegExp, every, find, findIndex, findKey, findLast, findLastIndex, findLastKey, first, floor, forEach, forEachRight, forIn, forInRight, forOwn, forOwnRight, get, gt, gte, has, hasIn, head, identity, includes, indexOf, inRange, invoke, isArguments, isArray, isArrayBuffer, isArrayLike, isArrayLikeObject, isBoolean, isBuffer, isDate, isElement, isEmpty, isEqual, isEqualWith, isError, isFinite, isFunction, isInteger, isLength, isMap, isMatch, isMatchWith, isNaN, isNative, isNil, isNull, isNumber, isObject, isObjectLike, isPlainObject, isRegExp, isSafeInteger, isSet, isString, isUndefined, isTypedArray, isWeakMap, isWeakSet, join, kebabCase, last, lastIndexOf, lowerCase, lowerFirst, lt, lte, max, maxBy, mean, meanBy, min, minBy, multiply, noConflict, noop, now, nth, pad, padEnd, padStart, parseInt, pop, random, reduce, reduceRight, repeat, result, round, runInContext, sample, shift, size, snakeCase, some, sortedIndex, sortedIndexBy, sortedLastIndex, sortedLastIndexBy, startCase, startsWith, stubArray, stubFalse, stubObject, stubString, stubTrue, subtract, sum, sumBy, template, times, toFinite, toInteger, toJSON, toLength, toLower, toNumber, toSafeInteger, toString, toUpper, trim, trimEnd, trimStart, truncate, unescape, uniqueId, upperCase, upperFirst, value, and words

Returns

(Object): Returns the new lodash wrapper instance.

Example

function square(n) {
  return n * n;
}

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

// Returns an unwrapped value.
wrapped.reduce(_.add);
// => 6

// Returns a wrapped value.
var squares = wrapped.map(square);

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

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

_.chain(value)

# Ⓢ Ⓣ

Creates a lodash wrapper instance that wraps value with explicit method chain sequences enabled. The result of such sequences must be unwrapped with _#value.

Since

1.3.0

Arguments

  1. value (*): The value to wrap.

Returns

(Object): Returns the new lodash wrapper instance.

Example

var users = [
  { 'user': 'barney',  'age': 36 },
  { 'user': 'fred',    'age': 40 },
  { 'user': 'pebbles', 'age': 1 }
];

var youngest = _
  .chain(users)
  .sortBy('age')
  .map(function(o) {
    return o.user + ' is ' + o.age;
  })
  .head()
  .value();
// => 'pebbles is 1'

_.tap(interceptor, value)

# Ⓢ Ⓣ

This method invokes interceptor and returns value. The interceptor is invoked with one argument; (value). The purpose of this method is to "tap into" a method chain sequence in order to modify intermediate results.

Since

0.1.0

Arguments

  1. interceptor (Function): The function to invoke.
  2. value (*): The value to provide to interceptor.

Returns

(*): Returns value.

Example

_([1, 2, 3])
 .tap(function(array) {
   // Mutate input array.
   array.pop();
 })
 .reverse()
 .value();
// => [2, 1]

_.thru(interceptor, value)

# Ⓢ Ⓣ

This method is like _.tap except that it returns the result of interceptor. The purpose of this method is to "pass thru" values replacing intermediate results in a method chain sequence.

Since

3.0.0

Arguments

  1. interceptor (Function): The function to invoke.
  2. value (*): The value to provide to interceptor.

Returns

(*): Returns the result of interceptor.

Example

_('  abc  ')
 .chain()
 .trim()
 .thru(function(value) {
   return [value];
 })
 .value();
// => ['abc']

_.prototype[Symbol.iterator]()

# Ⓢ Ⓣ

Enables the wrapper to be iterable.

Since

4.0.0

Returns

(Object): Returns the wrapper object.

Example

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

wrapped[Symbol.iterator]() === wrapped;
// => true

Array.from(wrapped);
// => [1, 2]

_.prototype.at()

# Ⓢ Ⓣ

This method is the wrapper version of _.at.

Since

1.0.0

Returns

(Object): Returns the new lodash wrapper instance.

Example

var object = { 'a': [{ 'b': { 'c': 3 } }, 4] };

_(object).at(['a[0].b.c', 'a[1]']).value();
// => [3, 4]

_.prototype.chain()

# Ⓢ Ⓣ

Creates a lodash wrapper instance with explicit method chain sequences enabled.

Since

0.1.0

Returns

(Object): Returns the new lodash wrapper instance.

Example

var users = [
  { 'user': 'barney', 'age': 36 },
  { 'user': 'fred',   'age': 40 }
];

// A sequence without explicit chaining.
_(users).head();
// => { 'user': 'barney', 'age': 36 }

// A sequence with explicit chaining.
_(users)
  .chain()
  .head()
  .pick('user')
  .value();
// => { 'user': 'barney' }

_.prototype.commit()

# Ⓢ Ⓣ

Executes the chain sequence and returns the wrapped result.

Since

3.2.0

Returns

(Object): Returns the new lodash wrapper instance.

Example

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

// => [1, 2]

wrapped = wrapped.commit();
// => [1, 2, 3]

wrapped.last();
// => 3

// => [1, 2, 3]

_.prototype.next()

# Ⓢ Ⓣ

Gets the next value on a wrapped object following the iterator protocol.

Since

4.0.0

Returns

(Object): Returns the next iterator value.

Example

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

wrapped.next();
// => { 'done': false, 'value': 1 }

wrapped.next();
// => { 'done': false, 'value': 2 }

wrapped.next();
// => { 'done': true, 'value': undefined }

_.prototype.plant()

# Ⓢ Ⓣ

Creates a clone of the chain sequence planting value as the wrapped value.

Since

3.2.0

Returns

(Object): Returns the new lodash wrapper instance.

Example

function square(n) {
  return n * n;
}

var wrapped = _([1, 2]).map(square);
var other = wrapped.plant([3, 4]);

other.value();
// => [9, 16]

wrapped.value();
// => [1, 4]

_.prototype.reverse()

# Ⓢ Ⓣ

This method is the wrapper version of _.reverse.

Since

0.1.0

Returns

(Object): Returns the new lodash wrapper instance.

Example

var array = [1, 2, 3];

_(array).reverse().value()
// => [3, 2, 1]

// => [3, 2, 1]

_.prototype.value()

# Ⓢ Ⓣ

Executes the chain sequence to resolve the unwrapped value.

Since

0.1.0

Aliases

_.prototype.toJSON, _.prototype.valueOf

Returns

(*): Returns the resolved unwrapped value.

Example

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

“String” Methods

_.camelCase(string)

# Ⓢ Ⓣ Ⓝ

Converts string to camel case.

Since

3.0.0

Arguments

  1. string (string): The string to convert.

Returns

(string): Returns the camel cased string.

Example

_.camelCase('Foo Bar');
// => 'fooBar'

_.camelCase('--foo-bar--');
// => 'fooBar'

_.camelCase('__FOO_BAR__');
// => 'fooBar'

_.capitalize(string)

# Ⓢ Ⓣ Ⓝ

Converts the first character of string to upper case and the remaining to lower case.

Since

3.0.0

Arguments

  1. string (string): The string to capitalize.

Returns

(string): Returns the capitalized string.

Example

_.capitalize('FRED');
// => 'Fred'

_.deburr(string)

# Ⓢ Ⓣ Ⓝ

Deburrs string by converting Latin-1 Supplement and Latin Extended-A letters to basic Latin letters and removing combining diacritical marks.

Since

3.0.0

Arguments

  1. string (string): The string to deburr.

Returns

(string): Returns the deburred string.

Example

_.deburr('déjà vu');
// => 'deja vu'

_.endsWith(target, string)

# Ⓢ Ⓣ Ⓝ

Checks if string ends with the given target string.

Since

3.0.0

Arguments

  1. target (string): The string to search for.
  2. string (string): The string to inspect.

Returns

(boolean): Returns true if string ends with target, else false.

Example

_.endsWith('c', 'abc');
// => true

_.endsWith('b', 'abc');
// => false

_.endsWith(['b', 2], 'abc');
// => true

_.escape(string)

# Ⓢ Ⓣ Ⓝ

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

Note: No other characters are escaped. To escape additional characters use a third-party library like he.

Though the ">" character is escaped for symmetry, characters like ">" and "/" don't need escaping in HTML and have no special meaning unless they're part of a tag or unquoted attribute value. See Mathias Bynens's article (under "semi-related fun fact") for more details.

When working with HTML you should always quote attribute values to reduce XSS vectors.

Since

0.1.0

Arguments

  1. string (string): The string to escape.

Returns

(string): Returns the escaped string.

Example

_.escape('fred, barney, & pebbles');
// => 'fred, barney, &amp; pebbles'

_.escapeRegExp(string)

# Ⓢ Ⓣ Ⓝ

Escapes the RegExp special characters "^", "$", "", ".", "*", "+", "?", "(", ")", "[", "]", "{", "}", and "|" in string.

Since

3.0.0

Arguments

  1. string (string): The string to escape.

Returns

(string): Returns the escaped string.

Example

_.escapeRegExp('[lodash](https://lodash.com/)');
// => '\[lodash\]\(https://lodash\.com/\)'

_.kebabCase(string)

# Ⓢ Ⓣ Ⓝ

Converts string to kebab case.

Since

3.0.0

Arguments

  1. string (string): The string to convert.

Returns

(string): Returns the kebab cased string.

Example

_.kebabCase('Foo Bar');
// => 'foo-bar'

_.kebabCase('fooBar');
// => 'foo-bar'

_.kebabCase('__FOO_BAR__');
// => 'foo-bar'

_.lowerCase(string)

# Ⓢ Ⓣ Ⓝ

Converts string, as space separated words, to lower case.

Since

4.0.0

Arguments

  1. string (string): The string to convert.

Returns

(string): Returns the lower cased string.

Example

_.lowerCase('--Foo-Bar--');
// => 'foo bar'

_.lowerCase('fooBar');
// => 'foo bar'

_.lowerCase('__FOO_BAR__');
// => 'foo bar'

_.lowerFirst(string)

# Ⓢ Ⓣ Ⓝ

Converts the first character of string to lower case.

Since

4.0.0

Arguments

  1. string (string): The string to convert.

Returns

(string): Returns the converted string.

Example

_.lowerFirst('Fred');
// => 'fred'

_.lowerFirst('FRED');
// => 'fRED'

_.pad(length, string)

# Ⓢ Ⓣ Ⓝ

Pads string on the left and right sides if it's shorter than length. Padding characters are truncated if they can't be evenly divided by length.

Since

3.0.0

Arguments

  1. length (number): The padding length.
  2. string (string): The string to pad.

Returns

(string): Returns the padded string.

Example

_.pad(8, 'abc');
// => '  abc   '

_.pad([8, '_-'], 'abc');
// => '_-abc_-_'

_.pad(3, 'abc');
// => 'abc'

_.padEnd(length, string)

# Ⓢ Ⓣ Ⓝ

Pads string on the right side if it's shorter than length. Padding characters are truncated if they exceed length.

Since

4.0.0

Arguments

  1. length (number): The padding length.
  2. string (string): The string to pad.

Returns

(string): Returns the padded string.

Example

_.padEnd(6, 'abc');
// => 'abc   '

_.padEnd([6, '_-'], 'abc');
// => 'abc_-_'

_.padEnd(3, 'abc');
// => 'abc'

_.padStart(length, string)

# Ⓢ Ⓣ Ⓝ

Pads string on the left side if it's shorter than length. Padding characters are truncated if they exceed length.

Since

4.0.0

Arguments

  1. length (number): The padding length.
  2. string (string): The string to pad.

Returns

(string): Returns the padded string.

Example

_.padStart(6, 'abc');
// => '   abc'

_.padStart([6, '_-'], 'abc');
// => '_-_abc'

_.padStart(3, 'abc');
// => 'abc'

_.parseInt(radix, string)

# Ⓢ Ⓣ Ⓝ

Converts string to an integer of the specified radix. If radix is undefined or 0, a radix of 10 is used unless value is a hexadecimal, in which case a radix of 16 is used.

Note: This method aligns with the ES5 implementation of parseInt.

Since

1.1.0

Arguments

  1. radix (number): The radix to interpret value by.
  2. string (string): The string to convert.

Returns

(number): Returns the converted integer.

Example

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

_.map(_.parseInt, ['6', '08', '10']);
// => [6, 8, 10]

_.repeat(n, string)

# Ⓢ Ⓣ Ⓝ

Repeats the given string n times.

Since

3.0.0

Arguments

  1. n (number): The number of times to repeat the string.
  2. string (string): The string to repeat.

Returns

(string): Returns the repeated string.

Example

_.repeat(3, '*');
// => '***'

_.repeat(2, 'abc');
// => 'abcabc'

_.repeat(0, 'abc');
// => ''

_.replace(pattern, replacement, string)

# Ⓢ Ⓣ Ⓝ

Replaces matches for pattern in string with replacement.

Note: This method is based on String#replace.

Since

4.0.0

Arguments

  1. pattern (RegExp|string): The pattern to replace.
  2. replacement (Function|string): The match replacement.
  3. string (string): The string to modify.

Returns

(string): Returns the modified string.

Example

_.replace('Fred', 'Barney', 'Hi Fred');
// => 'Hi Barney'

_.snakeCase(string)

# Ⓢ Ⓣ Ⓝ

Converts string to snake case.

Since

3.0.0

Arguments

  1. string (string): The string to convert.

Returns

(string): Returns the snake cased string.

Example

_.snakeCase('Foo Bar');
// => 'foo_bar'

_.snakeCase('fooBar');
// => 'foo_bar'

_.snakeCase('--FOO-BAR--');
// => 'foo_bar'

_.split(separator, string)

# Ⓢ Ⓣ Ⓝ

Splits string by separator.

Note: This method is based on String#split.

Since

4.0.0

Arguments

  1. separator (RegExp|string): The separator pattern to split by.
  2. string (string): The string to split.

Returns

(Array): Returns the string segments.

Example

_.split(['-', 2], 'a-b-c');
// => ['a', 'b']

_.startCase(string)

# Ⓢ Ⓣ Ⓝ

Converts string to start case.

Since

3.1.0

Arguments

  1. string (string): The string to convert.

Returns

(string): Returns the start cased string.

Example

_.startCase('--foo-bar--');
// => 'Foo Bar'

_.startCase('fooBar');
// => 'Foo Bar'

_.startCase('__FOO_BAR__');
// => 'FOO BAR'

_.startsWith(target, string)

# Ⓢ Ⓣ Ⓝ

Checks if string starts with the given target string.

Since

3.0.0

Arguments

  1. target (string): The string to search for.
  2. string (string): The string to inspect.

Returns

(boolean): Returns true if string starts with target, else false.

Example

_.startsWith('a', 'abc');
// => true

_.startsWith('b', 'abc');
// => false

_.startsWith(['b', 1], 'abc');
// => true

_.template(string)

# Ⓢ Ⓣ Ⓝ

Creates a compiled template function that can interpolate data properties in "interpolate" delimiters, HTML-escape interpolated data properties in "escape" delimiters, and execute JavaScript in "evaluate" delimiters. Data properties may be accessed as free variables in the template. If a setting object is given, it takes precedence over _.templateSettings values.

Note: In the development build _.template utilizes sourceURLs for easier debugging.

For more information on precompiling templates see lodash's custom builds documentation.

For more information on Chrome extension sandboxes see Chrome's extensions documentation.

Since

0.1.0

Arguments

  1. string (string): The template string.

Returns

(Function): Returns the compiled template function.

Example

// Use the "interpolate" delimiter to create a compiled template.
var compiled = _.template('hello <%= user %>!');
compiled({ 'user': 'fred' });
// => 'hello fred!'

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

// Use the "evaluate" delimiter to execute JavaScript and generate HTML.
var compiled = _.template('<% _.forEach(users, function(user) { %><li><%- user %></li><% }); %>');
compiled({ 'users': ['fred', 'barney'] });
// => '<li>fred</li><li>barney</li>'

// Use the internal `print` function in "evaluate" delimiters.
var compiled = _.template('<% print("hello " + user); %>!');
compiled({ 'user': 'barney' });
// => 'hello barney!'

// Use the ES template literal delimiter as an "interpolate" delimiter.
// Disable support by replacing the "interpolate" delimiter.
var compiled = _.template('hello ${ user }!');
compiled({ 'user': 'pebbles' });
// => 'hello pebbles!'

// Use backslashes to treat delimiters as plain text.
var compiled = _.template('<%= "\\<%- value %\\>" %>');
compiled({ 'value': 'ignored' });
// => '<%- value %>'

// Use the `imports` option to import `jQuery` as `jq`.
var text = '<% jq.each(users, function(user) { %><li><%- user %></li><% }); %>';
var compiled = _.template([text, { 'imports': { 'jq': jQuery } }]);
compiled({ 'users': ['fred', 'barney'] });
// => '<li>fred</li><li>barney</li>'

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

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

// Use custom template delimiters.
_.templateSettings.interpolate = /{{([\s\S]+?)}}/g;
var compiled = _.template('hello {{ user }}!');
compiled({ 'user': 'mustache' });
// => 'hello mustache!'

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

_.toLower(string)

# Ⓢ Ⓣ Ⓝ

Converts string, as a whole, to lower case just like String#toLowerCase.

Since

4.0.0

Arguments

  1. string (string): The string to convert.

Returns

(string): Returns the lower cased string.

Example

_.toLower('--Foo-Bar--');
// => '--foo-bar--'

_.toLower('fooBar');
// => 'foobar'

_.toLower('__FOO_BAR__');
// => '__foo_bar__'

_.toUpper(string)

# Ⓢ Ⓣ Ⓝ

Converts string, as a whole, to upper case just like String#toUpperCase.

Since

4.0.0

Arguments

  1. string (string): The string to convert.

Returns

(string): Returns the upper cased string.

Example

_.toUpper('--foo-bar--');
// => '--FOO-BAR--'

_.toUpper('fooBar');
// => 'FOOBAR'

_.toUpper('__foo_bar__');
// => '__FOO_BAR__'

_.trim(string)

# Ⓢ Ⓣ Ⓝ

Removes leading and trailing whitespace or specified characters from string.

Since

3.0.0

Arguments

  1. string (string): The string to trim.

Returns

(string): Returns the trimmed string.

Example

_.trim('  abc  ');
// => 'abc'

_.trim(['-_-abc-_-', '_-']);
// => 'abc'

_.map(_.trim, ['  foo  ', '  bar  ']);
// => ['foo', 'bar']

_.trimEnd(string)

# Ⓢ Ⓣ Ⓝ

Removes trailing whitespace or specified characters from string.

Since

4.0.0

Arguments

  1. string (string): The string to trim.

Returns

(string): Returns the trimmed string.

Example

_.trimEnd('  abc  ');
// => '  abc'

_.trimEnd(['-_-abc-_-', '_-']);
// => '-_-abc'

_.trimStart(string)

# Ⓢ Ⓣ Ⓝ

Removes leading whitespace or specified characters from string.

Since

4.0.0

Arguments

  1. string (string): The string to trim.

Returns

(string): Returns the trimmed string.

Example

_.trimStart('  abc  ');
// => 'abc  '

_.trimStart(['-_-abc-_-', '_-']);
// => 'abc-_-'

_.truncate(options, string)

# Ⓢ Ⓣ Ⓝ

Truncates string if it's longer than the given maximum string length. The last characters of the truncated string are replaced with the omission string which defaults to "...".

Since

4.0.0

Arguments

  1. options (Object): The options object.
  2. string (string): The string to truncate.

Returns

(string): Returns the truncated string.

Example

_.truncate({}, 'hi-diddly-ho there, neighborino');
// => 'hi-diddly-ho there, neighbo...'

_.truncate({
  'length': 24,
  'separator': ' '
}, 'hi-diddly-ho there, neighborino');
// => 'hi-diddly-ho there,...'

_.truncate({
  'length': 24,
  'separator': /,? +/
}, 'hi-diddly-ho there, neighborino');
// => 'hi-diddly-ho there...'

_.truncate({
  'omission': ' [...]'
}, 'hi-diddly-ho there, neighborino');
// => 'hi-diddly-ho there, neig [...]'

_.unescape(string)

# Ⓢ Ⓣ Ⓝ

The inverse of _.escape; this method converts the HTML entities &amp;, &lt;, &gt;, &quot;, and &#39; in string to their corresponding characters.

Note: No other HTML entities are unescaped. To unescape additional HTML entities use a third-party library like he.

Since

0.6.0

Arguments

  1. string (string): The string to unescape.

Returns

(string): Returns the unescaped string.

Example

_.unescape('fred, barney, &amp; pebbles');
// => 'fred, barney, & pebbles'

_.upperCase(string)

# Ⓢ Ⓣ Ⓝ

Converts string, as space separated words, to upper case.

Since

4.0.0

Arguments

  1. string (string): The string to convert.

Returns

(string): Returns the upper cased string.

Example

_.upperCase('--foo-bar');
// => 'FOO BAR'

_.upperCase('fooBar');
// => 'FOO BAR'

_.upperCase('__foo_bar__');
// => 'FOO BAR'

_.upperFirst(string)

# Ⓢ Ⓣ Ⓝ

Converts the first character of string to upper case.

Since

4.0.0

Arguments

  1. string (string): The string to convert.

Returns

(string): Returns the converted string.

Example

_.upperFirst('fred');
// => 'Fred'

_.upperFirst('FRED');
// => 'FRED'

_.words(string)

# Ⓢ Ⓣ Ⓝ

Splits string into an array of its words.

Since

3.0.0

Arguments

  1. string (string): The string to inspect.

Returns

(Array): Returns the words of string.

Example

_.words('fred, barney, & pebbles');
// => ['fred', 'barney', 'pebbles']

_.words(['fred, barney, & pebbles', /[^, ]+/g]);
// => ['fred', 'barney', '&', 'pebbles']

“Util” Methods

_.attempt(func)

# Ⓢ Ⓣ Ⓝ

Attempts to invoke func, returning either the result or the caught error object. Any additional arguments are provided to func when it's invoked.

Since

3.0.0

Arguments

  1. func (Function): The function to attempt.

Returns

(*): Returns the func result or error object.

Example

// Avoid throwing errors for invalid selectors.
var elements = _.attempt([function(selector) {
  return document.querySelectorAll(selector);
}, '>_>']);

if (_.isError(elements)) {
  elements = [];
}

_.bindAll(methodNames, object)

# Ⓢ Ⓣ Ⓝ

Binds methods of an object to the object itself, overwriting the existing method.

Note: This method doesn't set the "length" property of bound functions.

Since

0.1.0

Arguments

  1. methodNames (string|string[]): The object method names to bind.
  2. object (Object): The object to bind and assign the bound methods to.

Returns

(Object): Returns object.

Example

var view = {
  'label': 'docs',
  'click': function() {
    console.log('clicked ' + this.label);
  }
};

_.bindAll(['click'], view);
jQuery(element).on('click', view.click);
// => Logs 'clicked docs' when clicked.

_.cond(pairs)

# Ⓢ Ⓣ Ⓝ

Creates a function that iterates over pairs and invokes the corresponding function of the first predicate to return truthy. The predicate-function pairs are invoked with the this binding and arguments of the created function.

Since

4.0.0

Arguments

  1. pairs (Array): The predicate-function pairs.

Returns

(Function): Returns the new composite function.

Example

var func = _.cond([
  [_.matches({ 'a': 1 }),           _.constant('matches A')],
  [_.conforms({ 'b': _.isNumber }), _.constant('matches B')],
  [_.stubTrue,                      _.constant('no match')]
]);

func({ 'a': 1, 'b': 2 });
// => 'matches A'

func({ 'a': 0, 'b': 1 });
// => 'matches B'

func({ 'a': '1', 'b': '2' });
// => 'no match'

_.conforms(source)

# Ⓢ Ⓣ Ⓝ

Creates a function that invokes the predicate properties of source with the corresponding property values of a given object, returning true if all predicates return truthy, else false.

Note: The created function is equivalent to _.conformsTo with source partially applied.

Since

4.0.0

Arguments

  1. source (Object): The object of property predicates to conform to.

Returns

(Function): Returns the new spec function.

Example

var objects = [
  { 'a': 2, 'b': 1 },
  { 'a': 1, 'b': 2 }
];

_.filter(_.conforms({ 'b': function(n) { return n > 1; } }), objects);
// => [{ 'a': 1, 'b': 2 }]

_.constant(value)

# Ⓢ Ⓣ Ⓝ

Creates a function that returns value.

Since

2.4.0

Arguments

  1. value (*): The value to return from the new function.

Returns

(Function): Returns the new constant function.

Example

var objects = _.times(_.constant({ 'a': 1 }), 2);

// => [{ 'a': 1 }, { 'a': 1 }]

// => true

_.defaultTo(defaultValue, value)

# Ⓢ Ⓣ Ⓝ

Checks value to determine whether a default value should be returned in its place. The defaultValue is returned if value is NaN, null, or undefined.

Since

4.14.0

Arguments

  1. defaultValue (*): The default value.
  2. value (*): The value to check.

Returns

(*): Returns the resolved value.

Example

_.defaultTo(10, 1);
// => 1

_.defaultTo(10, undefined);
// => 10

_.flow(funcs)

# Ⓢ Ⓣ Ⓝ

Creates a function that returns the result of invoking the given functions with the this binding of the created function, where each successive invocation is supplied the return value of the previous.

Since

3.0.0

Arguments

  1. funcs (Function|Function[]): The functions to invoke.

Returns

(Function): Returns the new composite function.

Example

function square(n) {
  return n * n;
}

var addSquare = _.flow([_.add, square]);
addSquare(1, 2);
// => 9

_.flowRight(funcs)

# Ⓢ Ⓣ Ⓝ

This method is like _.flow except that it creates a function that invokes the given functions from right to left.

Since

3.0.0

Arguments

  1. funcs (Function|Function[]): The functions to invoke.

Returns

(Function): Returns the new composite function.

Example

function square(n) {
  return n * n;
}

var addSquare = _.flowRight([square, _.add]);
addSquare(1, 2);
// => 9

_.identity(value)

# Ⓢ Ⓣ Ⓝ

This method returns the first argument it receives.

Since

0.1.0

Arguments

  1. value (*): Any value.

Returns

(*): Returns value.

Example

var object = { 'a': 1 };

// => true

_.iteratee(func)

# Ⓢ Ⓣ Ⓝ

Creates a function that invokes func with the arguments of the created function. If func is a property name, the created function returns the property value for a given element. If func is an array or object, the created function returns true for elements that contain the equivalent source properties, otherwise it returns false.

Since

4.0.0

Arguments

  1. func (*): The value to convert to a callback.

Returns

(Function): Returns the callback.

Example

var users = [
  { 'user': 'barney', 'age': 36, 'active': true },
  { 'user': 'fred',   'age': 40, 'active': false }
];

// The `_.matches` iteratee shorthand.
_.filter(_.iteratee({ 'user': 'barney', 'active': true }), users);
// => [{ 'user': 'barney', 'age': 36, 'active': true }]

// The `_.matchesProperty` iteratee shorthand.
_.filter(_.iteratee(['user', 'fred']), users);
// => [{ 'user': 'fred', 'age': 40 }]

// The `_.property` iteratee shorthand.
_.map(_.iteratee('user'), users);
// => ['barney', 'fred']

// Create custom iteratee shorthands.
_.iteratee = _.wrap(function(iteratee, func) {
  return !_.isRegExp(func) ? iteratee(func) : function(string) {
    return func.test(string);
  };
}, _.iteratee);

_.filter(/ef/, ['abc', 'def']);
// => ['def']

_.matches(source)

# Ⓢ Ⓣ Ⓝ

Creates a function that performs a partial deep comparison between a given object and source, returning true if the given object has equivalent property values, else false.

Note: The created function is equivalent to _.isMatch with source partially applied.

Partial comparisons will match empty array and empty object source values against any array or object value, respectively. See _.isEqual for a list of supported value comparisons.

Note: Multiple values can be checked by combining several matchers using _.overSome

Since

3.0.0

Arguments

  1. source (Object): The object of property values to match.

Returns

(Function): Returns the new spec function.

Example

var objects = [
  { 'a': 1, 'b': 2, 'c': 3 },
  { 'a': 4, 'b': 5, 'c': 6 }
];

_.filter(_.matches({ 'a': 4, 'c': 6 }), objects);
// => [{ 'a': 4, 'b': 5, 'c': 6 }]

// Checking for several possible values
_.filter(_.overSome([_.matches({ 'a': 1 }), _.matches({ 'a': 4 })]), objects);
// => [{ 'a': 1, 'b': 2, 'c': 3 }, { 'a': 4, 'b': 5, 'c': 6 }]

_.matchesProperty(path, srcValue)

# Ⓢ Ⓣ Ⓝ

Creates a function that performs a partial deep comparison between the value at path of a given object to srcValue, returning true if the object value is equivalent, else false.

Note: Partial comparisons will match empty array and empty object srcValue values against any array or object value, respectively. See _.isEqual for a list of supported value comparisons.

Note: Multiple values can be checked by combining several matchers using _.overSome

Since

3.2.0

Arguments

  1. path (Array|string): The path of the property to get.
  2. srcValue (*): The value to match.

Returns

(Function): Returns the new spec function.

Example

var objects = [
  { 'a': 1, 'b': 2, 'c': 3 },
  { 'a': 4, 'b': 5, 'c': 6 }
];

_.find(_.matchesProperty('a', 4), objects);
// => { 'a': 4, 'b': 5, 'c': 6 }

// Checking for several possible values
_.filter(
  _.overSome([_.matchesProperty('a', 1), _.matchesProperty('a', 4)]),
  objects
);
// => [{ 'a': 1, 'b': 2, 'c': 3 }, { 'a': 4, 'b': 5, 'c': 6 }]

_.method(path)

# Ⓢ Ⓣ Ⓝ

Creates a function that invokes the method at path of a given object. Any additional arguments are provided to the invoked method.

Since

3.7.0

Arguments

  1. path (Array|string): The path of the method to invoke.

Returns

(Function): Returns the new invoker function.

Example

var objects = [
  { 'a': { 'b': _.constant(2) } },
  { 'a': { 'b': _.constant(1) } }
];

_.map(_.method('a.b'), objects);
// => [2, 1]

_.map(_.method(['a', 'b']), objects);
// => [2, 1]

_.methodOf(object)

# Ⓢ Ⓣ Ⓝ

The opposite of _.method; this method creates a function that invokes the method at a given path of object. Any additional arguments are provided to the invoked method.

Since

3.7.0

Arguments

  1. object (Object): The object to query.

Returns

(Function): Returns the new invoker function.

Example

var array = _.times(_.constant, 3),
    object = { 'a': array, 'b': array, 'c': array };

_.map(_.methodOf(object), ['a[2]', 'c[0]']);
// => [2, 0]

_.map(_.methodOf(object), [['a', '2'], ['c', '0']]);
// => [2, 0]

_.mixin(object)

# Ⓢ Ⓣ Ⓝ

Adds all own enumerable string keyed function properties of a source object to the destination object. If object is a function, then methods are added to its prototype as well.

Note: Use _.runInContext to create a pristine lodash function to avoid conflicts caused by modifying the original.

Since

0.1.0

Arguments

  1. object (Function|Object): The destination object.

Returns

(*): Returns object.

Example

function vowels(string) {
  return _.filter(function(v) {
    return /[aeiou]/i.test(v);
  }, string);
}

_.mixin({ 'vowels': vowels });
_.vowels('fred');
// => ['e']

_('fred').vowels().value();
// => ['e']

_.mixin([{ 'vowels': vowels }, { 'chain': false }]);
_('fred').vowels();
// => ['e']

_.noConflict()

# Ⓢ Ⓣ Ⓝ

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

Since

0.1.0

Returns

(Function): Returns the lodash function.

Example

var lodash = _.noConflict(null);

_.noop()

# Ⓢ Ⓣ Ⓝ

This method returns undefined.

Since

2.3.0

Example

_.times(_.noop, 2);
// => [undefined, undefined]

_.nthArg(n)

# Ⓢ Ⓣ Ⓝ

Creates a function that gets the argument at index n. If n is negative, the nth argument from the end is returned.

Since

4.0.0

Arguments

  1. n (number): The index of the argument to return.

Returns

(Function): Returns the new pass-thru function.

Example

var func = _.nthArg(1);
func('a', 'b', 'c', 'd');
// => 'b'

var func = _.nthArg(-2);
func('a', 'b', 'c', 'd');
// => 'c'

_.over(iteratees)

# Ⓢ Ⓣ Ⓝ

Creates a function that invokes iteratees with the arguments it receives and returns their results.

Since

4.0.0

Arguments

  1. iteratees (Function|Function[]): The iteratees to invoke.

Returns

(Function): Returns the new function.

Example

var func = _.over([Math.max, Math.min]);

func(1, 2, 3, 4);
// => [4, 1]

_.overEvery(predicates)

# Ⓢ Ⓣ Ⓝ

Creates a function that checks if all of the predicates return truthy when invoked with the arguments it receives.

Following shorthands are possible for providing predicates. Pass an Object and it will be used as an parameter for _.matches to create the predicate. Pass an Array of parameters for _.matchesProperty and the predicate will be created using them.

Since

4.0.0

Arguments

  1. predicates (Function|Function[]): The predicates to check.

Returns

(Function): Returns the new function.

Example

var func = _.overEvery([Boolean, isFinite]);

func('1');
// => true

func(null);
// => false

func(NaN);
// => false

_.overSome(predicates)

# Ⓢ Ⓣ Ⓝ

Creates a function that checks if any of the predicates return truthy when invoked with the arguments it receives.

Following shorthands are possible for providing predicates. Pass an Object and it will be used as an parameter for _.matches to create the predicate. Pass an Array of parameters for _.matchesProperty and the predicate will be created using them.

Since

4.0.0

Arguments

  1. predicates (Function|Function[]): The predicates to check.

Returns

(Function): Returns the new function.

Example

var func = _.overSome([Boolean, isFinite]);

func('1');
// => true

func(null);
// => true

func(NaN);
// => false

var matchesFunc = _.overSome([{ 'a': 1 }, { 'a': 2 }])
var matchesPropertyFunc = _.overSome([['a', 1], ['a', 2]])

_.property(path)

# Ⓢ Ⓣ Ⓝ

Creates a function that returns the value at path of a given object.

Since

2.4.0

Arguments

  1. path (Array|string): The path of the property to get.

Returns

(Function): Returns the new accessor function.

Example

var objects = [
  { 'a': { 'b': 2 } },
  { 'a': { 'b': 1 } }
];

_.map(_.property('a.b'), objects);
// => [2, 1]

_.map('a.b', _.sortBy(objects, _.property(['a', 'b'])));
// => [1, 2]

_.propertyOf(object)

# Ⓢ Ⓣ Ⓝ

The opposite of _.property; this method creates a function that returns the value at a given path of object.

Since

3.0.0

Arguments

  1. object (Object): The object to query.

Returns

(Function): Returns the new accessor function.

Example

var array = [0, 1, 2],
    object = { 'a': array, 'b': array, 'c': array };

_.map(_.propertyOf(object), ['a[2]', 'c[0]']);
// => [2, 0]

_.map(_.propertyOf(object), [['a', '2'], ['c', '0']]);
// => [2, 0]

_.range(start, end)

# Ⓢ Ⓣ Ⓝ

Creates an array of numbers (positive and/or negative) progressing from start up to, but not including, end. A step of -1 is used if a negative start is specified without an end or step. If end is not specified, it's set to start with start then set to 0.

Note: JavaScript follows the IEEE-754 standard for resolving floating-point values which can produce unexpected results.

Since

0.1.0

Arguments

  1. start (number): The start of the range.
  2. end (number): The end of the range.

Returns

(Array): Returns the range of numbers.

Example

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

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

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

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

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

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

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

_.rangeRight(start, end)

# Ⓢ Ⓣ Ⓝ

This method is like _.range except that it populates values in descending order.

Since

4.0.0

Arguments

  1. start (number): The start of the range.
  2. end (number): The end of the range.

Returns

(Array): Returns the range of numbers.

Example

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

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

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

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

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

_.rangeRight(1, [4, 0]);
// => [1, 1, 1]

_.rangeRight(0, 0);
// => []

_.runInContext(context)

# Ⓢ Ⓣ Ⓝ

Create a new pristine lodash function using the context object.

Since

1.1.0

Arguments

  1. context (Object): The context object.

Returns

(Function): Returns a new lodash function.

Example

_.mixin({ 'foo': _.constant('foo') });

var lodash = _.runInContext(root);
lodash.mixin({ 'bar': lodash.constant('bar') });

_.isFunction(_.foo);
// => true
_.isFunction(_.bar);
// => false

lodash.isFunction(lodash.foo);
// => false
lodash.isFunction(lodash.bar);
// => true

// Create a suped-up `defer` in Node.js.
var defer = _.runInContext({ 'setTimeout': setImmediate }).defer;

_.stubArray()

# Ⓢ Ⓣ Ⓝ

This method returns a new empty array.

Since

4.13.0

Returns

(Array): Returns the new empty array.

Example

var arrays = _.times(_.stubArray, 2);

// => [[], []]

// => false

_.stubFalse()

# Ⓢ Ⓣ Ⓝ

This method returns false.

Since

4.13.0

Returns

(boolean): Returns false.

Example

_.times(_.stubFalse, 2);
// => [false, false]

_.stubObject()

# Ⓢ Ⓣ Ⓝ

This method returns a new empty object.

Since

4.13.0

Returns

(Object): Returns the new empty object.

Example

var objects = _.times(_.stubObject, 2);

// => [{}, {}]

// => false

_.stubString()

# Ⓢ Ⓣ Ⓝ

This method returns an empty string.

Since

4.13.0

Returns

(string): Returns the empty string.

Example

_.times(_.stubString, 2);
// => ['', '']

_.stubTrue()

# Ⓢ Ⓣ Ⓝ

This method returns true.

Since

4.13.0

Returns

(boolean): Returns true.

Example

_.times(_.stubTrue, 2);
// => [true, true]

_.times(iteratee, n)

# Ⓢ Ⓣ Ⓝ

Invokes the iteratee n times, returning an array of the results of each invocation. The iteratee is invoked with one argument; (index).

Since

0.1.0

Arguments

  1. iteratee (Function): The function invoked per iteration.
  2. n (number): The number of times to invoke iteratee.

Returns

(Array): Returns the array of results.

Example

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

 _.times(_.constant(0), 4);
// => [0, 0, 0, 0]

_.toPath(value)

# Ⓢ Ⓣ Ⓝ

Converts value to a property path array.

Since

4.0.0

Arguments

  1. value (*): The value to convert.

Returns

(Array): Returns the new property path array.

Example

_.toPath('a.b.c');
// => ['a', 'b', 'c']

_.toPath('a[0].b.c');
// => ['a', '0', 'b', 'c']

_.uniqueId(prefix)

# Ⓢ Ⓣ Ⓝ

Generates a unique ID. If prefix is given, the ID is appended to it.

Since

0.1.0

Arguments

  1. prefix (string): The value to prefix the ID with.

Returns

(string): Returns the unique ID.

Example

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

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

Properties

_.VERSION

# Ⓢ Ⓣ

(string): The semantic version number.

_.templateSettings

# Ⓢ Ⓣ Ⓝ

(Object): By default, the template delimiters used by lodash are like those in embedded Ruby (ERB) as well as ES2015 template strings. 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.imports

# Ⓢ Ⓣ

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

_.templateSettings.interpolate

# Ⓢ Ⓣ

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

_.templateSettings.variable

# Ⓢ Ⓣ

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

Methods

_.templateSettings.imports._

# Ⓢ Ⓣ

A reference to the lodash function.

@iddan
Copy link

iddan commented Apr 19, 2017

should add fp to the title to differentiate from lodash's regular doc markdown

@youngzhao-xyz
Copy link

Excellent gist!

_.get doesn't take defaultValue. Use _.getOr instead. I think the last example in _.get won't work.

lodash/lodash#1980 (comment)

@mharyst
Copy link

mharyst commented Feb 14, 2018 •
edited
Loading

Example in _.split not correct

should be

_.split('-', 'a-b-c');
// => ['a', 'b', 'c']

@olyverDev
Copy link

_.round cannot take array with value and precision as an argument. It returns NaN, there is a mistake in docs. So _.round in lodash/fp works as Math.round now and can take only one argument (expects number).

@toniopelo
Copy link

I think there is a mistake on assign signature.

_.assign(object, sources)

object (Object): The destination object.
sources (Object|Object[]): The source objects.

When I pass an array of objects as a sources parameters, it directly assign the array as it is (it add each index of the array as a new key on the object => 0, 1, 2)

Same thing for merge

@WilliamKF
Copy link

WilliamKF commented Mar 30, 2018 •
edited
Loading

_.getOr isn't working for me either to get default value, I'm getting null value instead of default being used.

@toniopelo
Copy link

Something's wrong on pull definition.
pull doesn't accept an array of values to remove (1st argument).
pulAll does.

@vbourgeois
Copy link

vbourgeois commented Oct 17, 2018 •
edited
Loading

Be careful, for _.mapKeys's iteratee, first and only argument is the key.

BTW, thank you for the doc!

@misha-erm
Copy link

Hi, looks like _.assignIn doesn't work with multiple sources as it's described here

Created an issue for it. Thanks in advance lodash/lodash#4040

@KimTrijnh
Copy link

why do you use ' ' for the key fields of object? thanks ex:

var users = [
  { 'user': 'barney',  'active': true },
  { 'user': 'fred',    'active': false },
  { 'user': 'pebbles', 'active': false }
];

@jomaora
Copy link

jomaora commented Jul 23, 2020

@jfmengels ❤️👏

@jfmengels
Copy link
Author

Updated to 4.17.20

@vladyslav-dotsenko
Copy link

Is there any chance to add ramda-driven functions to this gist, like compose, pipe, props?
They are definitely supported by specified version of lodash/fp

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment