mirror of
https://github.com/whoisclebs/lodash.git
synced 2026-02-01 07:47:49 +00:00
196 lines
10 KiB
Markdown
196 lines
10 KiB
Markdown
# Lo-Dash v2.0.0
|
||
A utility library delivering consistency, [customization](http://lodash.com/custom-builds), [performance](http://lodash.com/benchmarks), & [extras](http://lodash.com/#features).
|
||
|
||
## Download
|
||
|
||
* Modern builds:
|
||
[Development](https://raw.github.com/lodash/lodash/2.0.0/dist/lodash.js) &
|
||
[Production](https://raw.github.com/lodash/lodash/2.0.0/dist/lodash.min.js)
|
||
|
||
* Compatibility builds:
|
||
[Development](https://raw.github.com/lodash/lodash/2.0.0/dist/lodash.compat.js) &
|
||
[Production](https://raw.github.com/lodash/lodash/2.0.0/dist/lodash.compat.min.js)
|
||
|
||
* Underscore builds:
|
||
[Development](https://raw.github.com/lodash/lodash/2.0.0/dist/lodash.underscore.js) &
|
||
[Production](https://raw.github.com/lodash/lodash/2.0.0/dist/lodash.underscore.min.js)
|
||
|
||
Love modules? We’ve got you covered with [lodash-amd](https://npmjs.org/package/lodash-amd), [lodash-node](https://npmjs.org/package/lodash-node), and [npm packages](https://npmjs.org/~jdalton) per method.
|
||
|
||
CDN copies are available on [cdnjs](http://cdnjs.com/) & [jsDelivr](http://www.jsdelivr.com/#!lodash).<br>
|
||
For smaller file sizes, create [custom builds](http://lodash.com/custom-builds) with only the features needed.
|
||
|
||
## Dive in
|
||
|
||
There’s plenty of [documentation](http://lodash.com/docs), [unit tests](http://lodash.com/tests), & [benchmarks](http://lodash.com/benchmarks).
|
||
|
||
For a list of upcoming features, check out our [roadmap](https://github.com/lodash/lodash/wiki/Roadmap).
|
||
|
||
## Features *not* in Underscore
|
||
|
||
* AMD loader support ([curl](https://github.com/cujojs/curl), [dojo](http://dojotoolkit.org/), [requirejs](http://requirejs.org/), etc.)
|
||
* [_(…)](http://lodash.com/docs#_) supports intuitive chaining
|
||
* [_.at](http://lodash.com/docs#at) for cherry-picking collection values
|
||
* [_.bindKey](http://lodash.com/docs#bindKey) for binding [*“lazy”*](http://michaux.ca/articles/lazy-function-definition-pattern) defined methods
|
||
* [_.cloneDeep](http://lodash.com/docs#cloneDeep) for deep cloning arrays & objects
|
||
* [_.contains](http://lodash.com/docs#contains) accepts a `fromIndex`
|
||
* [_.createCallback](http://lodash.com/docs#createCallback) for extending callbacks in methods & mixins
|
||
* [_.curry](http://lodash.com/docs#curry) for creating [curried](http://hughfdjackson.com/javascript/2013/07/06/why-curry-helps/) functions
|
||
* [_.debounce](http://lodash.com/docs#debounce) & [_.throttle](http://lodash.com/docs#throttle) accept `options` for more control
|
||
* [_.findIndex](http://lodash.com/docs#findIndex) & [_.findKey](http://lodash.com/docs#findKey) for finding indexes & keys
|
||
* [_.forEach](http://lodash.com/docs#forEach) is chainable & supports exiting early
|
||
* [_.forIn](http://lodash.com/docs#forIn) for iterating own & inherited properties
|
||
* [_.forOwn](http://lodash.com/docs#forOwn) for iterating own properties
|
||
* [_.isPlainObject](http://lodash.com/docs#isPlainObject) for checking if values are created by `Object`
|
||
* [_.memoize](http://lodash.com/docs#memoize) exposes the `cache` of memoized functions
|
||
* [_.merge](http://lodash.com/docs#merge) for a deep [_.extend](http://lodash.com/docs#extend)
|
||
* [_.parseInt](http://lodash.com/docs#parseInt) for consistent behavior
|
||
* [_.partialRight](http://lodash.com/docs#partialRight) for [partial application](http://lodash.com/docs#partial) from the right
|
||
* [_.pull](http://lodash.com/docs#pull) and [_.remove](http://lodash.com/docs#remove) for mutating arrays
|
||
* [_.runInContext](http://lodash.com/docs#runInContext) for easier mocking
|
||
* [_.support](http://lodash.com/docs#support) for flagging environment features
|
||
* [_.template](http://lodash.com/docs#template) supports [*“imports”*](http://lodash.com/docs#templateSettings_imports) options & [ES6 template delimiters](http://people.mozilla.org/~jorendorff/es6-draft.html#sec-7.8.6)
|
||
* [_.transform](http://lodash.com/docs#transform) as a powerful alternative to [_.reduce](http://lodash.com/docs#reduce) for transforming objects
|
||
* [_.where](http://lodash.com/docs#where) supports deep object comparisons
|
||
* [_.zip](http://lodash.com/docs#zip) is capable of unzipping values
|
||
* [_.omit](http://lodash.com/docs#omit), [_.pick](http://lodash.com/docs#pick), &
|
||
[more](http://lodash.com/docs "_.assign, _.clone, _.cloneDeep, _.first, _.initial, _.isEqual, _.last, _.merge, _.rest") accept callbacks
|
||
* [_.contains](http://lodash.com/docs#contains), [_.toArray](http://lodash.com/docs#toArray), &
|
||
[more](http://lodash.com/docs "_.at, _.countBy, _.every, _.filter, _.find, _.forEach, _.forEachRight, _.groupBy, _.invoke, _.map, _.max, _.min, _.pluck, _.reduce, _.reduceRight, _.reject, _.shuffle, _.size, _.some, _.sortBy, _.where") accept strings
|
||
* [_.filter](http://lodash.com/docs#filter), [_.map](http://lodash.com/docs#map), &
|
||
[more](http://lodash.com/docs "_.countBy, _.every, _.find, _.findKey, _.findLast, _.findLastIndex, _.findLastKey, _.first, _.groupBy, _.initial, _.last, _.max, _.min, _.reject, _.rest, _.some, _.sortBy, _.sortedIndex, _.uniq") support *“_.pluck”* & *“_.where”* shorthands
|
||
* [_.findLast](http://lodash.com/docs#findLast), [_.findLastIndex](http://lodash.com/docs#findLastIndex), & [more](http://lodash.com/docs "_.findLastKey, _.forEachRight, _.forInRight, _.forOwnRight") right-associative methods
|
||
|
||
## Resources
|
||
|
||
* Posts
|
||
- [Say “Hello” to Lo-Dash](http://kitcambridge.be/blog/say-hello-to-lo-dash/)
|
||
- [Custom builds in Lo-Dash 2.0](http://kitcambridge.be/blog/custom-builds-in-lo-dash-2-dot-0/)
|
||
|
||
* Videos
|
||
- [Introduction](https://vimeo.com/44154599)
|
||
- [Origins](https://vimeo.com/44154600)
|
||
- [Optimizations & builds](https://vimeo.com/44154601)
|
||
- [Native method use](https://vimeo.com/48576012)
|
||
- [Testing](https://vimeo.com/45865290)
|
||
- [CascadiaJS ’12](http://www.youtube.com/watch?v=dpPy4f_SeEk)
|
||
|
||
## Support
|
||
|
||
Tested in Chrome 5~29, Firefox 2~23, IE 6-10, Opera 9.25~15, Safari 3-6, Node.js 0.6.8-0.10.18, Narwhal 0.3.2, PhantomJS 1.9.1, RingoJS 0.9, & Rhino 1.7RC5.
|
||
|
||
## Installation & usage
|
||
|
||
In browsers:
|
||
|
||
```html
|
||
<script src="lodash.js"></script>
|
||
```
|
||
|
||
Using [`npm`](http://npmjs.org/):
|
||
|
||
```bash
|
||
npm i lodash
|
||
|
||
{sudo} npm i -g lodash
|
||
npm link lodash
|
||
```
|
||
|
||
In [Node.js](http://nodejs.org/) & [Ringo](http://ringojs.org/):
|
||
|
||
```js
|
||
var _ = require('lodash');
|
||
// or as Underscore
|
||
var _ = require('lodash/dist/lodash.underscore');
|
||
```
|
||
|
||
**Notes:**
|
||
* Don’t assign values to [special variable](http://nodejs.org/api/repl.html#repl_repl_features) `_` when in the REPL
|
||
* If Lo-Dash is installed globally, run [`npm link lodash`](http://blog.nodejs.org/2011/03/23/npm-1-0-global-vs-local-installation/) in your project’s root directory *before* requiring it
|
||
* Node.js 0.10.8-0.10.11 [have](https://github.com/joyent/node/issues/5622) [bugs](https://github.com/joyent/node/issues/5688) preventing minified builds
|
||
|
||
In [Rhino](http://www.mozilla.org/rhino/):
|
||
|
||
```js
|
||
load('lodash.js');
|
||
```
|
||
|
||
In an AMD loader:
|
||
|
||
```js
|
||
require({
|
||
'packages': [
|
||
{ 'name': 'lodash', 'location': 'path/to/lodash', 'main': 'lodash' }
|
||
]
|
||
},
|
||
['lodash'], function(_) {
|
||
console.log(_.VERSION);
|
||
});
|
||
```
|
||
|
||
## Release Notes
|
||
|
||
### <sup>v2.0.0</sup>
|
||
|
||
#### Compatibility Warnings
|
||
|
||
* Aligned `_.after` with Underscore 1.5.0, making it always return a function
|
||
|
||
#### Noteable Changes
|
||
|
||
* Created Lo-Dash methods as `npm` packages & AMD/Node.js modules
|
||
* Made `_.chain` force chaining for all methods, even those that normally return unwrapped values
|
||
* Moved the build utility to [lodash-cli](https://npmjs.org/package/lodash-cli)
|
||
* Optimized `_.contains`, `_.debounce`, `_.isArguments`, `_.throttle`, `_.where`,<br>
|
||
& functions created by `_.bind`, `_.bindKey`, `_.curry`, `_.partial`, & `_.partialRight`
|
||
* Added [`_.curry`](http://lodash.com/docs#curry), [`_.forEachRight`](http://lodash.com/docs#forEachRight),
|
||
[`_.indexBy`](http://lodash.com/docs#indexBy), [`_.findLast`](http://lodash.com/docs#findLast),
|
||
[`_.findLastIndex`](http://lodash.com/docs#findLastIndex),<br>
|
||
[`_.findLastKey`](http://lodash.com/docs#findLastKey), [`_.forInRight`](http://lodash.com/docs#forInRight),
|
||
[`_.forOwnRight`](http://lodash.com/docs#forOwnRight), [`_.pull`](http://lodash.com/docs#pull),
|
||
[`_.remove`](http://lodash.com/docs#remove), & [`_.sample`](http://lodash.com/docs#sample)
|
||
|
||
#### Other Changes
|
||
|
||
* Added Curl & Dojo module loaders to the unit tests
|
||
* Added the `modularize` build option
|
||
* Added support for the `iife` command to be used without an `%output%` token
|
||
* Added support for `_.mixin` to accept a destination object
|
||
* Added support for `_.range` to accept a `step` of `0`
|
||
* Added `_.eachRight` as an alias for `_.forEachRight`
|
||
* Ensured *“Arrays”* methods support `arguments` objects
|
||
* Ensured *“Functions”* methods throw when not passed functions
|
||
* Ensured `_.at` works as a `callback` for `_.map`
|
||
* Ensured `_.createCallback` works when no `argCount` is specified
|
||
* Ensured `_.first` & `_.last` return arrays when passed a falsey `array` with an `n` value
|
||
* Ensured `_.flatten` works with `arguments` objects
|
||
* Ensured minified files work with Dojo’s builder
|
||
* Ensured `_.zipObject` skips falsey elements
|
||
* Improved dead code removal from builds
|
||
* Improved JSDoc syntax
|
||
* Made `_.memoize` avoid prefixing `cache` keys when using a `resolver` function
|
||
* Made `_.unzip` an alias of `_.zip`
|
||
* Removed local `clearTimeout` & `setTimeout` variables from the `underscore` build
|
||
* Reduced the size of the repo & `npm` package
|
||
* Simplified the bailout in `createCache`
|
||
* Updated sourceURL & sourceMappingURL syntax
|
||
* Updated `underscore` build compatibility to v1.5.2
|
||
|
||
The full changelog is available [here](https://github.com/lodash/lodash/wiki/Changelog).
|
||
|
||
## BestieJS
|
||
|
||
Lo-Dash is part of the [BestieJS](https://github.com/bestiejs) *“Best in Class”* module collection. This means it promotes solid environment support, ES5+ precedents, unit testing, & plenty of documentation.
|
||
|
||
## Author
|
||
|
||
| [](http://twitter.com/jdalton "Follow @jdalton on Twitter") |
|
||
|---|
|
||
| [John-David Dalton](http://allyoucanleet.com/) |
|
||
|
||
## Contributors
|
||
|
||
| [](http://twitter.com/blainebublitz "Follow @BlaineBublitz on Twitter") | [](https://twitter.com/kitcambridge "Follow @kitcambridge on Twitter") | [](http://twitter.com/mathias "Follow @mathias on Twitter") |
|
||
|---|---|---|
|
||
| [Blaine Bublitz](http://iceddev.com/) | [Kit Cambridge](http://kitcambridge.github.io/) | [Mathias Bynens](http://mathiasbynens.be/) |
|