lodash/README.md

Lo-Dash v1.3.1

A utility library delivering consistency, customization, performance, & extras.

Download

• Modern builds: Development & Production

• Compatibility builds: Development & Production

• Underscore builds: Development & Production

CDN copies are available on cdnjs & jsDelivr.
For smaller file sizes, create custom builds with only the features needed.

Dive in

There’s plenty of documentation, unit tests, & benchmarks.

For a list of upcoming features, check out our roadmap.

Features not in Underscore

• AMD loader support (curl, dojo, requirejs, etc.)
• _(…) supports intuitive chaining
• _.at for cherry-picking collection values
• _.bindKey for binding “lazy” defined methods
• _.cloneDeep for deep cloning arrays & objects
• _.contains accepts a fromIndex
• _.createCallback for extending callbacks in methods & mixins
• _.debounce & _.throttle accept options for more control
• _.findIndex & _.findKey for finding indexes & keys
• _.forEach is chainable & supports exiting early
• _.forIn for iterating own & inherited properties
• _.forOwn for iterating own properties
• _.isPlainObject for checking if values are created by Object
• _.memoize exposes the cache of memoized functions
• _.merge for a deep _.extend
• _.parseInt for consistent behavior
• _.partialRight for partial application from the right
• _.runInContext for easier mocking
• _.support for flagging environment features
• _.template supports “imports” options & ES6 template delimiters
• _.transform as a powerful alternative to _.reduce for transforming objects
• _.unzip as the inverse of _.zip
• _.where supports deep object comparisons
• _.omit, _.pick, & more accept callbacks
• _.contains, _.toArray, & more accept strings
• _.filter, _.map, & more support “_.pluck” & “_.where” shorthands

Resources

• Posts

• Say “Hello” to Lo-Dash

• Videos

• Introduction
• Origins
• Optimizations & builds
• Native method use
• Testing
• CascadiaJS ’12

Support

Tested in Chrome 528, Firefox 222, IE 6-10, Opera 9.25~15, Safari 3-6, Node.js 0.4.8-0.10.15, Narwhal 0.3.2, PhantomJS 1.9.1, RingoJS 0.9, & Rhino 1.7RC5.

Installation & usage

In browsers:

<script src="lodash.js"></script>

Using npm:

npm install lodash

npm install -g lodash
npm link lodash

In Node.js & Ringo:

var _ = require('lodash');
// or as an Underscore replacement
var _ = require('lodash/dist/lodash.underscore');

Notes:

• Don’t assign values to special variable _ when in the REPL
• If Lo-Dash is installed globally, run npm link lodash in your project’s root directory before requiring it
• Node.js 0.10.8-0.10.11 have bugs preventing minified builds

In Rhino:

load('lodash.js');

In an AMD loader:

require({
  'paths': { 'underscore': 'path/to/lodash' }
},
['underscore'], function(_) {
  console.log(_.VERSION);
});

Release Notes

^v1.3.1

• Added missing cache property to the objects returned by getObject
• Ensured maxWait unit tests pass in Ringo
• Increased the maxPoolSize value
• Optimized releaseArray & releaseObject

The full changelog is available here.

BestieJS

Lo-Dash is part of the BestieJS “Best in Class” module collection. This means we promote solid environment support, ES5+ precedents, unit testing, & plenty of documentation.

Author

John-David Dalton

Contributors

Kit Cambridge	Mathias Bynens