Please note this is not an official lodash documentation but a demo of jsodc-template-argon, a template for JSDoc3.
How to generate this website :
# clone lodash and "cd" into folder
npm i jsdoc-template-argon
jsdoc . -t node_modules/jsdoc-template-argon -d docs -R README.md -c.jsdoc.json
Configuration file used (.jsdoc.json
) :
{
"plugins": [
"plugins/markdown"
]
}
Find the original lodash README below.
Site | Docs | FP Guide | Contributing | Wiki | Code of Conduct | Twitter | Chat
The Lodash library exported as a UMD module.
Generated using lodash-cli:
$ npm run build
$ lodash -o ./dist/lodash.js
$ lodash core -o ./dist/lodash.core.js
Lodash is released under the MIT license & supports modern environments.
Review the build differences & pick one that’s right for you.
In a browser:
<script src="lodash.js"></script>
Using npm:
$ npm i -g npm
$ npm i --save lodash
In Node.js:
// Load the full build.
var _ = require('lodash');
// Load the core build.
var _ = require('lodash/core');
// Load the FP build for immutable auto-curried iteratee-first data-last methods.
var fp = require('lodash/fp');
// Load method categories.
var array = require('lodash/array');
var object = require('lodash/fp/object');
// Cherry-pick methods for smaller browserify/rollup/webpack bundles.
var at = require('lodash/at');
var curryN = require('lodash/fp/curryN');
Note:
Install n_ for Lodash use in the Node.js < 6 REPL.
Lodash makes JavaScript easier by taking the hassle out of working with arrays,
numbers, objects, strings, etc. Lodash’s modular methods are great for:
Lodash is available in a variety of builds & module formats.