Lodash

https://lodash.com
Admin
Lodash is a modern JavaScript utility library that provides modularity and performance through...
Tokens:1,941
Snippets:40
Trust Score:9.9
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install Lodash via npm

Source: https://lodash.com/

Install Lodash globally and then as a project dependency using npm.

```bash
$ npm i -g npm
$ npm i --save lodash
```

--------------------------------

### Install lodash-cli Globally

Source: https://lodash.com/custom-builds

Install the lodash-cli globally to use its command-line interface for custom builds. This command installs the package and makes the `lodash` command available in your terminal.

```bash
$ npm i -g lodash-cli
$ lodash -h
```

--------------------------------

### Lodash Partition Example

Source: https://lodash.com/

Use _.partition to split elements into two groups based on the return value of the predicate function.

```javascript
_.partition([1, 2, 3, 4], n => n % 2);
// → [[1, 3], [2, 4]]
```

--------------------------------

### Lodash Defaults Example

Source: https://lodash.com/

Use _.defaults to assign properties from source objects to the destination object for all undefined properties.

```javascript
_.defaults({"a": 1}, {"a": 3, "b": 2});
// → { "a": 1, "b": 2 }
```

--------------------------------

### Display Help Information

Source: https://lodash.com/custom-builds

Show the help information for the lodash-cli, listing all available commands and options. Use the `-h` or `--help` flag.

```bash
-h
```

--------------------------------

### Specify Output Path

Source: https://lodash.com/custom-builds

Write the build output to a specific file path or filename. Use the `-o` or `--output` flag.

```bash
-o
```

--------------------------------

### Write Output to Standard Output

Source: https://lodash.com/custom-builds

Redirect the build output to standard output instead of writing to a file. Use the `-c` or `--stdout` flag.

```bash
-c
```

--------------------------------

### Generate Source Map

Source: https://lodash.com/custom-builds

Create a source map for the build output, which can be used for debugging. An optional source map URL can be specified. Use the `-m` or `--source-map` flag.

```bash
-m
```

--------------------------------

### Build with Specific Categories

Source: https://lodash.com/custom-builds

Create a custom build by specifying comma-separated categories of functions to include. Valid categories include array, collection, date, function, lang, object, number, seq, string, and util.

```bash
lodash category=collection,function
```

--------------------------------

### Create a Core Build

Source: https://lodash.com/custom-builds

Generate a core build of Lodash, which is a minimal build approximately 4kB in size. Use the `core` modifier to create this build.

```bash
lodash core
```

--------------------------------

### Generate Production Output

Source: https://lodash.com/custom-builds

Create a minified production version of the Lodash build. Use the `-p` or `--production` flag.

```bash
-p
```

--------------------------------

### Generate Development Output

Source: https://lodash.com/custom-builds

Create a non-minified development version of the Lodash build. Use the `-d` or `--development` flag.

```bash
-d
```

--------------------------------

### Configure Template Settings

Source: https://lodash.com/custom-builds

Pass specific template settings to be used during the precompilation of templates. This allows customization of interpolation, escape, and other template behaviors.

```bash
lodash settings="{interpolate:/\{\{([sS]+?)\}\/g}"
```

--------------------------------

### Output Version Information

Source: https://lodash.com/custom-builds

Display the current version of Lodash. Use the `-V` or `--version` flag.

```bash
-V
```

--------------------------------

### Include Specific Functions

Source: https://lodash.com/custom-builds

Build Lodash with only a specified list of functions. This is useful for creating highly optimized builds with only the required utilities.

```bash
lodash include=each,filter,map
```

--------------------------------

### Add Functions to a Category Build

Source: https://lodash.com/custom-builds

Extend a build by adding specific functions to a category. This command combines category inclusion with the addition of specific utilities.

```bash
lodash category=array plus=random,template
```

--------------------------------

### Exclude Specific Functions or Categories

Source: https://lodash.com/custom-builds

Create a build by excluding specific functions or entire categories. Use the `minus` command for this purpose.

```bash
lodash minus=result,shuffle
```

--------------------------------

### Precompile Templates

Source: https://lodash.com/custom-builds

Precompile Lodash template files using a specified file path pattern. Precompiled templates are assigned to the `_.templates` object.

```bash
lodash template="./*.jst"
```

--------------------------------

### Create a Modularized Build

Source: https://lodash.com/custom-builds

Generate a modularized build of Lodash, splitting the library into individual modules. Use the `modularize` modifier for this.

```bash
lodash modularize
```

--------------------------------

### Node.js Lodash Module Imports

Source: https://lodash.com/

Demonstrates various ways to require Lodash modules in Node.js, including the full build, core build, FP build, method categories, and cherry-picked methods.

```javascript
// 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');
```

--------------------------------

### Using named imports with babel-plugin-lodash

Source: https://lodash.com/per-method-packages

Transform named top-level imports into direct import statements to optimize bundle size.

```javascript
import { throttle, debounce } from 'lodash'
```

--------------------------------

### Importing Lodash methods directly

Source: https://lodash.com/per-method-packages

Use direct imports to ensure only the necessary subset of Lodash code is included in your bundle.

```javascript
const throttle = require('lodash/throttle')
```

--------------------------------

### Create a Strict Build

Source: https://lodash.com/custom-builds

Generate a strict build of Lodash with ES strict mode enabled. Use the `strict` modifier for this purpose.

```bash
lodash strict
```

--------------------------------

### Specify Export Formats

Source: https://lodash.com/custom-builds

Define how the Lodash function should be exported using comma-separated values. Valid exports include amd, commonjs, es, global, node, npm, none, and umd.

```bash
lodash exports=amd,node
```

--------------------------------

### Specify AMD Module ID

Source: https://lodash.com/custom-builds

Set the AMD module ID for Lodash or for including Lodash in compiled templates. Use 'none' to create compiled templates without a Lodash dependency.

```bash
lodash moduleId=underscore
```

--------------------------------

### Suppress Status Updates

Source: https://lodash.com/custom-builds

Prevent status updates from being logged to the console during the build process. Use the `-s` or `--silent` flag.

```bash
-s
```

--------------------------------

### Replace IIFE Wrapper

Source: https://lodash.com/custom-builds

Customize the Immediately Invoked Function Expression (IIFE) that wraps Lodash. This allows for specific global variable assignments or other wrapper logic.

```bash
lodash iife="!function(window,undefined){%output%}(this)"
```
Tokens:
Raw