_

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

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

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

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

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

Members

(static) chain

Source:

• lodash.js, line 6318

Example

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

(static) countBy

Source:

• lodash.js, line 3100

Example

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

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

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

(static) defaults :function

Source:

• lodash.js, line 2057

Type:

• function

Example

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

(static) extend :function

Source:

• lodash.js, line 1928

Type:

• function

Example

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

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

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

(static) forIn :function

Source:

• lodash.js, line 2152

Type:

• function

Example

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

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

_.forIn(new Dog('Dagny'), function(value, key) {
  console.log(key);
});
// => logs 'bark' and 'name' (property order is not guaranteed across environments)

(static) forOwn :function

Source:

• lodash.js, line 2220

Type:

• function

Example

_.forOwn({ '0': 'zero', '1': 'one', 'length': 2 }, function(num, key) {
  console.log(key);
});
// => logs '0', '1', and 'length' (property order is not guaranteed across environments)

(static) groupBy

Source:

• lodash.js, line 3446

Example

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

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

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

(static) indexBy

Source:

• lodash.js, line 3489

Example

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

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

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

_.indexBy(stooges, function(key) { this.fromCharCode(key.code); }, String);
// => { 'a': { 'dir': 'left', 'code': 97 }, 'd': { 'dir': 'right', 'code': 100 } }

(static) isArray :function

Source:

• lodash.js, line 1783

Type:

• function

Example

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

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

(static) isPlainObject

Source:

• lodash.js, line 2634

Example

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

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

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

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

(static) keys

Source:

• lodash.js, line 1816

Example

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

(static) parseInt

Source:

• lodash.js, line 5925

Example

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

(static) pluck :function

Source:

• lodash.js, line 3743

Type:

• function

Example

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

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

(static) support :Object

Source:

• lodash.js, line 660

Type:

• Object

(static) toString

Source:

• lodash.js, line 6338

Example

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

(static) valueOf

Source:

• lodash.js, line 6354

Example

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

(static) where :function

Source:

• lodash.js, line 4128

Type:

• function

Example

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

_.where(stooges, { 'age': 40 });
// => [{ 'name': 'moe', 'age': '40', 'quotes': ['Spread out!', 'You knucklehead!'] }]

_.where(stooges, { 'quotes': ['Poifect!'] });
// => [{ 'name': 'curly', 'age': 30, 'quotes': ['Oh, a wise guy, eh?', 'Poifect!'] }]

Methods

(static) after(n, func) → {function}

Source:

• lodash.js, line 5128

Example

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

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

_.forEach(saves, function(type) {
  asyncSave({ 'type': type, 'complete': done });
});
// => logs 'Done saving!', after all saves have completed

Parameters:

Returns:

Type

function

(static) all(collection, callbackopt, thisArgopt) → {boolean}

Source:

• lodash.js, line 3145

Example

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

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

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

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

Parameters:

Returns:

Type

boolean

(static) any(collection, callbackopt, thisArgopt) → {boolean}

Source:

• lodash.js, line 4002

Example

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

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

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

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

Parameters:

Returns:

Type

boolean

(static) at(collection, …indexopt) → {Array}

Source:

• lodash.js, line 3002

Example

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

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

Parameters:

Returns:

Type

Array

(static) bind(func, thisArgopt, …argopt) → {function}

Source:

• lodash.js, line 5161

Example

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

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

Parameters:

Returns:

Type

function

(static) bindAll(object, …methodNameopt) → {Object}

Source:

• lodash.js, line 5191

Example

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

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

Parameters:

Returns:

Type

Object

(static) bindKey(object, key, …argopt) → {function}

Source:

• lodash.js, line 5237

Example

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

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

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

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

Parameters:

Returns:

Type

function

(static) chain(value) → {Object}

Source:

• lodash.js, line 6285

Example

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

var youngest = _.chain(stooges)
    .sortBy(function(stooge) { return stooge.age; })
    .map(function(stooge) { return stooge.name + ' is ' + stooge.age; })
    .first();
// => 'moe is 40'

Parameters:

Returns:

Type

Object

(static) clone(value, deepopt, callbackopt, thisArgopt) → {*}

Source:

• lodash.js, line 1981

Example

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

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

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

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

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

Parameters:

Returns:

Type

*

(static) cloneDeep(value, callbackopt, thisArgopt) → {*}

Source:

• lodash.js, line 2033

Example

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

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

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

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

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

Parameters:

Returns:

Type

*

(static) collect(collection, callbackopt, thisArgopt) → {Array}

Source:

• lodash.js, line 3567

Example

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

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

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

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

Parameters:

Returns:

Type

Array

(static) compact(array) → {Array}

Source:

• lodash.js, line 4146

Example

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

Parameters:

Returns:

Type

Array

(static) compose(…funcopt) → {function}

Source:

• lodash.js, line 5273

Example

var realNameMap = {
  'curly': 'jerome'
};

var format = function(name) {
  name = realNameMap[name.toLowerCase()] || name;
  return name.charAt(0).toUpperCase() + name.slice(1).toLowerCase();
};

var greet = function(formatted) {
  return 'Hiya ' + formatted + '!';
};

var welcome = _.compose(greet, format);
welcome('curly');
// => 'Hiya Jerome!'

Parameters:

Returns:

Type

function

(static) createCallback(funcopt, thisArgopt, argCountopt) → {function}

Source:

• lodash.js, line 5324

Example

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

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

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

Parameters:

Returns:

Type

function

(static) curry(func, arityopt) → {function}

Source:

• lodash.js, line 5389

Example

var curried = _.curry(function(a, b, c) {
  console.log(a + b + c);
});

curried(1)(2)(3);
// => 6

curried(1, 2)(3);
// => 6

curried(1, 2, 3);
// => 6

Parameters:

Returns:

Type

function

(static) debounce(func, wait, optionsopt) → {function}

Source:

• lodash.js, line 5433

Example

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

// execute `sendMail` when the click event is fired, debouncing subsequent calls
jQuery('#postbox').on('click', _.debounce(sendMail, 300, {
  'leading': true,
  'trailing': false
});

// ensure `batchLog` is executed once after 1 second of debounced calls
var source = new EventSource('/stream');
source.addEventListener('message', _.debounce(batchLog, 250, {
  'maxWait': 1000
}, false);

Parameters:

Returns:

Type

function

(static) defer(func, …argopt) → {number}

Source:

• lodash.js, line 5534

Example

_.defer(function() { console.log('deferred'); });
// returns from the function before 'deferred' is logged

Parameters:

Returns:

Type

number

(static) delay(func, wait, …argopt) → {number}

Source:

• lodash.js, line 5568

Example

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

Parameters:

Returns:

Type

number

(static) difference(array, …arrayopt) → {Array}

Source:

• lodash.js, line 4175

Example

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

Parameters:

Returns:

Type

Array

(static) each(collection, callbackopt, thisArgopt) → {Array|Object|string}

Source:

• lodash.js, line 3352

Example

_([1, 2, 3]).forEach(function(num) { console.log(num); }).join(',');
// => logs each number and returns '1,2,3'

_.forEach({ 'one': 1, 'two': 2, 'three': 3 }, function(num) { console.log(num); });
// => logs each number and returns the object (property order is not guaranteed across environments)

Parameters:

Returns:

Type

Array | Object | string

(static) eachRight(collection, callbackopt, thisArgopt) → {Array|Object|string}

Source:

• lodash.js, line 3385

Example

_([1, 2, 3]).forEachRight(function(num) { console.log(num); }).join(',');
// => logs each number from right to left and returns '3,2,1'

Parameters:

Returns:

Type

Array | Object | string

(static) escape(string) → {string}

Source:

• lodash.js, line 5818

Example

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

Parameters:

Returns:

Type

string

(static) findIndex(array, callbackopt, thisArgopt) → {number}

Source:

• lodash.js, line 4225

Example

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

Parameters:

Returns:

Type

number

(static) findKey(object, callbackopt, thisArgopt) → {string|undefined}

Source:

• lodash.js, line 2079

Example

_.findKey({ 'a': 1, 'b': 2, 'c': 3, 'd': 4 }, function(num) {
  return num % 2 == 0;
});
// => 'b' (property order is not guaranteed across environments)

Parameters:

Returns:

Type

string | undefined

(static) findLast(collection, callbackopt, thisArgopt) → {*}

Source:

• lodash.js, line 3318

Example

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

Parameters:

Returns:

Type

*

(static) findLastIndex(array, callbackopt, thisArgopt) → {number}

Source:

• lodash.js, line 4258

Example

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

Parameters:

Returns:

Type

number

(static) findLastKey(object, callbackopt, thisArgopt) → {string|undefined}

Source:

• lodash.js, line 2111

Example

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

Parameters:

Returns:

Type

string | undefined

(static) flatten(array, isShallowopt, callbackopt, thisArgopt) → {Array}

Source:

• lodash.js, line 4385

Example

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

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

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

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

Parameters:

Returns:

Type

Array

(static) foldr(collection, callbackopt, accumulatoropt, thisArgopt) → {*}

Source:

• lodash.js, line 3818

Example

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

Parameters:

Returns:

Type

*

(static) forInRight(object, callbackopt, thisArgopt) → {Object}

Source:

• lodash.js, line 2182

Example

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

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

_.forInRight(new Dog('Dagny'), function(value, key) {
  console.log(key);
});
// => logs 'name' and 'bark' assuming `_.forIn ` logs 'bark' and 'name'

Parameters:

Returns:

Type

Object

(static) forOwnRight(object, callbackopt, thisArgopt) → {Object}

Source:

• lodash.js, line 2240

Example

_.forOwnRight({ '0': 'zero', '1': 'one', 'length': 2 }, function(num, key) {
  console.log(key);
});
// => logs 'length', '1', and '0' assuming `_.forOwn` logs '0', '1', and 'length'

Parameters:

Returns:

Type

Object

(static) has(object, property) → {boolean}

Source:

• lodash.js, line 2294

Example

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

Parameters:

Returns:

Type

boolean

(static) identity(value) → {*}

Source:

• lodash.js, line 5836

Example

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

Parameters:

Returns:

Type

*

(static) include(collection, target, fromIndexopt) → {boolean}

Source:

• lodash.js, line 3045

Example

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

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

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

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

Parameters:

Returns:

Type

boolean

(static) indexOf(array, value, fromIndexopt) → {number}

Source:

• lodash.js, line 4422

Example

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

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

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

Parameters:

Returns:

Type

number

(static) initial(array, callbackopt, thisArgopt) → {Array}

Source:

• lodash.js, line 4488

Example

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

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

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

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

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

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

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

Parameters:

Returns:

Type

Array

(static) intersection(…arrayopt) → {Array}

Source:

• lodash.js, line 4518

Example

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

Parameters:

Returns:

Type

Array

(static) invert(object) → {Object}

Source:

• lodash.js, line 2311

Example

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

Parameters:

Returns:

Type

Object

(static) invoke(collection, methodName, …argopt) → {Array}

Source:

• lodash.js, line 3515

Example

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

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

Parameters:

Returns:

Type

Array

(static) isArguments(value) → {boolean}

Source:

• lodash.js, line 1756

Example

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

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

Parameters:

Returns:

Type

boolean

(static) isBoolean(value) → {boolean}

Source:

• lodash.js, line 2337

Example

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

Parameters:

Returns:

Type

boolean

(static) isDate(value) → {boolean}

Source:

• lodash.js, line 2354

Example

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

Parameters:

Returns:

Type

boolean

(static) isElement(value) → {boolean}

Source:

• lodash.js, line 2371

Example

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

Parameters:

Returns:

Type

boolean

(static) isEmpty(value) → {boolean}

Source:

• lodash.js, line 2396

Example

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

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

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

Parameters:

Returns:

Type

boolean

(static) isEqual(a, b, callbackopt, thisArgopt) → {boolean}

Source:

• lodash.js, line 2453

Example

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

moe == copy;
// => false

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

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

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

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

Parameters:

Returns:

Type

boolean

(static) isFinite(value) → {boolean}

Source:

• lodash.js, line 2485

Example

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

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

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

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

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

Parameters:

Returns:

Type

boolean

(static) isFunction(value) → {boolean}

Source:

• lodash.js, line 2502

Example

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

Parameters:

Returns:

Type

boolean

(static) isNaN(value) → {boolean}

Source:

• lodash.js, line 2565

Example

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

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

isNaN(undefined);
// => true

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

Parameters:

Returns:

Type

boolean

(static) isNull(value) → {boolean}

Source:

• lodash.js, line 2587

Example

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

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

Parameters:

Returns:

Type

boolean

(static) isNumber(value) → {boolean}

Source:

• lodash.js, line 2606

Example

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

Parameters:

Returns:

Type

boolean

(static) isObject(value) → {boolean}

Source:

• lodash.js, line 2532

Example

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

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

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

Parameters:

Returns:

Type

boolean

(static) isRegExp(value) → {boolean}

Source:

• lodash.js, line 2659

Example

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

Parameters:

Returns:

Type

boolean

(static) isString(value) → {boolean}

Source:

• lodash.js, line 2676

Example

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

Parameters:

Returns:

Type

boolean

(static) isUndefined(value) → {boolean}

Source:

• lodash.js, line 2693

Example

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

Parameters:

Returns:

Type

boolean

(static) last(array, callbackopt, thisArgopt) → {*}

Source:

• lodash.js, line 4618

Example

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

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

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

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

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

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

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

Parameters:

Returns:

Type

*

(static) lastIndexOf(array, value, fromIndexopt) → {number}

Source:

• lodash.js, line 4657

Example

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

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

Parameters:

Returns:

Type

number

(static) max(collection, callbackopt, thisArgopt) → {*}

Source:

• lodash.js, line 3624

Example

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

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

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

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

Parameters:

Returns:

Type

*

(static) memoize(func, resolveropt) → {function}

Source:

• lodash.js, line 5610

Example

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

var data = {
  'moe': { 'name': 'moe', 'age': 40 },
  'curly': { 'name': 'curly', 'age': 60 }
};

// modifying the result cache
var stooge = _.memoize(function(name) { return data[name]; }, _.identity);
stooge('curly');
// => { 'name': 'curly', 'age': 60 }

stooge.cache.curly.name = 'jerome';
stooge('curly');
// => { 'name': 'jerome', 'age': 60 }

Parameters:

Returns:

Type

function

(static) merge(object, …sourceopt, callbackopt, thisArgopt) → {Object}

Source:

• lodash.js, line 2748

Example

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

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

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

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

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

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

Parameters:

Returns:

Type

Object

(static) methods(object) → {Array}

Source:

• lodash.js, line 2269

Example

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

Parameters:

Returns:

Type

Array

(static) min(collection, callbackopt, thisArgopt) → {*}

Source:

• lodash.js, line 3693

Example

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

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

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

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

Parameters:

Returns:

Type

*

(static) mixin(object, object)

Source:

• lodash.js, line 5863

Example

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

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

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

Parameters:

(static) noConflict() → {function}

Source:

• lodash.js, line 5901

Example

var lodash = _.noConflict();

Returns:

Type

function

(static) object(keys, valuesopt) → {Object}

Source:

• lodash.js, line 5086

Example

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

Parameters:

Returns:

Type

Object

(static) omit(object, callbackopt, thisArgopt) → {Object}

Source:

• lodash.js, line 2804

Example

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

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

Parameters:

Returns:

Type

Object

(static) once(func) → {function}

Source:

• lodash.js, line 5643

Example

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

Parameters:

Returns:

Type

function

(static) pairs(object) → {Array}

Source:

• lodash.js, line 2839

Example

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

Parameters:

Returns:

Type

Array

(static) partial(func, …argopt) → {function}

Source:

• lodash.js, line 5681

Example

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

Parameters:

Returns:

Type

function

(static) partialRight(func, …argopt) → {function}

Source:

• lodash.js, line 5712

Example

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

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

defaultsDeep(options, _.templateSettings);

options.variable
// => 'data'

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

Parameters:

Returns:

Type

function

(static) pick(object, callbackopt, thisArgopt) → {Object}

Source:

• lodash.js, line 2879

Example

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

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

Parameters:

Returns:

Type

Object

(static) pull(array, …valueopt) → {Array}

Source:

• lodash.js, line 4687

Example

var array = [1, 2, 3, 1, 2, 3];
_.pull(array, 2, 3);
console.log(array);
// => [1, 1]

Parameters:

Returns:

Type

Array

(static) random(minopt, maxopt) → {number}

Source:

• lodash.js, line 5949

Example

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

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

Parameters:

Returns:

Type

number

(static) range(startopt, end, stepopt) → {Array}

Source:

• lodash.js, line 4738

Example

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

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

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

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

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

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

Parameters:

Returns:

Type

Array

(static) reject(collection, callbackopt, thisArgopt) → {Array}

Source:

• lodash.js, line 3867

Example

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

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

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

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

Parameters:

Returns:

Type

Array

(static) remove(array, callbackopt, thisArgopt) → {Array}

Source:

• lodash.js, line 4791

Example

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

console.log(array);
// => [1, 3, 5]

console.log(evens);
// => [2, 4, 6]

Parameters:

Returns:

Type

Array

(static) result(object, property) → {*}

Source:

• lodash.js, line 5993

Example

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

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

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

Parameters:

Returns:

Type

*

(static) runInContext(contextopt) → {function}

Source:

• lodash.js, line 452

Parameters:

Returns:

Type

function

(static) sample(collection, nopt) → {Array}

Source:

• lodash.js, line 3893

Example

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

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

Parameters:

Returns:

Type

Array

(static) select(collection, callbackopt, thisArgopt) → {Array}

Source:

• lodash.js, line 3206

Example

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

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

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

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

Parameters:

Returns:

Type

Array

(static) shuffle(collection) → {Array}

Source:

• lodash.js, line 3922

Example

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

Parameters:

Returns:

Type

Array

(static) size(collection) → {number}

Source:

• lodash.js, line 3955

Example

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

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

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

Parameters:

Returns:

Type

number

(static) sortBy(collection, callbackopt, thisArgopt) → {Array}

Source:

• lodash.js, line 4058

Example

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

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

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

Parameters:

Returns:

Type

Array

(static) sortedIndex(array, value, callbackopt, thisArgopt) → {number}

Source:

• lodash.js, line 4929

Example

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

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

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

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

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

Parameters:

Returns:

Type

number

(static) tap(value, interceptor) → {*}

Source:

• lodash.js, line 6313

Example

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

Parameters:

Returns:

Type

*

(static) template(text, data, optionsopt, sourceURLopt, variableopt) → {function|string}

Source:

• lodash.js, line 6086

Example

// using the "interpolate" delimiter to create a compiled template
var compiled = _.template('hello <%= name %>');
compiled({ 'name': 'moe' });
// => 'hello moe'

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

// using the "evaluate" delimiter to generate HTML
var list = '<% _.forEach(people, function(name) { %><li><%- name %></li><% }); %>';
_.template(list, { 'people': ['moe', 'larry'] });
// => '<li>moe</li><li>larry</li>'

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

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

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

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

// using the `imports` option to import jQuery
var list = '<% $.each(people, function(name) { %><li><%= name %></li><% }); %>';
_.template(list, { 'people': ['moe', 'larry'] }, { 'imports': { '$': jQuery });
// => '<li>moe</li><li>larry</li>'

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

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

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

Parameters:

Returns:

Type

function | string

(static) throttle(func, wait, optionsopt) → {function}

Source:

• lodash.js, line 5747

Example

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

// execute `renewToken` when the click event is fired, but not more than once every 5 minutes
jQuery('.interactive').on('click', _.throttle(renewToken, 300000, {
  'trailing': false
}));

Parameters:

Returns:

Type

function

(static) times(n, callback, thisArgopt) → {Array}

Source:

• lodash.js, line 6209

Example

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

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

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

Parameters:

Returns:

Type

Array

(static) toArray(collection) → {Array}

Source:

• lodash.js, line 4094

Example

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

Parameters:

Returns:

Type

Array

(static) transform(collection, callbackopt, accumulatoropt, thisArgopt) → {*}

Source:

• lodash.js, line 2934

Example

var squares = _.transform([1, 2, 3, 4, 5, 6, 7, 8, 9, 10], function(result, num) {
  num *= num;
  if (num % 2) {
    return result.push(num) < 3;
  }
});
// => [1, 9, 25]

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

Parameters:

Returns:

Type

*

(static) unescape(string) → {string}

Source:

• lodash.js, line 6236

Example

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

Parameters:

Returns:

Type

string

(static) union(…arrayopt) → {Array}

Source:

• lodash.js, line 4960

Example

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

Parameters:

Returns:

Type

Array

(static) unique(array, isSortedopt, callbackopt, thisArgopt) → {Array}

Source:

• lodash.js, line 5008

Example

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

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

_.uniq(['A', 'b', 'C', 'a', 'B', 'c'], function(letter) { return letter.toLowerCase(); });
// => ['A', 'b', 'C']

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

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

Parameters:

Returns:

Type

Array

(static) uniqueId(prefixopt) → {string}

Source:

• lodash.js, line 6256

Example

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

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

Parameters:

Returns:

Type

string

(static) unzip(…arrayopt) → {Array}

Source:

• lodash.js, line 5056

Example

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

Parameters:

Returns:

Type

Array

(static) values(object) → {Array}

Source:

• lodash.js, line 2967

Example

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

Parameters:

Returns:

Type

Array

(static) without(array, …valueopt) → {Array}

Source:

• lodash.js, line 5036

Example

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

Parameters:

Returns:

Type

Array

(static) wrap(value, wrapper) → {function}

Source:

• lodash.js, line 5791

Example

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

Parameters:

Returns:

Type

function