This reference covers every method Lodash 4.18.1 exports on _, organized the same way the project organizes its own documentation: by category. Each entry gives you the exact signature, a description, a parameter table, the return value, and a minimal runnable example.
How to read a parameter
| Notation | Meaning |
|---|---|
name | Required parameter. |
[name] | Optional parameter. |
[name=value] | Optional parameter with the default shown after =. |
[object.key] | An optional property of an options object parameter. |
` any ` | The parameter or return value accepts or produces any JavaScript value. |
Type | Type | The parameter or return value accepts either listed type. |
Every category below follows this same structure, so once you're comfortable reading one entry you can read all of them.
Categories
lodash wrapper object and its instance methods._.VERSION and templateSettings.Verified against source
Every signature, parameter, return value, and example in this reference is generated from Lodash 4.18.1's own published API documentation, which the project builds directly from the source comments in lodash.js and tests against real execution as part of its own build. A sample of examples across categories was re-run against the local build while writing this reference to confirm the documented output still matches.
Next steps
- New to Lodash? Start with the quickstart.
- Combining several calls into one pipeline? See Chain sequences.
- Using property paths or partial objects instead of callbacks? See Iteratee shorthands.