A drop-in replacement* for Underscore.js, from the devs behind jsPerf.com, delivering performance, bug fixes, and additional features.
Lo-Dash’s performance is gained by avoiding slower native methods, instead opting for simplified non-ES5 compliant methods optimized for common usage, and by leveraging function compilation to reduce the number of overall function calls.
- Development build
- Production build
- Underscore build tailored for projects already using Underscore
- CDN copies of ≤ v0.9.1’s Production, Underscore, and Development builds are available on cdnjs thanks to CloudFlare
- For optimal file size, create a custom build with only the features you need
We’ve got API docs, benchmarks, and unit tests.
Create your own benchmarks at jsPerf, or search for existing ones.
For a list of upcoming features, check out our roadmap.
For more information check out these screencasts over Lo-Dash:
- Introducing Lo-Dash
- Lo-Dash optimizations and custom builds
- Lo-Dash’s origin and why it’s a better utility belt
- Unit testing in Lo-Dash
- Lo-Dash’s approach to native method use
- AMD loader support (RequireJS, curl.js, etc.)
- _.clone supports “deep” cloning
- _.forEach is chainable and supports exiting iteration early
- _.forIn for iterating over an object’s own and inherited properties
- _.forOwn for iterating over an object’s own properties
- _.isPlainObject checks if values are created by the
Objectconstructor - _.lateBind for late binding
- _.merge for a “deep” _.extend
- _.partial for partial application without
thisbinding - _.pick and _.omit accept
callbackandthisArgarguments - _.template utilizes sourceURLs for easier debugging
- _.contains, _.size, _.toArray, and more… accept strings
Lo-Dash has been tested in at least Chrome 522, Firefox 116, IE 6-10, Opera 9.25-12, Safari 3-6, Node.js 0.4.8-0.8.14, Narwhal 0.3.2, RingoJS 0.8, and Rhino 1.7RC5.
Custom builds make it easy to create lightweight versions of Lo-Dash containing only the methods you need. To top it off, we handle all method dependency and alias mapping for you.
- Backbone builds, with only methods required by Backbone, may be created using the
backbonemodifier argument.
lodash backbone- CSP builds, supporting default Content Security Policy restrictions, may be created using the
cspmodifier argument.
lodash csp- Legacy builds, tailored for older browsers without ES5 support, may be created using the
legacymodifier argument.
lodash legacy- Mobile builds, with IE < 9 bug fixes and method compilation removed, may be created using the
mobilemodifier argument.
lodash mobile- Strict builds, with
_.bindAll,_.defaults, and_.extendin strict mode, may be created using thestrictmodifier argument.
lodash strict- Underscore builds, tailored for projects already using Underscore, may be created using the
underscoremodifier argument.
lodash underscoreCustom builds may be created using the following commands:
- Use the
categoryargument to pass comma separated categories of methods to include in the build.
Valid categories (case-insensitive) are “arrays”, “chaining”, “collections”, “functions”, “objects”, and “utilities”.
lodash category=collections,functions
lodash category="collections, functions"- Use the
exportsargument to pass comma separated names of ways to export theLoDashfunction.
Valid exports are “amd”, “commonjs”, “global”, “node”, and “none”.
lodash exports=amd,commonjs,node
lodash exports="amd, commonjs, node"- Use the
iifeargument to specify code to replace the immediately-invoked function expression that wraps Lo-Dash.
lodash iife="!function(window,undefined){%output%}(this)"- Use the
includeargument to pass comma separated method/category names to include in the build.
lodash include=each,filter,map
lodash include="each, filter, map"- Use the
minusargument to pass comma separated method/category names to remove from those included in the build.
lodash underscore minus=result,shuffle
lodash underscore minus="result, shuffle"- Use the
plusargument to pass comma separated method/category names to add to those included in the build.
lodash backbone plus=random,template
lodash backbone plus="random, template"- Use the
templateargument to pass the file path pattern used to match template files to precompile
lodash template="./*.jst"- Use the
settingsargument to pass the template settings used when precompiling templates
lodash settings="{interpolate:/\\{\\{([\\s\\S]+?)\\}\\}/g}"All arguments, except legacy with csp or mobile, may be combined.
Unless specified by -o or --output, all files created are saved to the current working directory.
The following options are also supported:
-c,--stdoutWrite output to standard output-d,--debugWrite only the debug output-h,--helpDisplay help information-m,--minifyWrite only the minified output-o,--outputWrite output to a given path/filename-s,--silentSkip status updates normally logged to the console-V,--versionOutput current version of Lo-Dash
The lodash command-line utility is available when Lo-Dash is installed as a global package (i.e. npm install -g lodash).
In browsers:
<script src="lodash.js"></script>Using npm:
npm install lodash
npm install -g lodash
npm link lodashIn Node.js and RingoJS v0.8.0+:
var _ = require('lodash');Note: If Lo-Dash is installed globally, run npm link lodash in your project’s root directory before requiring it.
In RingoJS v0.7.0-:
var _ = require('lodash')._;In Rhino:
load('lodash.js');In an AMD loader like RequireJS:
require({
'paths': {
'underscore': 'path/to/lodash'
}
},
['underscore'], function(_) {
console.log(_.VERSION);
});- Allow iteration of objects with a
lengthproperty [#799, test] - Fix cross-browser object iteration bugs [#60, #376, test]
- Methods should work on pages with incorrectly shimmed native methods [#7, #742, test]
_.isEmptyshould support jQuery/MooTools DOM query collections [#690, test]_.isObjectshould avoid V8 bug #2291 [#605, test]_.keysshould work withargumentsobjects cross-browser [#396, test]_.rangeshould coerce arguments to numbers [#634, #683, test]
- Ensured
_.everyreturnsfalseas soon as thecallbackresult is falsey - Ensured
_.isFinitereturnsfalsefor non-numeric values - Removed
_.forEachchainability in theunderscorebuild - Simplified
_.union
The full changelog is available here.
Lo-Dash is part of the BestieJS “Best in Class” module collection. This means we promote solid browser/environment support, ES5 precedents, unit testing, and plenty of documentation.
