UNPKG

8.91 kBMarkdownView Raw
1# lodash v3.5.0
2
3The [modern build](https://github.com/lodash/lodash/wiki/Build-Differences) of [lodash](https://lodash.com/) exported as [Node.js](http://nodejs.org/)/[io.js](https://iojs.org/) modules.
4
5Generated using [lodash-cli](https://www.npmjs.com/package/lodash-cli):
6```bash
7$ lodash modularize modern exports=node -o ./
8$ lodash modern -d -o ./index.js
9```
10
11## Installation
12
13Using npm:
14
15```bash
16$ {sudo -H} npm i -g npm
17$ npm i --save lodash
18```
19
20In Node.js/io.js:
21
22```js
23// load the modern build
24var _ = require('lodash');
25// or a method category
26var array = require('lodash/array');
27// or a method (great for smaller builds with browserify/webpack)
28var chunk = require('lodash/array/chunk');
29```
30
31See the [package source](https://github.com/lodash/lodash/tree/3.5.0-npm) for more details.
32
33**Note:**<br>
34Don’t assign values to the [special variable](http://nodejs.org/api/repl.html#repl_repl_features) `_` when in the REPL.<br>
35Install [n_](https://www.npmjs.com/package/n_) for a REPL that includes lodash by default.
36
37## Module formats
38
39lodash is also available in a variety of other builds & module formats.
40
41 * npm packages for [modern](https://www.npmjs.com/package/lodash), [compatibility](https://www.npmjs.com/package/lodash-compat), & [per method](https://www.npmjs.com/browse/keyword/lodash-modularized) builds
42 * AMD modules for [modern](https://github.com/lodash/lodash/tree/3.5.0-amd) & [compatibility](https://github.com/lodash/lodash-compat/tree/3.5.0-amd) builds
43 * ES modules for the [modern](https://github.com/lodash/lodash/tree/3.5.0-es) build
44
45## Further Reading
46
47 * [API Documentation](https://lodash.com/docs)
48 * [Build Differences](https://github.com/lodash/lodash/wiki/Build-Differences)
49 * [Changelog](https://github.com/lodash/lodash/wiki/Changelog)
50 * [Release Notes](https://github.com/lodash/lodash/releases)
51 * [Roadmap](https://github.com/lodash/lodash/wiki/Roadmap)
52 * [More Resources](https://github.com/lodash/lodash/wiki/Resources)
53
54## Features *not* in Underscore
55
56 * ~100% [code coverage](https://coveralls.io/r/lodash)
57 * Follows [semantic versioning](http://semver.org/) for releases
58 * [Lazily evaluated](http://filimanjaro.com/blog/2014/introducing-lazy-evaluation/) chaining
59 * [_(…)](https://lodash.com/docs#_) supports intuitive chaining
60 * [_.add](https://lodash.com/docs#add) for mathematical composition
61 * [_.ary](https://lodash.com/docs#ary) & [_.rearg](https://lodash.com/docs#rearg) to change function argument limits & order
62 * [_.at](https://lodash.com/docs#at) for cherry-picking collection values
63 * [_.attempt](https://lodash.com/docs#attempt) to execute functions which may error without a try-catch
64 * [_.before](https://lodash.com/docs#before) to complement [_.after](https://lodash.com/docs#after)
65 * [_.bindKey](https://lodash.com/docs#bindKey) for binding [*“lazy”*](http://michaux.ca/articles/lazy-function-definition-pattern) defined methods
66 * [_.chunk](https://lodash.com/docs#chunk) for splitting an array into chunks of a given size
67 * [_.clone](https://lodash.com/docs#clone) supports shallow cloning of `Date` & `RegExp` objects
68 * [_.cloneDeep](https://lodash.com/docs#cloneDeep) for deep cloning arrays & objects
69 * [_.create](https://lodash.com/docs#create) for easier object inheritance
70 * [_.curry](https://lodash.com/docs#curry) & [_.curryRight](https://lodash.com/docs#curryRight) for creating [curried](http://hughfdjackson.com/javascript/why-curry-helps/) functions
71 * [_.debounce](https://lodash.com/docs#debounce) & [_.throttle](https://lodash.com/docs#throttle) are cancelable & accept options for more control
72 * [_.fill](https://lodash.com/docs#fill) to fill arrays with values
73 * [_.findKey](https://lodash.com/docs#findKey) for finding keys
74 * [_.flow](https://lodash.com/docs#flow) to complement [_.flowRight](https://lodash.com/docs#flowRight) (a.k.a `_.compose`)
75 * [_.forEach](https://lodash.com/docs#forEach) supports exiting early
76 * [_.forIn](https://lodash.com/docs#forIn) for iterating all enumerable properties
77 * [_.forOwn](https://lodash.com/docs#forOwn) for iterating own properties
78 * [_.inRange](https://lodash.com/docs#inRange) for checking whether a number is within a given range
79 * [_.isNative](https://lodash.com/docs#isNative) to check for native functions
80 * [_.isPlainObject](https://lodash.com/docs#isPlainObject) & [_.toPlainObject](https://lodash.com/docs#toPlainObject) to check for & convert to `Object` objects
81 * [_.isTypedArray](https://lodash.com/docs#isTypedArray) to check for typed arrays
82 * [_.matches](https://lodash.com/docs#matches) supports deep object comparisons
83 * [_.matchesProperty](https://lodash.com/docs#matchesProperty) to complement [_.matches](https://lodash.com/docs#matches) & [_.property](https://lodash.com/docs#property)
84 * [_.merge](https://lodash.com/docs#merge) for a deep [_.extend](https://lodash.com/docs#extend)
85 * [_.parseInt](https://lodash.com/docs#parseInt) for consistent cross-environment behavior
86 * [_.pull](https://lodash.com/docs#pull), [_.pullAt](https://lodash.com/docs#pullAt), & [_.remove](https://lodash.com/docs#remove) for mutating arrays
87 * [_.random](https://lodash.com/docs#random) supports returning floating-point numbers
88 * [_.runInContext](https://lodash.com/docs#runInContext) for collisionless mixins & easier mocking
89 * [_.slice](https://lodash.com/docs#slice) for creating subsets of array-like values
90 * [_.sortByAll](https://lodash.com/docs#sortByAll) & [_.sortByOrder](https://lodash.com/docs#sortByOrder) for sorting by multiple properties & orders
91 * [_.spread](https://lodash.com/docs#spread) for creating a function to spread an array of arguments to another
92 * [_.sum](https://lodash.com/docs#sum) to get the sum of values
93 * [_.support](https://lodash.com/docs#support) for flagging environment features
94 * [_.template](https://lodash.com/docs#template) supports [*“imports”*](https://lodash.com/docs#templateSettings-imports) options & [ES template delimiters](http://people.mozilla.org/~jorendorff/es6-draft.html#sec-template-literal-lexical-components)
95 * [_.transform](https://lodash.com/docs#transform) as a powerful alternative to [_.reduce](https://lodash.com/docs#reduce) for transforming objects
96 * [_.xor](https://lodash.com/docs#xor) to complement [_.difference](https://lodash.com/docs#difference), [_.intersection](https://lodash.com/docs#intersection), & [_.union](https://lodash.com/docs#union)
97 * [_.valuesIn](https://lodash.com/docs#valuesIn) for getting values of all enumerable properties
98 * [_.bind](https://lodash.com/docs#bind), [_.curry](https://lodash.com/docs#curry), [_.partial](https://lodash.com/docs#partial), &
99 [more](https://lodash.com/docs "_.bindKey, _.curryRight, _.partialRight") support customizable argument placeholders
100 * [_.capitalize](https://lodash.com/docs#capitalize), [_.trim](https://lodash.com/docs#trim), &
101 [more](https://lodash.com/docs "_.camelCase, _.deburr, _.endsWith, _.escapeRegExp, _.kebabCase, _.pad, _.padLeft, _.padRight, _.repeat, _.snakeCase, _.startCase, _.startsWith, _.trimLeft, _.trimRight, _.trunc, _.words") string methods
102 * [_.clone](https://lodash.com/docs#clone), [_.isEqual](https://lodash.com/docs#isEqual), &
103 [more](https://lodash.com/docs "_.assign, _.cloneDeep, _.merge") accept callbacks
104 * [_.dropWhile](https://lodash.com/docs#dropWhile), [_.takeWhile](https://lodash.com/docs#takeWhile), &
105 [more](https://lodash.com/docs "_.drop, _.dropRightWhile, _.take, _.takeRightWhile") to complement [_.first](https://lodash.com/docs#first), [_.initial](https://lodash.com/docs#initial), [_.last](https://lodash.com/docs#last), & [_.rest](https://lodash.com/docs#rest)
106 * [_.findLast](https://lodash.com/docs#findLast), [_.findLastKey](https://lodash.com/docs#findLastKey), &
107 [more](https://lodash.com/docs "_.flowRight, _.forEachRight, _.forInRight, _.forOwnRight, _.partialRight") right-associative methods
108 * [_.includes](https://lodash.com/docs#includes), [_.toArray](https://lodash.com/docs#toArray), &
109 [more](https://lodash.com/docs "_.at, _.countBy, _.every, _.filter, _.find, _.findLast, _.forEach, _.forEachRight, _.groupBy, _.indexBy, _.invoke, _.map, _.max, _.min, _.partition, _.pluck, _.reduce, _.reduceRight, _.reject, _.shuffle, _.size, _.some, _.sortBy") accept strings
110 * [_#commit](https://lodash.com/docs#prototype-commit) & [_#plant](https://lodash.com/docs#prototype-plant) for working with chain sequences
111 * [_#thru](https://lodash.com/docs#thru) to pass values thru a chain sequence
112
113## Support
114
115Tested in Chrome 40-41, Firefox 35-36, IE 6-11, Opera 26-27, Safari 5-8, io.js 1.5.0, Node.js 0.8.28, 0.10.36, & 0.12.0, PhantomJS 1.9.8, RingoJS 0.11, & Rhino 1.7RC5.
116Automated [browser](https://saucelabs.com/u/lodash) & [CI](https://travis-ci.org/lodash/lodash/) test runs are available. Special thanks to [Sauce Labs](https://saucelabs.com/) for providing automated browser testing.