linuxcommandgitbook/node_modules/lodash

lodash v3.10.1

The modern build of lodash exported as Node.js/io.js modules.

Generated using lodash-cli:

$ lodash modularize modern exports=node -o ./
$ lodash modern -d -o ./index.js

Installation

Using npm:

$ {sudo -H} npm i -g npm
$ npm i --save lodash

In Node.js/io.js:

// load the modern build
var _ = require('lodash');
// or a method category
var array = require('lodash/array');
// or a method (great for smaller builds with browserify/webpack)
var chunk = require('lodash/array/chunk');

See the package source for more details.

Note:
Don’t assign values to the special variable _ when in the REPL.
Install n_ for a REPL that includes lodash by default.

Module formats

lodash is also available in a variety of other builds & module formats.

• npm packages for modern, compatibility, & per method builds
• AMD modules for modern & compatibility builds
• ES modules for the modern build

Further Reading

• API Documentation
• Build Differences
• Changelog
• Roadmap
• More Resources

Features

• ~100% code coverage
• Follows semantic versioning for releases
• Lazily evaluated chaining
• _(…) supports implicit chaining
• _.ary & _.rearg to change function argument limits & order
• _.at for cherry-picking collection values
• _.attempt to execute functions which may error without a try-catch
• _.before to complement _.after
• _.bindKey for binding “lazy” defined methods
• _.chunk for splitting an array into chunks of a given size
• _.clone supports shallow cloning of Date & RegExp objects
• _.cloneDeep for deep cloning arrays & objects
• _.curry & _.curryRight for creating curried functions
• _.debounce & _.throttle are cancelable & accept options for more control
• _.defaultsDeep for recursively assigning default properties
• _.fill to fill arrays with values
• _.findKey for finding keys
• _.flow to complement _.flowRight (a.k.a _.compose)
• _.forEach supports exiting early
• _.forIn for iterating all enumerable properties
• _.forOwn for iterating own properties
• _.get & _.set for deep property getting & setting
• _.gt, _.gte, _.lt, & _.lte relational methods
• _.inRange for checking whether a number is within a given range
• _.isNative to check for native functions
• _.isPlainObject & _.toPlainObject to check for & convert to Object objects
• _.isTypedArray to check for typed arrays
• _.mapKeys for mapping keys to an object
• _.matches supports deep object comparisons
• _.matchesProperty to complement _.matches & _.property
• _.merge for a deep _.extend
• _.method & _.methodOf to create functions that invoke methods
• _.modArgs for more advanced functional composition
• _.parseInt for consistent cross-environment behavior
• _.pull, _.pullAt, & _.remove for mutating arrays
• _.random supports returning floating-point numbers
• _.restParam & _.spread for applying rest parameters & spreading arguments to functions
• _.runInContext for collisionless mixins & easier mocking
• _.slice for creating subsets of array-like values
• _.sortByAll & _.sortByOrder for sorting by multiple properties & orders
• _.support for flagging environment features
• _.template supports “imports” options & ES template delimiters
• _.transform as a powerful alternative to _.reduce for transforming objects
• _.unzipWith & _.zipWith to specify how grouped values should be combined
• _.valuesIn for getting values of all enumerable properties
• _.xor to complement _.difference, _.intersection, & _.union
• _.add, _.round, _.sum, & more math methods
• _.bind, _.curry, _.partial, & more support customizable argument placeholders
• _.capitalize, _.trim, & more string methods
• _.clone, _.isEqual, & more accept customizer callbacks
• _.dropWhile, _.takeWhile, & more to complement _.first, _.initial, _.last, & _.rest
• _.findLast, _.findLastKey, & more right-associative methods
• _.includes, _.toArray, & more accept strings
• _#commit & _#plant for working with chain sequences
• _#thru to pass values thru a chain sequence

Support

Tested in Chrome 43-44, Firefox 38-39, IE 6-11, MS Edge, Safari 5-8, ChakraNode 0.12.2, io.js 2.5.0, Node.js 0.8.28, 0.10.40, & 0.12.7, PhantomJS 1.9.8, RingoJS 0.11, & Rhino 1.7.6. Automated browser & CI test runs are available. Special thanks to Sauce Labs for providing automated browser testing.