mirror of
https://github.com/whoisclebs/lodash.git
synced 2026-02-01 15:57:48 +00:00
81 lines
3.1 KiB
Markdown
81 lines
3.1 KiB
Markdown
# lodash
|
||
|
||
[Site](https://lodash.com/) |
|
||
[Docs](https://lodash.com/docs) |
|
||
[FP Guide](https://github.com/lodash/lodash/wiki/FP-Guide) |
|
||
[Contributing](https://github.com/lodash/lodash/blob/master/.github/CONTRIBUTING.md) |
|
||
[Wiki](https://github.com/lodash/lodash/wiki "Changelog, Roadmap, etc.") |
|
||
[Code of Conduct](https://js.foundation/community/code-of-conduct) |
|
||
[Twitter](https://twitter.com/bestiejs) |
|
||
[Chat](https://gitter.im/lodash/lodash)
|
||
|
||
The [Lodash](https://lodash.com/) library exported as a [UMD](https://github.com/umdjs/umd) module.
|
||
|
||
Generated using [lodash-cli](https://www.npmjs.com/package/lodash-cli):
|
||
```shell
|
||
$ npm run build
|
||
$ lodash -o ./dist/lodash.js
|
||
$ lodash core -o ./dist/lodash.core.js
|
||
```
|
||
|
||
## Download
|
||
|
||
* [Core build](https://raw.githubusercontent.com/lodash/lodash/4.17.10-npm/core.js) ([~4 kB gzipped](https://raw.githubusercontent.com/lodash/lodash/4.17.10-npm/core.min.js))
|
||
* [Full build](https://raw.githubusercontent.com/lodash/lodash/4.17.10-npm/lodash.js) ([~24 kB gzipped](https://raw.githubusercontent.com/lodash/lodash/4.17.10-npm/lodash.min.js))
|
||
* [CDN copies](https://www.jsdelivr.com/projects/lodash) [](https://www.jsdelivr.com/package/npm/lodash)
|
||
|
||
Lodash is released under the [MIT license](https://raw.githubusercontent.com/lodash/lodash/4.17.10-npm/LICENSE) & supports modern environments.<br>
|
||
Review the [build differences](https://github.com/lodash/lodash/wiki/build-differences) & pick one that’s right for you.
|
||
|
||
## Installation
|
||
|
||
In a browser:
|
||
```html
|
||
<script src="lodash.js"></script>
|
||
```
|
||
|
||
Using npm:
|
||
```shell
|
||
$ npm i -g npm
|
||
$ npm i lodash
|
||
```
|
||
Note: add --save if you are using npm < 5.0.0
|
||
|
||
In Node.js:
|
||
```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');
|
||
```
|
||
|
||
Looking for Lodash modules written in ES6 or smaller bundle sizes? Check out [lodash-es](https://www.npmjs.com/package/lodash-es).
|
||
|
||
## Why Lodash?
|
||
|
||
Lodash makes JavaScript easier by taking the hassle out of working with arrays,<br>
|
||
numbers, objects, strings, etc. Lodash’s modular methods are great for:
|
||
|
||
* Iterating arrays, objects, & strings
|
||
* Manipulating & testing values
|
||
* Creating composite functions
|
||
|
||
## Module Formats
|
||
|
||
Lodash is available in a [variety of builds](https://lodash.com/custom-builds) & module formats.
|
||
|
||
* [lodash](https://www.npmjs.com/package/lodash) & [per method packages](https://www.npmjs.com/search?q=keywords:lodash-modularized)
|
||
* [lodash-es](https://www.npmjs.com/package/lodash-es), [babel-plugin-lodash](https://www.npmjs.com/package/babel-plugin-lodash), & [lodash-webpack-plugin](https://www.npmjs.com/package/lodash-webpack-plugin)
|
||
* [lodash/fp](https://github.com/lodash/lodash/tree/npm/fp)
|
||
* [lodash-amd](https://www.npmjs.com/package/lodash-amd)
|