lodash: Add first pass at compiling iterators. [jddalton]

This commit is contained in:
John-David Dalton
2012-04-18 14:44:23 -04:00
parent 37cdb762f9
commit 9fc5044cf9
2 changed files with 409 additions and 381 deletions

View File

@@ -121,34 +121,29 @@
<!-- div --> <!-- div -->
### <a id="_" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L81" title="View in source">`_(value)`</a> ### <a id="_" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L80" title="View in source">`_(value)`</a>
The Lodash function. The Lodash function.
[&#9650;][1] [&#9650;][1]
#### Arguments #### Arguments
1. `value` *(Mixed)*: The value to wrap in a chainable `lowdash` object. 1. `value` *(Mixed)*: The value to wrap in a chainable `lodash` object.
#### Returns #### Returns
*(Object)*: Returns a `lodash` instance. *(Object)*: Returns a `lodash` instance.
#### Example
~~~ js
~~~
<!-- /div --> <!-- /div -->
<!-- div --> <!-- div -->
## `_` ## `_`
### <a id="_" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L81" title="View in source">`_(value)`</a> ### <a id="_" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L80" title="View in source">`_(value)`</a>
The Lodash function. The Lodash function.
[&#9650;][1] [&#9650;][1]
<!-- div --> <!-- div -->
### <a id="_.VERSION" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L2418" title="View in source">`_.VERSION`</a> ### <a id="_.VERSION" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L2513" title="View in source">`_.VERSION`</a>
*(String)*: The semantic version number. *(String)*: The semantic version number.
[&#9650;][1] [&#9650;][1]
@@ -157,7 +152,7 @@ The Lodash function.
<!-- div --> <!-- div -->
### <a id="_.after" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1257" title="View in source">`_.after(times, func)`</a> ### <a id="_.after" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1186" title="View in source">`_.after(times, func)`</a>
Creates a new function that is restricted to executing only after it is called a given number of `times`. Creates a new function that is restricted to executing only after it is called a given number of `times`.
[&#9650;][1] [&#9650;][1]
@@ -182,7 +177,7 @@ _.forEach(notes, function(note) {
<!-- div --> <!-- div -->
### <a id="_.bind" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1287" title="View in source">`_.bind(func [, arg1, arg2, ...])`</a> ### <a id="_.bind" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1216" title="View in source">`_.bind(func [, arg1, arg2, ...])`</a>
Creates a new function that, when called, invokes `func` with the `this` binding of `thisArg` and prepends additional arguments to those passed to the bound function. Creates a new function that, when called, invokes `func` with the `this` binding of `thisArg` and prepends additional arguments to those passed to the bound function.
[&#9650;][1] [&#9650;][1]
@@ -195,7 +190,7 @@ Creates a new function that, when called, invokes `func` with the `this` binding
#### Example #### Example
~~~ js ~~~ js
var func = function(greeting){ return greeting + ': ' + this.name; }; var func = function(greeting) { return greeting + ': ' + this.name; };
func = _.bind(func, { 'name': 'moe' }, 'hi'); func = _.bind(func, { 'name': 'moe' }, 'hi');
func(); func();
// => 'hi: moe' // => 'hi: moe'
@@ -206,7 +201,7 @@ func();
<!-- div --> <!-- div -->
### <a id="_.bindAll" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1321" title="View in source">`_.bindAll(object [, methodName1, methodName2, ...])`</a> ### <a id="_.bindAll" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1250" title="View in source">`_.bindAll(object [, methodName1, methodName2, ...])`</a>
Binds methods on the `object` to the object, overwriting the non-bound method. If no method names are provided, all the function properties of the `object` will be bound. Binds methods on the `object` to the object, overwriting the non-bound method. If no method names are provided, all the function properties of the `object` will be bound.
[&#9650;][1] [&#9650;][1]
@@ -235,7 +230,7 @@ jQuery('#lodash_button').on('click', buttonView.onClick);
<!-- div --> <!-- div -->
### <a id="_.chain" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L2360" title="View in source">`_.chain(value)`</a> ### <a id="_.chain" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L2455" title="View in source">`_.chain(value)`</a>
Wraps the value in a `lodash` chainable object. Wraps the value in a `lodash` chainable object.
[&#9650;][1] [&#9650;][1]
@@ -248,14 +243,14 @@ Wraps the value in a `lodash` chainable object.
#### Example #### Example
~~~ js ~~~ js
var stooges = [ var stooges = [
{ 'name' : 'moe', 'age' : 40}, { 'name': 'moe', 'age': 40 },
{ 'name' : 'larry', 'age' : 50}, { 'name': 'larry', 'age': 50 },
{ 'name' : 'curly', 'age' : 60} { 'name': 'curly', 'age': 60 }
]; ];
var youngest = _.chain(stooges) var youngest = _.chain(stooges)
.sortBy(function(stooge){ return stooge.age; }) .sortBy(function(stooge) { return stooge.age; })
.map(function(stooge){ return stooge.name + ' is ' + stooge.age; }) .map(function(stooge) { return stooge.name + ' is ' + stooge.age; })
.first() .first()
.value(); .value();
// => 'moe is 40' // => 'moe is 40'
@@ -266,7 +261,7 @@ var youngest = _.chain(stooges)
<!-- div --> <!-- div -->
### <a id="_.clone" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1571" title="View in source">`_.clone(value)`</a> ### <a id="_.clone" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1521" title="View in source">`_.clone(value)`</a>
Create a shallow clone of the `value`. Any nested objects or arrays will be assigned by reference and not cloned. Create a shallow clone of the `value`. Any nested objects or arrays will be assigned by reference and not cloned.
[&#9650;][1] [&#9650;][1]
@@ -287,7 +282,7 @@ _.clone({ 'name': 'moe' });
<!-- div --> <!-- div -->
### <a id="_.compact" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L859" title="View in source">`_.compact(array)`</a> ### <a id="_.compact" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L783" title="View in source">`_.compact(array)`</a>
Produces a new array with all falsey values of `array` removed. The values `false`, `null`, `0`, `""`, `undefined` and `NaN` are all falsey. Produces a new array with all falsey values of `array` removed. The values `false`, `null`, `0`, `""`, `undefined` and `NaN` are all falsey.
[&#9650;][1] [&#9650;][1]
@@ -308,7 +303,7 @@ _.compact([0, 1, false, 2, '', 3]);
<!-- div --> <!-- div -->
### <a id="_.compose" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1346" title="View in source">`_.compose([func1, func2, ...])`</a> ### <a id="_.compose" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1282" title="View in source">`_.compose([func1, func2, ...])`</a>
Creates a new function that is the composition of the passed functions, where each function consumes the return value of the function that follows. In math terms, composing thefunctions `f()`, `g()`, and `h()` produces `f(g(h()))`. Creates a new function that is the composition of the passed functions, where each function consumes the return value of the function that follows. In math terms, composing thefunctions `f()`, `g()`, and `h()` produces `f(g(h()))`.
[&#9650;][1] [&#9650;][1]
@@ -332,7 +327,7 @@ welcome('moe');
<!-- div --> <!-- div -->
### <a id="_.contains" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L263" title="View in source">`_.contains(collection, target)`</a> ### <a id="_.contains" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L204" title="View in source">`_.contains(collection, target)`</a>
Checks if a given `target` value is present in a `collection` using strict equality for comparisons, i.e. `===`. Checks if a given `target` value is present in a `collection` using strict equality for comparisons, i.e. `===`.
[&#9650;][1] [&#9650;][1]
@@ -354,7 +349,7 @@ _.contains([1, 2, 3], 3);
<!-- div --> <!-- div -->
### <a id="_.debounce" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1376" title="View in source">`_.debounce(func, wait, immediate)`</a> ### <a id="_.debounce" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1312" title="View in source">`_.debounce(func, wait, immediate)`</a>
Creates a new function that will postpone its execution until after `wait` milliseconds have elapsed since the last time it was invoked. Pass `true` for `immediate` to cause debounce to invoke the function on the leading, intead of the trailing, edge of the wait timeout. Creates a new function that will postpone its execution until after `wait` milliseconds have elapsed since the last time it was invoked. Pass `true` for `immediate` to cause debounce to invoke the function on the leading, intead of the trailing, edge of the wait timeout.
[&#9650;][1] [&#9650;][1]
@@ -377,7 +372,7 @@ jQuery(window).on('resize', lazyLayout);
<!-- div --> <!-- div -->
### <a id="_.defaults" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1595" title="View in source">`_.defaults(object [, defaults1, defaults2, ..])`</a> ### <a id="_.defaults" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1545" title="View in source">`_.defaults(object [, defaults1, defaults2, ..])`</a>
Assigns missing properties in `object` with default values from the defaults objects. As soon as a property is set, additional defaults of the same property will be ignored. Assigns missing properties in `object` with default values from the defaults objects. As soon as a property is set, additional defaults of the same property will be ignored.
[&#9650;][1] [&#9650;][1]
@@ -400,7 +395,7 @@ _.defaults(iceCream, { 'flavor': 'vanilla', 'sprinkles': 'lots' });
<!-- div --> <!-- div -->
### <a id="_.defer" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1427" title="View in source">`_.defer(func [, arg1, arg2, ...])`</a> ### <a id="_.defer" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1368" title="View in source">`_.defer(func [, arg1, arg2, ...])`</a>
Defers invoking the `func` function until the current call stack has cleared. Additional arguments are passed to `func` when it is invoked. Defers invoking the `func` function until the current call stack has cleared. Additional arguments are passed to `func` when it is invoked.
[&#9650;][1] [&#9650;][1]
@@ -413,7 +408,7 @@ Defers invoking the `func` function until the current call stack has cleared. Ad
#### Example #### Example
~~~ js ~~~ js
_.defer(function(){ alert('deferred'); }); _.defer(function() { alert('deferred'); });
// Returns from the function before the alert runs. // Returns from the function before the alert runs.
~~~ ~~~
@@ -422,7 +417,7 @@ _.defer(function(){ alert('deferred'); });
<!-- div --> <!-- div -->
### <a id="_.delay" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1407" title="View in source">`_.delay(func, wait [, arg1, arg2, ...])`</a> ### <a id="_.delay" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1348" title="View in source">`_.delay(func, wait [, arg1, arg2, ...])`</a>
Invokes the `func` function after `wait` milliseconds. Additional arguments are passed `func` when it is invoked. Invokes the `func` function after `wait` milliseconds. Additional arguments are passed `func` when it is invoked.
[&#9650;][1] [&#9650;][1]
@@ -446,7 +441,7 @@ _.delay(log, 1000, 'logged later');
<!-- div --> <!-- div -->
### <a id="_.difference" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L879" title="View in source">`_.difference(array [, array1, array2, ...])`</a> ### <a id="_.difference" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L803" title="View in source">`_.difference(array [, array1, array2, ...])`</a>
Produces a new array of `array` values not present in the other arrays using strict equality for comparisons, i.e. `===`. Produces a new array of `array` values not present in the other arrays using strict equality for comparisons, i.e. `===`.
[&#9650;][1] [&#9650;][1]
@@ -468,7 +463,7 @@ _.difference([1, 2, 3, 4, 5], [5, 2, 10]);
<!-- div --> <!-- div -->
### <a id="_.escape" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L2100" title="View in source">`_.escape(string)`</a> ### <a id="_.escape" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L2177" title="View in source">`_.escape(string)`</a>
Escapes a string for insertion into HTML, replacing `&`, `<`, `>`, `"`, `'`, and `/` characters. Escapes a string for insertion into HTML, replacing `&`, `<`, `>`, `"`, `'`, and `/` characters.
[&#9650;][1] [&#9650;][1]
@@ -489,7 +484,7 @@ _.escape('Curly, Larry & Moe');
<!-- div --> <!-- div -->
### <a id="_.every" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L287" title="View in source">`_.every(collection, callback [, thisArg])`</a> ### <a id="_.every" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L229" title="View in source">`_.every(collection, callback [, thisArg])`</a>
Checks if the `callback` returns truthy for **all** values of a `collection`. The `callback` is invoked with `3` arguments; for arrays they are *(value, index, array)* and for objects they are *(value, key, object)*. Checks if the `callback` returns truthy for **all** values of a `collection`. The `callback` is invoked with `3` arguments; for arrays they are *(value, index, array)* and for objects they are *(value, key, object)*.
[&#9650;][1] [&#9650;][1]
@@ -512,7 +507,7 @@ _.every([true, 1, null, 'yes'], Boolean);
<!-- div --> <!-- div -->
### <a id="_.extend" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1619" title="View in source">`_.extend(destination [, source1, source2, ..])`</a> ### <a id="_.extend" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1569" title="View in source">`_.extend(destination [, source1, source2, ..])`</a>
Copies enumerable properties from the source objects to the `destination` object. Subsequent sources will overwrite propery assignments of previous sources. Copies enumerable properties from the source objects to the `destination` object. Subsequent sources will overwrite propery assignments of previous sources.
[&#9650;][1] [&#9650;][1]
@@ -534,7 +529,7 @@ _.extend({ 'name': 'moe' }, { 'age': 40 });
<!-- div --> <!-- div -->
### <a id="_.filter" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L315" title="View in source">`_.filter(collection, callback [, thisArg])`</a> ### <a id="_.filter" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L255" title="View in source">`_.filter(collection, callback [, thisArg])`</a>
Examines each value in a `collection`, returning an array of all values the `callback` returns truthy for. The `callback` is invoked with `3` arguments; for arrays they are *(value, index, array)* and for objects they are *(value, key, object)*. Examines each value in a `collection`, returning an array of all values the `callback` returns truthy for. The `callback` is invoked with `3` arguments; for arrays they are *(value, index, array)* and for objects they are *(value, key, object)*.
[&#9650;][1] [&#9650;][1]
@@ -557,7 +552,7 @@ var evens = _.filter([1, 2, 3, 4, 5, 6], function(num) { return num % 2 == 0; })
<!-- div --> <!-- div -->
### <a id="_.find" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L344" title="View in source">`_.find(collection, callback [, thisArg])`</a> ### <a id="_.find" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L280" title="View in source">`_.find(collection, callback [, thisArg])`</a>
Examines each value in a `collection`, returning the first one the `callback` returns truthy for. The function returns as soon as it finds an acceptable value, and does not iterate over the entire `collection`. The `callback` is invoked with `3` arguments; for arrays they are *(value, index, array)* and for objects they are *(value, key, object)*. Examines each value in a `collection`, returning the first one the `callback` returns truthy for. The function returns as soon as it finds an acceptable value, and does not iterate over the entire `collection`. The `callback` is invoked with `3` arguments; for arrays they are *(value, index, array)* and for objects they are *(value, key, object)*.
[&#9650;][1] [&#9650;][1]
@@ -580,17 +575,17 @@ var even = _.find([1, 2, 3, 4, 5, 6], function(num) { return num % 2 == 0; });
<!-- div --> <!-- div -->
### <a id="_.first" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L903" title="View in source">`_.first(array [, n, guard])`</a> ### <a id="_.first" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L827" title="View in source">`_.first(array [, n, guard])`</a>
Gets the first value of the `array`. Pass `n` to return the first `n` values of the `array`. Gets the first value of the `array`. Pass `n` to return the first `n` values of the `array`.
[&#9650;][1] [&#9650;][1]
#### Arguments #### Arguments
1. `array` *(Array)*: The array to query. 1. `array` *(Array)*: The array to query.
2. `[n]` *(Number)*: The number of elements to return. 2. `[n]` *(Number)*: The number of elements to return.
3. `[guard]` *(Object)*: Used to allow the function to work with other iteration methods like `_.map` without using their callback `index` argument for `n`. 3. `[guard]` *(Object)*: Allows this method to work with others like `_.map` without using their callback `index` argument for `n`.
#### Returns #### Returns
*(Mixed)*: Returns the first value or an array of the first `n` values of the `array`. *(Mixed)*: Returns the first value or an array of the first `n` values of the `array`.
#### Example #### Example
~~~ js ~~~ js
@@ -603,7 +598,7 @@ _.first([5, 4, 3, 2, 1]);
<!-- div --> <!-- div -->
### <a id="_.flatten" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L925" title="View in source">`_.flatten(array, shallow)`</a> ### <a id="_.flatten" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L849" title="View in source">`_.flatten(array, shallow)`</a>
Flattens a nested array *(the nesting can be to any depth)*. If `shallow` is truthy, `array` will only be flattened a single level. Flattens a nested array *(the nesting can be to any depth)*. If `shallow` is truthy, `array` will only be flattened a single level.
[&#9650;][1] [&#9650;][1]
@@ -628,7 +623,7 @@ _.flatten([1, [2], [3, [[4]]]], true);
<!-- div --> <!-- div -->
### <a id="_.forEach" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L377" title="View in source">`_.forEach(collection, callback [, thisArg])`</a> ### <a id="_.forEach" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L307" title="View in source">`_.forEach(collection, callback [, thisArg])`</a>
Iterates over a `collection`, executing the `callback` for each value in the `collection`. The `callback` is bound to the `thisArg` value, if one is passed. The `callback` is invoked with `3` arguments; for arrays they are *(value, index, array)* and for objects they are *(value, key, object)*. Iterates over a `collection`, executing the `callback` for each value in the `collection`. The `callback` is bound to the `thisArg` value, if one is passed. The `callback` is invoked with `3` arguments; for arrays they are *(value, index, array)* and for objects they are *(value, key, object)*.
[&#9650;][1] [&#9650;][1]
@@ -642,10 +637,10 @@ Iterates over a `collection`, executing the `callback` for each value in the `co
#### Example #### Example
~~~ js ~~~ js
_.forforEach([1, 2, 3], function(num) { alert(num); }); _.forEach([1, 2, 3], function(num) { alert(num); });
// => alerts each number in turn... // => alerts each number in turn...
_.forforEach({ 'one' : 1, 'two' : 2, 'three' : 3}, function(num) { alert(num); }); _.forEach({ 'one': 1, 'two': 2, 'three': 3}, function(num) { alert(num); });
// => alerts each number in turn... // => alerts each number in turn...
~~~ ~~~
@@ -654,7 +649,7 @@ _.forforEach({ 'one' : 1, 'two' : 2, 'three' : 3}, function(num) { alert(num); }
<!-- div --> <!-- div -->
### <a id="_.functions" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1643" title="View in source">`_.functions(object)`</a> ### <a id="_.functions" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1593" title="View in source">`_.functions(object)`</a>
Produces a sorted array of the `object`'s enumerable own property names that have function values. Produces a sorted array of the `object`'s enumerable own property names that have function values.
[&#9650;][1] [&#9650;][1]
@@ -675,7 +670,7 @@ _.functions(_);
<!-- div --> <!-- div -->
### <a id="_.groupBy" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L420" title="View in source">`_.groupBy(collection, callback [, thisArg])`</a> ### <a id="_.groupBy" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L335" title="View in source">`_.groupBy(collection, callback [, thisArg])`</a>
Splits a `collection` into sets, grouped by the result of running each value through `callback`. The `callback` is invoked with `3` arguments; for arrays they are *(value, index, array)* and for objects they are *(value, key, object)*. The `callback` argument may also be the name of a property to group by. Splits a `collection` into sets, grouped by the result of running each value through `callback`. The `callback` is invoked with `3` arguments; for arrays they are *(value, index, array)* and for objects they are *(value, key, object)*. The `callback` argument may also be the name of a property to group by.
[&#9650;][1] [&#9650;][1]
@@ -701,7 +696,7 @@ _.groupBy(['one', 'two', 'three'], 'length');
<!-- div --> <!-- div -->
### <a id="_.has" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1665" title="View in source">`_.has(object, key)`</a> ### <a id="_.has" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1617" title="View in source">`_.has(object, key)`</a>
Checks if an object has the specified key as a direct property. Checks if an object has the specified key as a direct property.
[&#9650;][1] [&#9650;][1]
@@ -723,7 +718,7 @@ _.has({ 'a': 1, 'b': 2, 'c': 3 }, 'b');
<!-- div --> <!-- div -->
### <a id="_.identity" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L2121" title="View in source">`_.identity(value)`</a> ### <a id="_.identity" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L2199" title="View in source">`_.identity(value)`</a>
This function simply returns the first argument passed to it. Note: It is used throughout Lodash as a default callback. This function simply returns the first argument passed to it. Note: It is used throughout Lodash as a default callback.
[&#9650;][1] [&#9650;][1]
@@ -745,7 +740,7 @@ moe === _.identity(moe);
<!-- div --> <!-- div -->
### <a id="_.indexOf" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L956" title="View in source">`_.indexOf(array, value [, isSorted=false])`</a> ### <a id="_.indexOf" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L880" title="View in source">`_.indexOf(array, value [, isSorted=false])`</a>
Gets the index at which the first occurrence of `value` is found using strict equality for comparisons, i.e. `===`. If the `array` is already sorted, passing `true` for `isSorted` will run a faster binary search. Gets the index at which the first occurrence of `value` is found using strict equality for comparisons, i.e. `===`. If the `array` is already sorted, passing `true` for `isSorted` will run a faster binary search.
[&#9650;][1] [&#9650;][1]
@@ -768,14 +763,14 @@ _.indexOf([1, 2, 3], 2);
<!-- div --> <!-- div -->
### <a id="_.initial" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L990" title="View in source">`_.initial(array [, n, guard])`</a> ### <a id="_.initial" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L914" title="View in source">`_.initial(array [, n, guard])`</a>
Gets all but the last value of the `array`. Pass `n` to exclude the last `n` values from the result. Gets all but the last value of the `array`. Pass `n` to exclude the last `n` values from the result.
[&#9650;][1] [&#9650;][1]
#### Arguments #### Arguments
1. `array` *(Array)*: The array to query. 1. `array` *(Array)*: The array to query.
2. `[n]` *(Number)*: The number of elements to return. 2. `[n]` *(Number)*: The number of elements to return.
3. `[guard]` *(Object)*: Used to allow the function to work with other iteration methods like `_.map` without using their callback `index` argument for `n`. 3. `[guard]` *(Object)*: Allows this method to work with others like `_.map` without using their callback `index` argument for `n`.
#### Returns #### Returns
*(Array)*: Returns all but the last value or `n` values of the `array`. *(Array)*: Returns all but the last value or `n` values of the `array`.
@@ -791,7 +786,7 @@ _.initial([5, 4, 3, 2, 1]);
<!-- div --> <!-- div -->
### <a id="_.intersection" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1009" title="View in source">`_.intersection([array1, array2, ...])`</a> ### <a id="_.intersection" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L933" title="View in source">`_.intersection([array1, array2, ...])`</a>
Computes the intersection of all the passed-in arrays. Computes the intersection of all the passed-in arrays.
[&#9650;][1] [&#9650;][1]
@@ -812,7 +807,7 @@ _.intersection([1, 2, 3], [101, 2, 1, 10], [2, 1]);
<!-- div --> <!-- div -->
### <a id="_.invoke" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L449" title="View in source">`_.invoke(collection, methodName [, arg1, arg2, ...])`</a> ### <a id="_.invoke" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L364" title="View in source">`_.invoke(collection, methodName [, arg1, arg2, ...])`</a>
Calls the method named by `methodName` for each value of the `collection`. Additional arguments will be passed to each invoked method. Calls the method named by `methodName` for each value of the `collection`. Additional arguments will be passed to each invoked method.
[&#9650;][1] [&#9650;][1]
@@ -835,7 +830,7 @@ _.invoke([[5, 1, 7], [3, 2, 1]], 'sort');
<!-- div --> <!-- div -->
### <a id="_.isArguments" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1685" title="View in source">`_.isArguments(value)`</a> ### <a id="_.isArguments" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1637" title="View in source">`_.isArguments(value)`</a>
Checks if a `value` is an `arguments` object. Checks if a `value` is an `arguments` object.
[&#9650;][1] [&#9650;][1]
@@ -859,7 +854,7 @@ _.isArguments([1, 2, 3]);
<!-- div --> <!-- div -->
### <a id="_.isArray" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1705" title="View in source">`_.isArray(value)`</a> ### <a id="_.isArray" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1657" title="View in source">`_.isArray(value)`</a>
Checks if a `value` is an array. Checks if a `value` is an array.
[&#9650;][1] [&#9650;][1]
@@ -883,7 +878,7 @@ _.isArray([1, 2, 3]);
<!-- div --> <!-- div -->
### <a id="_.isBoolean" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1722" title="View in source">`_.isBoolean(value)`</a> ### <a id="_.isBoolean" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1674" title="View in source">`_.isBoolean(value)`</a>
Checks if a `value` is a boolean *(`true` or `false`)* value. Checks if a `value` is a boolean *(`true` or `false`)* value.
[&#9650;][1] [&#9650;][1]
@@ -904,7 +899,7 @@ _.isBoolean(null);
<!-- div --> <!-- div -->
### <a id="_.isDate" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1739" title="View in source">`_.isDate(value)`</a> ### <a id="_.isDate" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1691" title="View in source">`_.isDate(value)`</a>
Checks if a `value` is a date. Checks if a `value` is a date.
[&#9650;][1] [&#9650;][1]
@@ -925,7 +920,7 @@ _.isDate(new Date);
<!-- div --> <!-- div -->
### <a id="_.isElement" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1756" title="View in source">`_.isElement(value)`</a> ### <a id="_.isElement" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1708" title="View in source">`_.isElement(value)`</a>
Checks if a `value` is a DOM element. Checks if a `value` is a DOM element.
[&#9650;][1] [&#9650;][1]
@@ -946,7 +941,7 @@ _.isElement(document.body);
<!-- div --> <!-- div -->
### <a id="_.isEmpty" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1777" title="View in source">`_.isEmpty(value)`</a> ### <a id="_.isEmpty" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1729" title="View in source">`_.isEmpty(value)`</a>
Checks if a `value` is empty. Arrays or strings with a length of `0` and objects with no enumerable own properties are considered "empty". Checks if a `value` is empty. Arrays or strings with a length of `0` and objects with no enumerable own properties are considered "empty".
[&#9650;][1] [&#9650;][1]
@@ -970,13 +965,13 @@ _.isEmpty({});
<!-- div --> <!-- div -->
### <a id="_.isEqual" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1813" title="View in source">`_.isEqual(value, other)`</a> ### <a id="_.isEqual" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1765" title="View in source">`_.isEqual(a, b)`</a>
Performs a deep comparison between two values to determine if they are equivalent to each other. Performs a deep comparison between two values to determine if they are equivalent to each other.
[&#9650;][1] [&#9650;][1]
#### Arguments #### Arguments
1. `value` *(Mixed)*: The value to compare. 1. `a` *(Mixed)*: The value to compare.
2. `other` *(Mixed)*: The other value to compare. 2. `b` *(Mixed)*: The other value to compare.
#### Returns #### Returns
*(Boolean)*: Returns `true` if the values are equvalent, else `false`. *(Boolean)*: Returns `true` if the values are equvalent, else `false`.
@@ -998,7 +993,7 @@ _.isEqual(moe, clone);
<!-- div --> <!-- div -->
### <a id="_.isFinite" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1836" title="View in source">`_.isFinite(value)`</a> ### <a id="_.isFinite" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1908" title="View in source">`_.isFinite(value)`</a>
Checks if a `value` is a finite number. Checks if a `value` is a finite number.
[&#9650;][1] [&#9650;][1]
@@ -1025,7 +1020,7 @@ _.isFinite(Infinity);
<!-- div --> <!-- div -->
### <a id="_.isFunction" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1853" title="View in source">`_.isFunction(value)`</a> ### <a id="_.isFunction" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1925" title="View in source">`_.isFunction(value)`</a>
Checks if a `value` is a function. Checks if a `value` is a function.
[&#9650;][1] [&#9650;][1]
@@ -1046,7 +1041,7 @@ _.isFunction(''.concat);
<!-- div --> <!-- div -->
### <a id="_.isNaN" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1898" title="View in source">`_.isNaN(value)`</a> ### <a id="_.isNaN" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1973" title="View in source">`_.isNaN(value)`</a>
Checks if a `value` is `NaN`. Note: this is not the same as native `isNaN`, which will return true for `undefined` and other values. See http://es5.github.com/#x15.1.2.4. Checks if a `value` is `NaN`. Note: this is not the same as native `isNaN`, which will return true for `undefined` and other values. See http://es5.github.com/#x15.1.2.4.
[&#9650;][1] [&#9650;][1]
@@ -1061,6 +1056,9 @@ Checks if a `value` is `NaN`. Note: this is not the same as native `isNaN`, whic
_.isNaN(NaN); _.isNaN(NaN);
// => true // => true
_.isNaN(new Number(NaN));
// => true
isNaN(undefined); isNaN(undefined);
// => true // => true
@@ -1073,7 +1071,7 @@ _.isNaN(undefined);
<!-- div --> <!-- div -->
### <a id="_.isNull" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1919" title="View in source">`_.isNull(value)`</a> ### <a id="_.isNull" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1994" title="View in source">`_.isNull(value)`</a>
Checks if a `value` is `null`. Checks if a `value` is `null`.
[&#9650;][1] [&#9650;][1]
@@ -1097,7 +1095,7 @@ _.isNull(undefined);
<!-- div --> <!-- div -->
### <a id="_.isNumber" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1936" title="View in source">`_.isNumber(value)`</a> ### <a id="_.isNumber" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L2011" title="View in source">`_.isNumber(value)`</a>
Checks if a `value` is a number. Checks if a `value` is a number.
[&#9650;][1] [&#9650;][1]
@@ -1118,7 +1116,7 @@ _.isNumber(8.4 * 5;
<!-- div --> <!-- div -->
### <a id="_.isObject" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1873" title="View in source">`_.isObject(value)`</a> ### <a id="_.isObject" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1945" title="View in source">`_.isObject(value)`</a>
Checks if a `value` is an object. Checks if a `value` is an object.
[&#9650;][1] [&#9650;][1]
@@ -1142,7 +1140,7 @@ _.isObject(1);
<!-- div --> <!-- div -->
### <a id="_.isRegExp" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1953" title="View in source">`_.isRegExp(value)`</a> ### <a id="_.isRegExp" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L2028" title="View in source">`_.isRegExp(value)`</a>
Checks if a `value` is a regular expression. Checks if a `value` is a regular expression.
[&#9650;][1] [&#9650;][1]
@@ -1163,7 +1161,7 @@ _.isRegExp(/moe/);
<!-- div --> <!-- div -->
### <a id="_.isString" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1970" title="View in source">`_.isString(value)`</a> ### <a id="_.isString" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L2045" title="View in source">`_.isString(value)`</a>
Checks if a `value` is a string. Checks if a `value` is a string.
[&#9650;][1] [&#9650;][1]
@@ -1184,7 +1182,7 @@ _.isString('moe');
<!-- div --> <!-- div -->
### <a id="_.isUndefined" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1987" title="View in source">`_.isUndefined(value)`</a> ### <a id="_.isUndefined" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L2062" title="View in source">`_.isUndefined(value)`</a>
Checks if a `value` is `undefined`. Checks if a `value` is `undefined`.
[&#9650;][1] [&#9650;][1]
@@ -1205,7 +1203,7 @@ _.isUndefined(void 0);
<!-- div --> <!-- div -->
### <a id="_.keys" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L2004" title="View in source">`_.keys(object)`</a> ### <a id="_.keys" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L2079" title="View in source">`_.keys(object)`</a>
Produces an array of the `object`'s enumerable own property names. Produces an array of the `object`'s enumerable own property names.
[&#9650;][1] [&#9650;][1]
@@ -1226,14 +1224,14 @@ _.keys({ 'one': 1, 'two': 2, 'three': 3 });
<!-- div --> <!-- div -->
### <a id="_.last" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1035" title="View in source">`_.last(array [, n, guard])`</a> ### <a id="_.last" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L959" title="View in source">`_.last(array [, n, guard])`</a>
Gets the last value of the `array`. Pass `n` to return the lasy `n` values of the `array`. Gets the last value of the `array`. Pass `n` to return the lasy `n` values of the `array`.
[&#9650;][1] [&#9650;][1]
#### Arguments #### Arguments
1. `array` *(Array)*: The array to query. 1. `array` *(Array)*: The array to query.
2. `[n]` *(Number)*: The number of elements to return. 2. `[n]` *(Number)*: The number of elements to return.
3. `[guard]` *(Object)*: Used to allow the function to work with other iteration methods like `_.map` without using their callback `index` argument for `n`. 3. `[guard]` *(Object)*: Allows this method to work with others like `_.map` without using their callback `index` argument for `n`.
#### Returns #### Returns
*(Array)*: Returns all but the last value or `n` values of the `array`. *(Array)*: Returns all but the last value or `n` values of the `array`.
@@ -1249,7 +1247,7 @@ _.last([5, 4, 3, 2, 1]);
<!-- div --> <!-- div -->
### <a id="_.lastIndexOf" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1055" title="View in source">`_.lastIndexOf(array, value)`</a> ### <a id="_.lastIndexOf" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L979" title="View in source">`_.lastIndexOf(array, value)`</a>
Gets the index at which the last occurrence of `value` is found using strict equality for comparisons, i.e. `===`. Gets the index at which the last occurrence of `value` is found using strict equality for comparisons, i.e. `===`.
[&#9650;][1] [&#9650;][1]
@@ -1271,7 +1269,7 @@ _.lastIndexOf([1, 2, 3, 1, 2, 3], 2);
<!-- div --> <!-- div -->
### <a id="_.map" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L480" title="View in source">`_.map(collection, callback [, thisArg])`</a> ### <a id="_.map" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L395" title="View in source">`_.map(collection, callback [, thisArg])`</a>
Produces a new array of values by mapping each value in the `collection` through a transformation `callback`. The `callback` is bound to the `thisArg` value, if one is passed. The `callback` is invoked with `3` arguments; for arrays they are *(value, index, array)* and for objects they are *(value, key, object)*. Produces a new array of values by mapping each value in the `collection` through a transformation `callback`. The `callback` is bound to the `thisArg` value, if one is passed. The `callback` is invoked with `3` arguments; for arrays they are *(value, index, array)* and for objects they are *(value, key, object)*.
[&#9650;][1] [&#9650;][1]
@@ -1288,7 +1286,7 @@ Produces a new array of values by mapping each value in the `collection` through
_.map([1, 2, 3], function(num) { return num * 3; }); _.map([1, 2, 3], function(num) { return num * 3; });
// => [3, 6, 9] // => [3, 6, 9]
_.map({ 'one' : 1, 'two' : 2, 'three' : 3 }, function(num) { return num * 3; }); _.map({ 'one': 1, 'two': 2, 'three': 3 }, function(num) { return num * 3; });
// => [3, 6, 9] // => [3, 6, 9]
~~~ ~~~
@@ -1297,7 +1295,7 @@ _.map({ 'one' : 1, 'two' : 2, 'three' : 3 }, function(num) { return num * 3; });
<!-- div --> <!-- div -->
### <a id="_.max" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L517" title="View in source">`_.max(collection [, callback, thisArg])`</a> ### <a id="_.max" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L428" title="View in source">`_.max(collection [, callback, thisArg])`</a>
Retrieves the maximum value of a `collection`. If `callback` is passed, it will be executed for each value in the `collection` to generate the criterion by which the value is ranked. The `callback` is invoked with `3` arguments; for arrays they are *(value, index, array)* and for objects they are *(value, key, object)*. Retrieves the maximum value of a `collection`. If `callback` is passed, it will be executed for each value in the `collection` to generate the criterion by which the value is ranked. The `callback` is invoked with `3` arguments; for arrays they are *(value, index, array)* and for objects they are *(value, key, object)*.
[&#9650;][1] [&#9650;][1]
@@ -1312,13 +1310,13 @@ Retrieves the maximum value of a `collection`. If `callback` is passed, it will
#### Example #### Example
~~~ js ~~~ js
var stooges = [ var stooges = [
{ 'name' : 'moe', 'age' : 40}, { 'name': 'moe', 'age': 40 },
{ 'name' : 'larry', 'age' : 50}, { 'name': 'larry', 'age': 50 },
{ 'name' : 'curly', 'age' : 60} { 'name': 'curly', 'age': 60 }
]; ];
_.max(stooges, function(stooge) { return stooge.age; }); _.max(stooges, function(stooge) { return stooge.age; });
// => { 'name' : 'curly', 'age' : 60 }; // => { 'name': 'curly', 'age': 60 };
~~~ ~~~
<!-- /div --> <!-- /div -->
@@ -1326,7 +1324,7 @@ _.max(stooges, function(stooge) { return stooge.age; });
<!-- div --> <!-- div -->
### <a id="_.memoize" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1451" title="View in source">`_.memoize(func [, hasher=_.identity])`</a> ### <a id="_.memoize" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1392" title="View in source">`_.memoize(func [, hasher=_.identity])`</a>
Creates a new function that memoizes the result of `func`. If `hasher` is passed, it will be used to compute the hash key for storing the result, based on the arguments to the original function. The default `hasher` uses the first argument to the memoized function as the cache key. Creates a new function that memoizes the result of `func`. If `hasher` is passed, it will be used to compute the hash key for storing the result, based on the arguments to the original function. The default `hasher` uses the first argument to the memoized function as the cache key.
[&#9650;][1] [&#9650;][1]
@@ -1349,7 +1347,7 @@ var fibonacci = _.memoize(function(n) {
<!-- div --> <!-- div -->
### <a id="_.min" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L549" title="View in source">`_.min(collection [, callback, thisArg])`</a> ### <a id="_.min" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L468" title="View in source">`_.min(collection [, callback, thisArg])`</a>
Retrieves the minimum value of a `collection`. If `callback` is passed, it will be executed for each value in the `collection` to generate the criterion by which the value is ranked. The `callback` is invoked with `3` arguments; for arrays they are *(value, index, array)* and for objects they are *(value, key, object)*. Retrieves the minimum value of a `collection`. If `callback` is passed, it will be executed for each value in the `collection` to generate the criterion by which the value is ranked. The `callback` is invoked with `3` arguments; for arrays they are *(value, index, array)* and for objects they are *(value, key, object)*.
[&#9650;][1] [&#9650;][1]
@@ -1372,7 +1370,7 @@ _.min([10, 5, 100, 2, 1000]);
<!-- div --> <!-- div -->
### <a id="_.mixin" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L2147" title="View in source">`_.mixin(object)`</a> ### <a id="_.mixin" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L2225" title="View in source">`_.mixin(object)`</a>
Adds functions properties of `object` to the `lodash` function and chainable wrapper. Adds functions properties of `object` to the `lodash` function and chainable wrapper.
[&#9650;][1] [&#9650;][1]
@@ -1399,7 +1397,7 @@ _('larry').capitalize();
<!-- div --> <!-- div -->
### <a id="_.noConflict" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L2165" title="View in source">`_.noConflict()`</a> ### <a id="_.noConflict" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L2255" title="View in source">`_.noConflict()`</a>
Reverts the '_' variable to its previous value and returns a reference to the `lodash` function. Reverts the '_' variable to its previous value and returns a reference to the `lodash` function.
[&#9650;][1] [&#9650;][1]
@@ -1416,7 +1414,7 @@ var lodash = _.noConflict();
<!-- div --> <!-- div -->
### <a id="_.once" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1476" title="View in source">`_.once(func)`</a> ### <a id="_.once" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1419" title="View in source">`_.once(func)`</a>
Creates a new function that is restricted to one execution. Repeat calls to the function will return the value of the first call. Creates a new function that is restricted to one execution. Repeat calls to the function will return the value of the first call.
[&#9650;][1] [&#9650;][1]
@@ -1439,7 +1437,7 @@ initialize();
<!-- div --> <!-- div -->
### <a id="_.pick" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L2032" title="View in source">`_.pick(object [, prop1, prop2, ..])`</a> ### <a id="_.pick" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L2107" title="View in source">`_.pick(object [, prop1, prop2, ..])`</a>
Creates an object composed of the specified properties. Property names may be specified as individual arguments or as arrays of property names. Creates an object composed of the specified properties. Property names may be specified as individual arguments or as arrays of property names.
[&#9650;][1] [&#9650;][1]
@@ -1461,7 +1459,7 @@ _.pick({ 'name': 'moe', 'age': 40, 'userid': 'moe1' }, 'name', 'age');
<!-- div --> <!-- div -->
### <a id="_.pluck" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L580" title="View in source">`_.pluck(collection, property)`</a> ### <a id="_.pluck" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L509" title="View in source">`_.pluck(collection, property)`</a>
Retrieves the value of a specified property from all values in a `collection`. Retrieves the value of a specified property from all values in a `collection`.
[&#9650;][1] [&#9650;][1]
@@ -1475,9 +1473,9 @@ Retrieves the value of a specified property from all values in a `collection`.
#### Example #### Example
~~~ js ~~~ js
var stooges = [ var stooges = [
{ 'name' : 'moe', 'age' : 40}, { 'name': 'moe', 'age': 40 },
{ 'name' : 'larry', 'age' : 50}, { 'name': 'larry', 'age': 50 },
{ 'name' : 'curly', 'age' : 60} { 'name': 'curly', 'age': 60 }
]; ];
_.pluck(stooges, 'name'); _.pluck(stooges, 'name');
@@ -1489,7 +1487,7 @@ _.pluck(stooges, 'name');
<!-- div --> <!-- div -->
### <a id="_.range" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1094" title="View in source">`_.range([start=0], end [, step=1])`</a> ### <a id="_.range" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1021" title="View in source">`_.range([start=0], end [, step=1])`</a>
Creates an array of numbers *(positive and/or negative)* progressing from `start` up to but not including `stop`. This method is a port of Python's `range()` function. See http://docs.python.org/library/functions.html#range. Creates an array of numbers *(positive and/or negative)* progressing from `start` up to but not including `stop`. This method is a port of Python's `range()` function. See http://docs.python.org/library/functions.html#range.
[&#9650;][1] [&#9650;][1]
@@ -1524,7 +1522,7 @@ _.range(0);
<!-- div --> <!-- div -->
### <a id="_.reduce" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L606" title="View in source">`_.reduce(collection, callback [, accumulator, thisArg])`</a> ### <a id="_.reduce" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L535" title="View in source">`_.reduce(collection, callback [, accumulator, thisArg])`</a>
Boils down a `collection` to a single value. The initial state of the reduction is `accumulator` and each successive step of it should be returned by the `callback`. The `callback` is bound to the `thisArg` value, if one is passed. The `callback` is invoked with `4` arguments; for arrays they are *(accumulator, value, index, array)* and for objects they are *(accumulator, value, key, object)*. Boils down a `collection` to a single value. The initial state of the reduction is `accumulator` and each successive step of it should be returned by the `callback`. The `callback` is bound to the `thisArg` value, if one is passed. The `callback` is invoked with `4` arguments; for arrays they are *(accumulator, value, index, array)* and for objects they are *(accumulator, value, key, object)*.
[&#9650;][1] [&#9650;][1]
@@ -1548,7 +1546,7 @@ var sum = _.reduce([1, 2, 3], function(memo, num) { return memo + num; });
<!-- div --> <!-- div -->
### <a id="_.reduceRight" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L642" title="View in source">`_.reduceRight(collection, callback [, accumulator, thisArg])`</a> ### <a id="_.reduceRight" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L562" title="View in source">`_.reduceRight(collection, callback [, accumulator, thisArg])`</a>
The right-associative version of `_.reduce`. The `callback` is bound to the `thisArg` value, if one is passed. The `callback` is invoked with `4` arguments; for arrays they are *(accumulator, value, index, array)* and for objects they are *(accumulator, value, key, object)*. The right-associative version of `_.reduce`. The `callback` is bound to the `thisArg` value, if one is passed. The `callback` is invoked with `4` arguments; for arrays they are *(accumulator, value, index, array)* and for objects they are *(accumulator, value, key, object)*.
[&#9650;][1] [&#9650;][1]
@@ -1573,7 +1571,7 @@ var flat = _.reduceRight(list, function(a, b) { return a.concat(b); }, []);
<!-- div --> <!-- div -->
### <a id="_.reject" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L668" title="View in source">`_.reject(collection, callback [, thisArg])`</a> ### <a id="_.reject" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L587" title="View in source">`_.reject(collection, callback [, thisArg])`</a>
The opposite of `_.filter`, this method returns the values of a `collection` that `callback` does **not** return truthy for. The `callback` is invoked with `3` arguments; for arrays they are *(value, index, array)* and for objects they are *(value, key, object)*. The opposite of `_.filter`, this method returns the values of a `collection` that `callback` does **not** return truthy for. The `callback` is invoked with `3` arguments; for arrays they are *(value, index, array)* and for objects they are *(value, key, object)*.
[&#9650;][1] [&#9650;][1]
@@ -1596,14 +1594,14 @@ var odds = _.reject([1, 2, 3, 4, 5, 6], function(num) { return num % 2 == 0; });
<!-- div --> <!-- div -->
### <a id="_.rest" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1130" title="View in source">`_.rest(array [, n, guard])`</a> ### <a id="_.rest" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1057" title="View in source">`_.rest(array [, n, guard])`</a>
The opposite of `_.initial`, this method gets all but the first value of the `array`. Pass `n` to exclude the first `n` values from the result. The opposite of `_.initial`, this method gets all but the first value of the `array`. Pass `n` to exclude the first `n` values from the result.
[&#9650;][1] [&#9650;][1]
#### Arguments #### Arguments
1. `array` *(Array)*: The array to query. 1. `array` *(Array)*: The array to query.
2. `[n]` *(Number)*: The number of elements to return. 2. `[n]` *(Number)*: The number of elements to return.
3. `[guard]` *(Object)*: Used to allow the function to work with other iteration methods like `_.map` without using their callback `index` argument for `n`. 3. `[guard]` *(Object)*: Allows this method to work with others like `_.map` without using their callback `index` argument for `n`.
#### Returns #### Returns
*(Array)*: Returns all but the first value or `n` values of the `array`. *(Array)*: Returns all but the first value or `n` values of the `array`.
@@ -1619,7 +1617,7 @@ _.rest([5, 4, 3, 2, 1]);
<!-- div --> <!-- div -->
### <a id="_.result" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L2195" title="View in source">`_.result(object, property)`</a> ### <a id="_.result" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L2285" title="View in source">`_.result(object, property)`</a>
Resolves the value of `property` on `object`. If the property is a function it will be invoked and its result returned, else the property value is returned. Resolves the value of `property` on `object`. If the property is a function it will be invoked and its result returned, else the property value is returned.
[&#9650;][1] [&#9650;][1]
@@ -1651,7 +1649,7 @@ _.result(object, 'stuff');
<!-- div --> <!-- div -->
### <a id="_.shuffle" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L691" title="View in source">`_.shuffle(collection)`</a> ### <a id="_.shuffle" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L606" title="View in source">`_.shuffle(collection)`</a>
Produces a new array of shuffled `collection` values, using a version of the Fisher-Yates shuffle. See http://en.wikipedia.org/wiki/Fisher-Yates_shuffle. Produces a new array of shuffled `collection` values, using a version of the Fisher-Yates shuffle. See http://en.wikipedia.org/wiki/Fisher-Yates_shuffle.
[&#9650;][1] [&#9650;][1]
@@ -1672,7 +1670,7 @@ _.shuffle([1, 2, 3, 4, 5, 6]);
<!-- div --> <!-- div -->
### <a id="_.size" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L714" title="View in source">`_.size(collection)`</a> ### <a id="_.size" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L631" title="View in source">`_.size(collection)`</a>
Gets the number of values in the `collection`. Gets the number of values in the `collection`.
[&#9650;][1] [&#9650;][1]
@@ -1693,7 +1691,7 @@ _.size({ 'one': 1, 'two': 2, 'three': 3 });
<!-- div --> <!-- div -->
### <a id="_.some" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L776" title="View in source">`_.some(collection, callback [, thisArg])`</a> ### <a id="_.some" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L701" title="View in source">`_.some(collection, callback [, thisArg])`</a>
Checks if the `callback` returns truthy for **any** value of a `collection`. The function returns as soon as it finds passing value, and does not iterate over the entire `collection`. The `callback` is invoked with `3` arguments; for arrays they are *(value, index, array)* and for objects they are *(value, key, object)*. Checks if the `callback` returns truthy for **any** value of a `collection`. The function returns as soon as it finds passing value, and does not iterate over the entire `collection`. The `callback` is invoked with `3` arguments; for arrays they are *(value, index, array)* and for objects they are *(value, key, object)*.
[&#9650;][1] [&#9650;][1]
@@ -1716,7 +1714,7 @@ _.some([null, 0, 'yes', false]);
<!-- div --> <!-- div -->
### <a id="_.sortBy" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L738" title="View in source">`_.sortBy(collection, callback [, thisArg])`</a> ### <a id="_.sortBy" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L655" title="View in source">`_.sortBy(collection, callback [, thisArg])`</a>
Produces a new sorted array, ranked in ascending order by the results of running each value of a `collection` through `callback`. The `callback` is invoked with `3` arguments; for arrays they are *(value, index, array)* and for objects they are *(value, key, object)*. The `callback` argument may also be the name of a property to sort by *(e.g. 'length')*. Produces a new sorted array, ranked in ascending order by the results of running each value of a `collection` through `callback`. The `callback` is invoked with `3` arguments; for arrays they are *(value, index, array)* and for objects they are *(value, key, object)*. The `callback` argument may also be the name of a property to sort by *(e.g. 'length')*.
[&#9650;][1] [&#9650;][1]
@@ -1739,7 +1737,7 @@ _.sortBy([1, 2, 3, 4, 5, 6], function(num) { return Math.sin(num); });
<!-- div --> <!-- div -->
### <a id="_.sortedIndex" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L806" title="View in source">`_.sortedIndex(array, value [, callback])`</a> ### <a id="_.sortedIndex" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L728" title="View in source">`_.sortedIndex(array, value [, callback])`</a>
Uses a binary search to determine the index at which the `value` should be inserted into the `collection` in order to maintain the `collection`'s sorted order. If `callback` is passed, it will be executed for each value in the `collection` to compute their sort ranking. The `callback` is invoked with `1` arguments. Uses a binary search to determine the index at which the `value` should be inserted into the `collection` in order to maintain the `collection`'s sorted order. If `callback` is passed, it will be executed for each value in the `collection` to compute their sort ranking. The `callback` is invoked with `1` arguments.
[&#9650;][1] [&#9650;][1]
@@ -1762,7 +1760,7 @@ _.sortedIndex([10, 20, 30, 40, 50], 35);
<!-- div --> <!-- div -->
### <a id="_.tap" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L2061" title="View in source">`_.tap(value, interceptor)`</a> ### <a id="_.tap" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L2138" title="View in source">`_.tap(value, interceptor)`</a>
Invokes `interceptor` with the `value` as the first argument, and then returns `value`. The primary purpose of this method is to "tap into" a method chain, in order to performoperations on intermediate results within the chain. Invokes `interceptor` with the `value` as the first argument, and then returns `value`. The primary purpose of this method is to "tap into" a method chain, in order to performoperations on intermediate results within the chain.
[&#9650;][1] [&#9650;][1]
@@ -1789,7 +1787,7 @@ _.chain([1,2,3,200])
<!-- div --> <!-- div -->
### <a id="_.template" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L2290" title="View in source">`_.template(text, data, settings)`</a> ### <a id="_.template" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L2385" title="View in source">`_.template(text, data, settings)`</a>
JavaScript micro-templating, similar to John Resig's implementation. Lo-Dash templating handles arbitrary delimiters, preserves whitespace, and correctly escapes quotes within interpolated code. JavaScript micro-templating, similar to John Resig's implementation. Lo-Dash templating handles arbitrary delimiters, preserves whitespace, and correctly escapes quotes within interpolated code.
[&#9650;][1] [&#9650;][1]
@@ -1844,7 +1842,7 @@ _.template('<%= data.hasWith %>', { 'hasWith': 'no' }, { 'variable': 'data' });
<!-- div --> <!-- div -->
### <a id="_.throttle" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1504" title="View in source">`_.throttle(func, wait)`</a> ### <a id="_.throttle" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1448" title="View in source">`_.throttle(func, wait)`</a>
Creates a new function that, when invoked, will only call the original function at most once per every `wait` milliseconds. Creates a new function that, when invoked, will only call the original function at most once per every `wait` milliseconds.
[&#9650;][1] [&#9650;][1]
@@ -1866,7 +1864,7 @@ jQuery(window).on('scroll', throttled);
<!-- div --> <!-- div -->
### <a id="_.times" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L2214" title="View in source">`_.times(n, callback [, thisArg])`</a> ### <a id="_.times" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L2306" title="View in source">`_.times(n, callback [, thisArg])`</a>
Executes the `callback` function `n` times. Executes the `callback` function `n` times.
[&#9650;][1] [&#9650;][1]
@@ -1885,7 +1883,7 @@ _.times(3, function() { genie.grantWish(); });
<!-- div --> <!-- div -->
### <a id="_.toArray" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L830" title="View in source">`_.toArray(collection)`</a> ### <a id="_.toArray" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L754" title="View in source">`_.toArray(collection)`</a>
Converts the `collection`, into an array. Useful for converting the `arguments` object. Converts the `collection`, into an array. Useful for converting the `arguments` object.
[&#9650;][1] [&#9650;][1]
@@ -1906,7 +1904,7 @@ Converts the `collection`, into an array. Useful for converting the `arguments`
<!-- div --> <!-- div -->
### <a id="_.union" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1148" title="View in source">`_.union([array1, array2, ...])`</a> ### <a id="_.union" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1075" title="View in source">`_.union([array1, array2, ...])`</a>
Computes the union of the passed-in arrays. Computes the union of the passed-in arrays.
[&#9650;][1] [&#9650;][1]
@@ -1927,7 +1925,7 @@ _.union([1, 2, 3], [101, 2, 1, 10], [2, 1]);
<!-- div --> <!-- div -->
### <a id="_.uniq" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1173" title="View in source">`_.uniq(array [, isSorted=false, callback])`</a> ### <a id="_.uniq" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1100" title="View in source">`_.uniq(array [, isSorted=false, callback])`</a>
Produces a duplicate-value-free version of the `array` using strict equality for comparisons, i.e. `===`. If the `array` is already sorted, passing `true` for `isSorted` will run a faster algorithm. If `callback` is passed, each value of `array` is passed through a transformation `callback` before uniqueness is computed. The `callback` is invoked with `3` arguments; *(value, index, array)*. Produces a duplicate-value-free version of the `array` using strict equality for comparisons, i.e. `===`. If the `array` is already sorted, passing `true` for `isSorted` will run a faster algorithm. If `callback` is passed, each value of `array` is passed through a transformation `callback` before uniqueness is computed. The `callback` is invoked with `3` arguments; *(value, index, array)*.
[&#9650;][1] [&#9650;][1]
@@ -1950,7 +1948,7 @@ _.uniq([1, 2, 1, 3, 1, 4]);
<!-- div --> <!-- div -->
### <a id="_.uniqueId" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L2234" title="View in source">`_.uniqueId([prefix])`</a> ### <a id="_.uniqueId" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L2329" title="View in source">`_.uniqueId([prefix])`</a>
Generates a unique id. If `prefix` is passed, the id will be appended to it. Generates a unique id. If `prefix` is passed, the id will be appended to it.
[&#9650;][1] [&#9650;][1]
@@ -1971,7 +1969,7 @@ _.uniqueId('contact_');
<!-- div --> <!-- div -->
### <a id="_.values" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L2080" title="View in source">`_.values(object)`</a> ### <a id="_.values" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L2157" title="View in source">`_.values(object)`</a>
Produces an array of the `object`'s enumerable own property values. Produces an array of the `object`'s enumerable own property values.
[&#9650;][1] [&#9650;][1]
@@ -1992,7 +1990,7 @@ _.values({ 'one': 1, 'two': 2, 'three': 3 });
<!-- div --> <!-- div -->
### <a id="_.without" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1206" title="View in source">`_.without(array [, value1, value2, ...])`</a> ### <a id="_.without" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1134" title="View in source">`_.without(array [, value1, value2, ...])`</a>
Produces a new array with all occurrences of the values removed using strict equality for comparisons, i.e. `===`. Produces a new array with all occurrences of the values removed using strict equality for comparisons, i.e. `===`.
[&#9650;][1] [&#9650;][1]
@@ -2014,7 +2012,7 @@ _.without([1, 2, 1, 0, 3, 1, 4], 0, 1);
<!-- div --> <!-- div -->
### <a id="_.wrap" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1547" title="View in source">`_.wrap(func, wrapper [, arg1, arg2, ...])`</a> ### <a id="_.wrap" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1497" title="View in source">`_.wrap(func, wrapper [, arg1, arg2, ...])`</a>
Create a new function that passes the `func` function to the `wrapper` function as its first argument. Additional arguments are appended to those passed to the `wrapper` function. Create a new function that passes the `func` function to the `wrapper` function as its first argument. Additional arguments are appended to those passed to the `wrapper` function.
[&#9650;][1] [&#9650;][1]
@@ -2041,7 +2039,7 @@ hello();
<!-- div --> <!-- div -->
### <a id="_.zip" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1226" title="View in source">`_.zip([array1, array2, ...])`</a> ### <a id="_.zip" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L1154" title="View in source">`_.zip([array1, array2, ...])`</a>
Merges together the values of each of the arrays with the value at the corresponding position. Useful for separate data sources that are coordinated through matching array indexes. For a matrix of nested arrays, `_.zip.apply(...)` can transpose the matrix in a similar fashion. Merges together the values of each of the arrays with the value at the corresponding position. Useful for separate data sources that are coordinated through matching array indexes. For a matrix of nested arrays, `_.zip.apply(...)` can transpose the matrix in a similar fashion.
[&#9650;][1] [&#9650;][1]
@@ -2066,13 +2064,13 @@ _.zip(['moe', 'larry', 'curly'], [30, 40, 50], [true, false, false]);
<!-- div --> <!-- div -->
## `_.prototype` ## `_.prototype`
### <a id="_" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L81" title="View in source">`_(value)`</a> ### <a id="_" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L80" title="View in source">`_(value)`</a>
The Lodash function. The Lodash function.
[&#9650;][1] [&#9650;][1]
<!-- div --> <!-- div -->
### <a id="_:chain" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L2376" title="View in source">`_#chain()`</a> ### <a id="_:chain" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L2471" title="View in source">`_#chain()`</a>
Extracts the value from a wrapped chainable object. Extracts the value from a wrapped chainable object.
[&#9650;][1] [&#9650;][1]
@@ -2090,7 +2088,7 @@ _([1, 2, 3]).value();
<!-- div --> <!-- div -->
### <a id="_:value" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L2392" title="View in source">`_#value()`</a> ### <a id="_:value" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L2487" title="View in source">`_#value()`</a>
Extracts the value from a wrapped chainable object. Extracts the value from a wrapped chainable object.
[&#9650;][1] [&#9650;][1]
@@ -2115,7 +2113,7 @@ _([1, 2, 3]).value();
<!-- div --> <!-- div -->
### <a id="_.templateSettings" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L2428" title="View in source">`_.templateSettings`</a> ### <a id="_.templateSettings" href="https://github.com/bestiejs/lodash/blob/master/lodash.js#L2523" title="View in source">`_.templateSettings`</a>
*(Object)*: By default, Lodash uses ERB-style template delimiters, change the following template settings to use alternative delimiters. *(Object)*: By default, Lodash uses ERB-style template delimiters, change the following template settings to use alternative delimiters.
[&#9650;][1] [&#9650;][1]

558
lodash.js
View File

@@ -74,9 +74,8 @@
* *
* @name _ * @name _
* @constructor * @constructor
* @param {Mixed} value The value to wrap in a chainable `lowdash` object. * @param {Mixed} value The value to wrap in a chainable `lodash` object.
* @returns {Object} Returns a `lodash` instance. * @returns {Object} Returns a `lodash` instance.
* @example
*/ */
function lodash(value) { function lodash(value) {
// allow invoking `lodash` without the `new` operator // allow invoking `lodash` without the `new` operator
@@ -90,7 +89,6 @@
* @private * @private
* @constructor * @constructor
* @param {Mixed} value The value to wrap in a chainable `lodash` object. * @param {Mixed} value The value to wrap in a chainable `lodash` object.
* @example
*/ */
function Wrapper(collection) { function Wrapper(collection) {
this._wrapped = collection; this._wrapped = collection;
@@ -99,133 +97,90 @@
/*--------------------------------------------------------------------------*/ /*--------------------------------------------------------------------------*/
/** /**
* Internal recursive comparison function * A simple iteration function.
* *
* @private * @private
* @param {Mixed} a A value. * @param {Array} array The array or array-like-object to iterate over.
* @param {Mixed} b Another value. * @param {Function} callback The function called per iteration.
* @param {Array} stack Holds seen objects to avoid circular references. * @param {Number} [start=0] The index to start the iterating.
* @example
*/ */
function eq(a, b, stack) { function _each(array, callback, start) {
// identical objects are equal. `0 === -0`, but they aren't identical for (var index = start || 0, length = array.length; index < length; index++) {
// See the Harmony `egal` proposal: http://wiki.ecmascript.org/doku.php?id=harmony:egal callback(array[index], index, array);
if (a === b) {
return a !== 0 || (1 / a == 1 / b);
}
// a strict comparison is necessary because `null == undefined`
if (a == null || b == null) {
return a === b;
}
// unwrap any wrapped objects
if (a._chain) {
a = a._wrapped;
}
if (b._chain) {
b = b._wrapped;
}
// invoke a custom `isEqual` method if one is provided
if (a.isEqual && isFunction(a.isEqual)) {
return a.isEqual(b);
}
if (b.isEqual && isFunction(b.isEqual)) {
return b.isEqual(a);
} }
};
// compare `[[Class]]` names /**
var className = toString.call(a); * Compiles iteration functions.
if (className != toString.call(b)) { *
return false; * @private
} * @param {Object} options The compile options object.
switch (className) { * @returns {Function} Returns the compiled function.
// strings, numbers, dates, and booleans are compared by value */
case '[object String]': function iterationFactory(options) {
// primitives and their corresponding collection wrappers are equivalent; thus, `"5"` is var args = options.args || (options.args = 'collection,callback,thisArg'),
// equivalent to `new String("5")` array = {},
return a == String(b); arrayBranch = options.array !== false,
object = {},
objectBranch = options.object !== false,
beforeLoop = options.beforeLoop || '',
breaker = options.breaker,
defaultInLoop = 'callback(collection[index],index,collection)',
inLoop = options.inLoop || '';
case '[object Number]': if (typeof beforeLoop == 'string') {
// `NaN`s are equivalent, but non-reflexive; array.beforeLoop = object.beforeLoop = beforeLoop;
// an `egal` comparison is performed for other numeric values
return a != +a ? b != +b : (a == 0 ? 1 / a == 1 / b : a == +b);
case '[object Date]':
case '[object Boolean]':
// Coerce dates and booleans to numeric primitive values.
// Dates are compared by their millisecond representations.
// Note that invalid dates with millisecond representations of `NaN` are not equivalent.
return +a == +b;
// regexps are compared by their source and flags
case '[object RegExp]':
return a.source == b.source &&
a.global == b.global &&
a.multiline == b.multiline &&
a.ignoreCase == b.ignoreCase;
}
if (typeof a != 'object' || typeof b != 'object') {
return false;
}
// Assume equality for cyclic structures. The algorithm for detecting cyclic
// structures is adapted from ES 5.1 section 15.12.3, abstract operation `JO`.
var length = stack.length;
while (length--) {
// Linear search. Performance is inversely proportional to the number of
// unique nested structures.
if (stack[length] == a) {
return true;
}
}
// add the first collection to the stack of traversed objects
stack.push(a);
var size = 0, result = true;
// recursively compare objects and arrays
if (className == '[object Array]') {
// compare array lengths to determine if a deep comparison is necessary
size = a.length;
result = size == b.length;
if (result) {
// deep compare the contents, ignoring non-numeric properties
while (size--) {
// ensure commutative equality for sparse arrays
if (!(result = size in a == size in b && eq(a[size], b[size], stack))) {
break;
}
}
}
} else { } else {
// objects with different constructors are not equivalent array.beforeLoop = beforeLoop.array;
if ('constructor' in a != 'constructor' in b || a.constructor != b.constructor) { object.beforeLoop = beforeLoop.object;
return false;
}
// deep compare objects
for (var key in a) {
if (hasOwnProperty.call(a, key)) {
// count the expected number of properties
size++;
// deep compare each member
if (!(result = hasOwnProperty.call(b, key) && eq(a[key], b[key], stack))) {
break;
}
}
}
// ensure that both objects contain the same number of properties
if (result) {
for (key in b) {
if (hasOwnProperty.call(b, key) && !(size--)) {
break;
}
}
result = !size;
}
} }
// remove the first collection from the stack of traversed objects if (typeof inLoop == 'string') {
stack.pop(); array.inLoop = object.inLoop = inLoop || defaultInLoop;
return result; } else {
array.inLoop = inLoop.array || defaultInLoop;
object.inLoop = inLoop.object || defaultInLoop;
}
return Function('_,bind,breaker,hasOwnProperty,identity',
'return function(' + args + '){' +
(/\bcallback\b/.test(args)
? 'if(!callback)callback=identity;' +
(/\bthisArg\b/.test(args)
? 'else if(thisArg)callback=bind(callback,thisArg);'
: ''
)
: ''
) +
(options.top || 'var result') + ';' +
'if(collection==null)return result;' +
'var index=-1,length=collection.length;' +
(arrayBranch
? ((objectBranch ? 'if(length===+length){' : '') +
(array.beforeLoop || '') + ';' +
'while(' + (options['while'] || '++index<length') + '){' +
(breaker
? 'if((' + array.inLoop + ')===breaker)break'
: array.inLoop
) +
'}' +
(objectBranch ? '}' : ''))
: ''
) +
(options.object !== false
? ((arrayBranch ? 'else{' : '') +
(object.beforeLoop || '') + ';' +
'for(index in collection){' +
'if(hasOwnProperty.call(collection,index)' +
(breaker
? '&&(' + object.inLoop + ')===breaker)break'
: ')' + object.inLoop + ';'
) +
'}' +
(arrayBranch ? '}' : ''))
: ''
) +
'return ' + (options.returns || 'result') +
'}'
)(lodash, bind, breaker, hasOwnProperty, identity);
} }
/*--------------------------------------------------------------------------*/ /*--------------------------------------------------------------------------*/
@@ -246,11 +201,11 @@
* _.contains([1, 2, 3], 3); * _.contains([1, 2, 3], 3);
* // => true * // => true
*/ */
function contains(collection, target) { var contains = iterationFactory({
return collection == null 'args': 'collection,target',
? false 'top': 'var result=false',
: some(collection, function(value) { return value === target; }); 'inLoop': 'if(collection[index]===target)return true'
} });
/** /**
* Checks if the `callback` returns truthy for **all** values of a `collection`. * Checks if the `callback` returns truthy for **all** values of a `collection`.
@@ -270,14 +225,13 @@
* _.every([true, 1, null, 'yes'], Boolean); * _.every([true, 1, null, 'yes'], Boolean);
* => false * => false
*/ */
function every(collection, callback, thisArg) {
var result = true; var every = iterationFactory({
if (collection == null) return result; 'breaker': true,
forEach(collection, function(value, index, array) { 'top': 'var result=true',
if (!(result = result && callback.call(thisArg, value, index, array))) return breaker; 'inLoop': '!(result=result&&callback(collection[index],index,collection))&&breaker',
}); 'returns': '!!result'
return !!result; });
}
/** /**
* Examines each value in a `collection`, returning an array of all values the * Examines each value in a `collection`, returning an array of all values the
@@ -298,14 +252,10 @@
* var evens = _.filter([1, 2, 3, 4, 5, 6], function(num) { return num % 2 == 0; }); * var evens = _.filter([1, 2, 3, 4, 5, 6], function(num) { return num % 2 == 0; });
* // => [2, 4, 6] * // => [2, 4, 6]
*/ */
function filter(collection, callback, thisArg) { var filter = iterationFactory({
var result = []; 'top': 'var result=[]',
if (collection == null) return result; 'inLoop': 'callback(collection[index],index,collection)&&(result[result.length]=collection[index])'
forEach(collection, function(value, index, array) { });
if (callback.call(thisArg, value, index, array)) result[result.length] = value;
});
return result;
}
/** /**
* Examines each value in a `collection`, returning the first one the `callback` * Examines each value in a `collection`, returning the first one the `callback`
@@ -327,16 +277,10 @@
* var even = _.find([1, 2, 3, 4, 5, 6], function(num) { return num % 2 == 0; }); * var even = _.find([1, 2, 3, 4, 5, 6], function(num) { return num % 2 == 0; });
* // => 2 * // => 2
*/ */
function find(collection, callback, thisArg) { var find = iterationFactory({
var result; 'breaker': true,
some(collection, function(value, index, array) { 'inLoop': 'callback(collection[index],index,collection)?(result=collection[index],breaker):0'
if (callback.call(thisArg, value, index, array)) { });
result = value;
return true;
}
});
return result;
}
/** /**
* Iterates over a `collection`, executing the `callback` for each value in the * Iterates over a `collection`, executing the `callback` for each value in the
@@ -354,32 +298,17 @@
* @returns {Array|Object} Returns the `collection`. * @returns {Array|Object} Returns the `collection`.
* @example * @example
* *
* _.forforEach([1, 2, 3], function(num) { alert(num); }); * _.forEach([1, 2, 3], function(num) { alert(num); });
* // => alerts each number in turn... * // => alerts each number in turn...
* *
* _.forforEach({ 'one': 1, 'two': 2, 'three': 3}, function(num) { alert(num); }); * _.forEach({ 'one': 1, 'two': 2, 'three': 3}, function(num) { alert(num); });
* // => alerts each number in turn... * // => alerts each number in turn...
*/ */
function forEach(collection, callback, thisArg) { var forEach = iterationFactory({
if (collection != null) { 'breaker': true,
if (collection.length === +collection.length) { 'top': 'var result=collection',
for (var index = 0, length = collection.length; index < length; index++) { 'returns': 'collection'
if (index in collection && callback.call(thisArg, collection[index], index, collection) === breaker) { });
break;
}
}
} else {
for (var key in collection) {
if (hasOwnProperty.call(collection, key)) {
if (callback.call(thisArg, collection[key], key, collection) === breaker) {
break;
}
}
}
}
}
return collection;
}
/** /**
* Splits a `collection` into sets, grouped by the result of running each value * Splits a `collection` into sets, grouped by the result of running each value
@@ -463,17 +392,13 @@
* _.map({ 'one': 1, 'two': 2, 'three': 3 }, function(num) { return num * 3; }); * _.map({ 'one': 1, 'two': 2, 'three': 3 }, function(num) { return num * 3; });
* // => [3, 6, 9] * // => [3, 6, 9]
*/ */
function map(collection, callback, thisArg) { var map = iterationFactory({
var result = []; 'top': 'var result=[]',
if (collection == null) { 'inLoop': {
return result; 'array': 'result[index]=callback(collection[index],index,collection)',
'object': 'result[result.length]=callback(collection[index],index,collection)'
} }
forEach(collection, function(value, index, array) { });
result[result.length] = callback.call(thisArg, value, index, array);
});
if (collection.length === +collection.length) result.length = collection.length;
return result;
}
/** /**
* Retrieves the maximum value of a `collection`. If `callback` is passed, * Retrieves the maximum value of a `collection`. If `callback` is passed,
@@ -607,21 +532,11 @@
* var sum = _.reduce([1, 2, 3], function(memo, num) { return memo + num; }); * var sum = _.reduce([1, 2, 3], function(memo, num) { return memo + num; });
* // => 6 * // => 6
*/ */
function reduce(collection, callback, accumulator, thisArg) { var reduce = iterationFactory({
var initial = arguments.length > 2; 'args': 'collection,callback,result,thisArg',
if (thisArg) { 'top': 'var initial=arguments.length>2;',
callback = bind(callback, thisArg); 'inLoop': 'result=initial?callback(result,collection[index],index,collection):(initial=true,collection[index])'
} });
forEach(collection, function(value, index) {
if (!initial) {
accumulator = value;
initial = true;
} else {
accumulator = callback(accumulator, value, index, collection);
}
});
return accumulator;
}
/** /**
* The right-associative version of `_.reduce`. The `callback` is bound to the * The right-associative version of `_.reduce`. The `callback` is bound to the
@@ -644,12 +559,12 @@
* var flat = _.reduceRight(list, function(a, b) { return a.concat(b); }, []); * var flat = _.reduceRight(list, function(a, b) { return a.concat(b); }, []);
* // => [4, 5, 2, 3, 0, 1] * // => [4, 5, 2, 3, 0, 1]
*/ */
function reduceRight(collection, callback, accumulator, thisArg) { var reduceRight = iterationFactory({
var initial = arguments.length > 2, 'args': 'collection,callback,result,thisArg',
reversed = toArray(collection).reverse(); 'top': 'var initial=arguments.length>2;',
'while': 'length--',
return initial ? reduce(reversed, callback, accumulator, thisArg) : reduce(reversed, callback); 'inLoop': 'result=initial?callback(result,collection[length],length,collection):(initial=true,collection[length])'
} });
/** /**
* The opposite of `_.filter`, this method returns the values of a `collection` * The opposite of `_.filter`, this method returns the values of a `collection`
@@ -669,14 +584,10 @@
* var odds = _.reject([1, 2, 3, 4, 5, 6], function(num) { return num % 2 == 0; }); * var odds = _.reject([1, 2, 3, 4, 5, 6], function(num) { return num % 2 == 0; });
* // => [1, 3, 5] * // => [1, 3, 5]
*/ */
function reject(collection, callback, thisArg) { var reject = iterationFactory({
var result = []; 'top': 'var result=[]',
if (collection == null) return result; 'inLoop': '!callback(collection[index],index,collection)&&(result[result.length]=collection[index])'
forEach(collection, function(value, index, array) { });
if (!callback.call(thisArg, value, index, array)) result[result.length] = value;
});
return result;
}
/** /**
* Produces a new array of shuffled `collection` values, using a version of the * Produces a new array of shuffled `collection` values, using a version of the
@@ -787,19 +698,12 @@
* _.some([null, 0, 'yes', false]); * _.some([null, 0, 'yes', false]);
* // => true * // => true
*/ */
function some(collection, callback, thisArg) { var some = iterationFactory({
var result = false; 'breaker': true,
if (!callback) { 'top': 'var result=false',
callback = identity; 'inLoop': '(result||(result=callback(collection[index],index,collection)))&&breaker',
} else if (thisArg) { 'returns': '!!result'
callback = bind(callback, thisArg); });
}
if (collection == null) return result;
forEach(collection, function(value, index, array) {
if (result || (result = callback.call(thisArg, value, index, array))) return breaker;
});
return !!result;
}
/** /**
* Uses a binary search to determine the index at which the `value` should be * Uses a binary search to determine the index at which the `value` should be
@@ -911,10 +815,10 @@
* @category Arrays * @category Arrays
* @param {Array} array The array to query. * @param {Array} array The array to query.
* @param {Number} [n] The number of elements to return. * @param {Number} [n] The number of elements to return.
* @param {Object} [guard] Used to allow the function to work with other iteration * @param {Object} [guard] Allows this method to work with others like `_.map`
* methods like `_.map` without using their callback `index` argument for `n`. * without using their callback `index` argument for `n`.
* @returns {Mixed} Returns the first value or an array of the first `n` * @returns {Mixed} Returns the first value or an array of the first `n` values
* values of the `array`. * of the `array`.
* @example * @example
* *
* _.first([5, 4, 3, 2, 1]); * _.first([5, 4, 3, 2, 1]);
@@ -999,8 +903,8 @@
* @category Arrays * @category Arrays
* @param {Array} array The array to query. * @param {Array} array The array to query.
* @param {Number} [n] The number of elements to return. * @param {Number} [n] The number of elements to return.
* @param {Object} [guard] Used to allow the function to work with other iteration * @param {Object} [guard] Allows this method to work with others like `_.map`
* methods like `_.map` without using their callback `index` argument for `n`. * without using their callback `index` argument for `n`.
* @returns {Array} Returns all but the last value or `n` values of the `array`. * @returns {Array} Returns all but the last value or `n` values of the `array`.
* @example * @example
* *
@@ -1044,8 +948,8 @@
* @category Arrays * @category Arrays
* @param {Array} array The array to query. * @param {Array} array The array to query.
* @param {Number} [n] The number of elements to return. * @param {Number} [n] The number of elements to return.
* @param {Object} [guard] Used to allow the function to work with other iteration * @param {Object} [guard] Allows this method to work with others like `_.map`
* methods like `_.map` without using their callback `index` argument for `n`. * without using their callback `index` argument for `n`.
* @returns {Array} Returns all but the last value or `n` values of the `array`. * @returns {Array} Returns all but the last value or `n` values of the `array`.
* @example * @example
* *
@@ -1142,16 +1046,16 @@
* @category Arrays * @category Arrays
* @param {Array} array The array to query. * @param {Array} array The array to query.
* @param {Number} [n] The number of elements to return. * @param {Number} [n] The number of elements to return.
* @param {Object} [guard] Used to allow the function to work with other iteration * @param {Object} [guard] Allows this method to work with others like `_.map`
* methods like `_.map` without using their callback `index` argument for `n`. * without using their callback `index` argument for `n`.
* @returns {Array} Returns all but the first value or `n` values of the `array`. * @returns {Array} Returns all but the first value or `n` values of the `array`.
* @example * @example
* *
* _.rest([5, 4, 3, 2, 1]); * _.rest([5, 4, 3, 2, 1]);
* // => [4, 3, 2, 1] * // => [4, 3, 2, 1]
*/ */
function rest(array, index, guard) { function rest(array, n, guard) {
return slice.call(array, (index == null || guard) ? 1 : index); return slice.call(array, (n == null || guard) ? 1 : n);
} }
/** /**
@@ -1344,13 +1248,16 @@
* // => When the button is clicked, `this.label` will have the correct value * // => When the button is clicked, `this.label` will have the correct value
*/ */
function bindAll(object) { function bindAll(object) {
var funcs = slice.call(arguments, 1); var funcs = arguments,
if (!funcs.length) { start = 1;
if (funcs.length == 1) {
start = 0;
funcs = functions(object); funcs = functions(object);
} }
forEach(funcs, function(methodName) { _each(funcs, function(methodName) {
object[methodName] = bind(object[methodName], object); object[methodName] = bind(object[methodName], object);
}); }, start);
return object; return object;
} }
@@ -1636,11 +1543,11 @@
* // => { 'flavor': 'chocolate', 'sprinkles': 'lots' } * // => { 'flavor': 'chocolate', 'sprinkles': 'lots' }
*/ */
function defaults(object) { function defaults(object) {
forEach(slice.call(arguments, 1), function(source) { _each(arguments, function(source) {
for (var prop in source) { for (var prop in source) {
if (object[prop] == null) object[prop] = source[prop]; if (object[prop] == null) object[prop] = source[prop];
} }
}); }, 1);
return object; return object;
} }
@@ -1660,11 +1567,11 @@
* // => { 'name': 'moe', 'age': 40 } * // => { 'name': 'moe', 'age': 40 }
*/ */
function extend(destination) { function extend(destination) {
forEach(slice.call(arguments, 1), function(source) { _each(arguments, function(source) {
for (var prop in source) { for (var prop in source) {
destination[prop] = source[prop]; destination[prop] = source[prop];
} }
}); }, 1);
return destination; return destination;
} }
@@ -1824,7 +1731,7 @@
return true; return true;
} }
if (isArray(value) || isString(value)) { if (isArray(value) || isString(value)) {
return value.length === 0; return !value.length;
} }
for (var key in value) { for (var key in value) {
if (hasOwnProperty.call(value, key)) { if (hasOwnProperty.call(value, key)) {
@@ -1841,8 +1748,8 @@
* @static * @static
* @memberOf _ * @memberOf _
* @category Objects * @category Objects
* @param {Mixed} value The value to compare. * @param {Mixed} a The value to compare.
* @param {Mixed} other The other value to compare. * @param {Mixed} b The other value to compare.
* @returns {Boolean} Returns `true` if the values are equvalent, else `false`. * @returns {Boolean} Returns `true` if the values are equvalent, else `false`.
* @example * @example
* *
@@ -1855,8 +1762,128 @@
* _.isEqual(moe, clone); * _.isEqual(moe, clone);
* // => true * // => true
*/ */
function isEqual(value, other) { function isEqual(a, b, stack) {
return eq(value, other, []); stack || (stack = []);
// exit early for identical values
if (a === b) {
// treat `+0` vs. `-0` as not equal
return a !== 0 || (1 / a == 1 / b);
}
// a strict comparison is necessary because `null == undefined`
if (a == null || b == null) {
return a === b;
}
// unwrap any wrapped objects
if (a._chain) {
a = a._wrapped;
}
if (b._chain) {
b = b._wrapped;
}
// invoke a custom `isEqual` method if one is provided
if (a.isEqual && isFunction(a.isEqual)) {
return a.isEqual(b);
}
if (b.isEqual && isFunction(b.isEqual)) {
return b.isEqual(a);
}
// compare `[[Class]]` names
var className = toString.call(a);
if (className != toString.call(b)) {
return false;
}
switch (className) {
// strings, numbers, dates, and booleans are compared by value
case '[object String]':
// primitives and their corresponding object instances are equivalent;
// thus, `'5'` is quivalent to `new String('5')`
return a == String(b);
case '[object Number]':
// treat `NaN` vs. `NaN` as equal
return a != +a
? b != +b
// but treat `+0` vs. `-0` as not equal
: (a == 0 ? (1 / a == 1 / b) : a == +b);
case '[object Date]':
case '[object Boolean]':
// coerce dates and booleans to numeric values, dates to milliseconds and booleans to 1 or 0;
// treat invalid dates coerced to `NaN` as not equal
return +a == +b;
// regexps are compared by their source and flags
case '[object RegExp]':
return a.source == b.source &&
a.global == b.global &&
a.multiline == b.multiline &&
a.ignoreCase == b.ignoreCase;
}
if (typeof a != 'object' || typeof b != 'object') {
return false;
}
// Assume equality for cyclic structures. The algorithm for detecting cyclic
// structures is adapted from ES 5.1 section 15.12.3, abstract operation `JO`.
var length = stack.length;
while (length--) {
// Linear search. Performance is inversely proportional to the number of
// unique nested structures.
if (stack[length] == a) {
return true;
}
}
var result = true,
size = 0;
// add the first collection to the stack of traversed objects
stack.push(a);
// recursively compare objects and arrays
if (className == '[object Array]') {
// compare array lengths to determine if a deep comparison is necessary
size = a.length;
result = size == b.length;
if (result) {
// deep compare the contents, ignoring non-numeric properties
while (size--) {
// ensure commutative equality for sparse arrays
if (!(result = size in a == size in b && isEqual(a[size], b[size], stack))) {
break;
}
}
}
} else {
// objects with different constructors are not equivalent
if ('constructor' in a != 'constructor' in b || a.constructor != b.constructor) {
return false;
}
// deep compare objects
for (var key in a) {
if (hasOwnProperty.call(a, key)) {
// count the expected number of properties
size++;
// deep compare each member
if (!(result = hasOwnProperty.call(b, key) && isEqual(a[key], b[key], stack))) {
break;
}
}
}
// ensure that both objects contain the same number of properties
if (result) {
for (key in b) {
if (hasOwnProperty.call(b, key) && !(size--)) {
break;
}
}
result = !size;
}
}
// remove the first collection from the stack of traversed objects
stack.pop();
return result;
} }
/** /**
@@ -1879,7 +1906,7 @@
* // => false * // => false
*/ */
function isFinite(value) { function isFinite(value) {
return isNumber(value) && nativeIsFinite(value); return nativeIsFinite(value) && toString.call(value) == '[object Number]';
} }
/** /**
@@ -1934,6 +1961,9 @@
* _.isNaN(NaN); * _.isNaN(NaN);
* // => true * // => true
* *
* _.isNaN(new Number(NaN));
* // => true
*
* isNaN(undefined); * isNaN(undefined);
* // => true * // => true
* *
@@ -1941,8 +1971,8 @@
* // => false * // => false
*/ */
function isNaN(value) { function isNaN(value) {
// `NaN` is the only value for which `===` is not reflexive. // `NaN` as a primitive is the only value that is not equal to itself
return value !== value; return toString.call(value) == '[object Number]' && value != +value;
} }
/** /**
@@ -2030,7 +2060,7 @@
* // => true * // => true
*/ */
function isUndefined(value) { function isUndefined(value) {
return value === void 0; return value === undefined;
} }
/** /**
@@ -2193,7 +2223,7 @@
* // => 'Larry' * // => 'Larry'
*/ */
function mixin(object) { function mixin(object) {
forEach(functions(object), function(methodName) { _each(functions(object), function(methodName) {
var func = lodash[methodName] = object[methodName]; var func = lodash[methodName] = object[methodName];
lodash.prototype[methodName] = function() { lodash.prototype[methodName] = function() {
@@ -2602,16 +2632,17 @@
/*--------------------------------------------------------------------------*/ /*--------------------------------------------------------------------------*/
// Expose `wrapper.prototype` as `_.prototype` // Hookup private Wrapper's prototype
lodash.prototype = Wrapper.prototype; Wrapper.prototype = lodash.prototype;
// Add all of the Lo-Dash functions to the wrapper collection. // Add all of the Lo-Dash functions to the wrapper collection.
lodash.mixin(lodash); lodash.mixin(lodash);
// Add all mutator Array functions to the wrapper. // Add all mutator Array functions to the wrapper.
forEach(['pop', 'push', 'reverse', 'shift', 'sort', 'splice', 'unshift'], function(methodName) { _each(['pop', 'push', 'reverse', 'shift', 'sort', 'splice', 'unshift'], function(methodName) {
var func = ArrayProto[methodName]; var func = ArrayProto[methodName];
Wrapper.prototype[methodName] = function() {
lodash.prototype[methodName] = function() {
var wrapped = this._wrapped; var wrapped = this._wrapped;
func.apply(wrapped, arguments); func.apply(wrapped, arguments);
@@ -2620,8 +2651,7 @@
// array-like-objects even though the `length` property is set to `0`. // array-like-objects even though the `length` property is set to `0`.
// The `shift()` method is buggy in IE 8 compatibility mode, while `splice()` // The `shift()` method is buggy in IE 8 compatibility mode, while `splice()`
// is buggy regardless of mode in IE < 9 and buggy in compatibility mode in IE 9. // is buggy regardless of mode in IE < 9 and buggy in compatibility mode in IE 9.
var length = wrapped.length; if (wrapped.length === 0) {
if (length === 0) {
delete wrapped[0]; delete wrapped[0];
} }
return this._chain ? lodash(wrapped).chain() : wrapped; return this._chain ? lodash(wrapped).chain() : wrapped;
@@ -2629,7 +2659,7 @@
}); });
// Add all accessor Array functions to the wrapper. // Add all accessor Array functions to the wrapper.
forEach(['concat', 'join', 'slice'], function(methodName) { _each(['concat', 'join', 'slice'], function(methodName) {
var func = ArrayProto[methodName]; var func = ArrayProto[methodName];
lodash.prototype[methodName] = function() { lodash.prototype[methodName] = function() {
var result = func.apply(this._wrapped, arguments); var result = func.apply(this._wrapped, arguments);