Gets the value at path of object. If the resolved value is undefined, defaultValue is returned instead. Part of Lodash Object since 3.7.0 (stable — not deprecated).
Pass the object and path or keys shown below. Check whether the helper mutates or returns a new object.
Call _.get. Start with this line.
_.get(object, path, [defaultValue])| Call | What it does |
|---|---|
_.get(object, path, [defaultValue]) | Primary signature. |
_.get(object) | Work with an object’s keys, values, or paths. |
Prefer import get from "lodash/get" when you want a smaller bundle.
_.get(object, path, [defaultValue])| Parameter | Description |
|---|---|
| object | Required. The object to query |
| path | Required. String or array path to the property |
| defaultValue | Optional. Returned when resolved value is undefined |
| Return Value | Description |
|---|---|
| * | Resolved value, or defaultValue |
Bracket and dot notation walk arrays and objects safely.
var object = { 'a': [{ 'b': { 'c': 3 } }] };
_.get(object, 'a[0].b.c');
// → 3a holding an array.[0] selects the first element..b.c walks into nested objects.3.Same nested read using an array of path segments.
var object = { 'a': [{ 'b': { 'c': 3 } }] };
_.get(object, ['a', '0', 'b', 'c']);
// → 3"0" indexes the array at a.When the path is missing, the default is returned.
var object = { 'a': [{ 'b': { 'c': 3 } }] };
_.get(object, 'a.b.c', 'default');
// → 'default'a.b treats a as an object, but it is an array.undefined.'default' is returned.undefined.null Does Not Trigger DefaultDefault applies only for undefined, not for null or other falsy values.
var data = {
nickname: null,
score: 0,
missing: undefined
};
_.get(data, 'nickname', 'guest');
// → null
_.get(data, 'score', 100);
// → 0
_.get(data, 'missing', 'n/a');
// → 'n/a'null → default unused.0.undefined → default used.null / undefined ObjectNo throw when the root value is missing.
_.get(null, 'a.b', 'fallback');
// → 'fallback'
_.get(undefined, ['user', 'name'], 'anon');
// → 'anon'
_.get({ user: { name: 'Ada' } }, 'user.name', 'anon');
// → 'Ada'_.get is a Lodash Object helper (available since 3.7.0, stable in 4.x). It runs anywhere Lodash runs — modern browsers (via CDN or bundle) and Node.js / Bun / Deno with npm install lodash.
Available in [email protected] full builds and the lodash/get modular import. Works in evergreen browsers and current Node LTS when Lodash is installed.
Bottom line: Safe for production once Lodash is on the page or in your bundle. Prefer import get from "lodash/get" for smaller builds. For static paths in modern JS, optional chaining is a lightweight alternative.
Check whether a path exists as an own property on an object.
10 people found this page helpful