Creates a function that returns the value at path of a given object — a reusable path getter. Part of Lodash Util since 2.4.0 (stable — not deprecated).
Note: Collection methods already accept property shorthands (_.map(arr, 'a.b')). Use _.property when you need an explicit, reusable accessor.
Call _.property. Start with this line.
_.property(path)| Call | What it does |
|---|---|
_.property(path) | Primary signature. |
_.property(...) | Call the util helper. |
Prefer import property from "lodash/property" when you want a smaller bundle.
_.property(path)| Parameter | Description |
|---|---|
| path | Required. String or array path to read |
| Return Value | Description |
|---|---|
| * | Getter (object) → value |
Pluck the same nested field from every object.
var objects = [
{ 'a': { 'b': 2 } },
{ 'a': { 'b': 1 } }
];
_.map(objects, _.property('a.b'));
// → [2, 1]'a.b' means nested key b under a._.property('a.b') returns a function that reads that path.[2, 1] — the plucked values.Sort by a nested path, then map the sorted values.
var objects = [
{ 'a': { 'b': 2 } },
{ 'a': { 'b': 1 } }
];
_.map(_.sortBy(objects, _.property(['a', 'b'])), 'a.b');
// → [1, 2]['a', 'b'] is the same nested field as 'a.b'._.sortBy orders by that getter → smaller b first.'a.b' from the sorted list.[1, 2] — ascending nested values.Collection methods already treat property strings as getters.
var objects = [
{ 'a': { 'b': 2 } },
{ 'a': { 'b': 1 } }
];
_.map(objects, 'a.b');
// → [2, 1]
_.map(objects, _.property('a.b'));
// → [2, 1] // same result_.map(objects, 'a.b') is enough for everyday use._.iteratee → property._.property when you reuse the getter.a.b.Absent paths return undefined — no error.
var getZ = _.property('a.z');
getZ({ a: { b: 2 } });
// → undefined
_.get({ a: { b: 2 } }, 'a.z', 0);
// → 0 // default via _.geta.z does not exist → undefined._.get when you need a fallback in one call._.property when the getter itself is what you pass around.property vs methodOne reads the value; the other calls it if it is a function.
var objects = [
{ a: { b: _.constant(2) } },
{ a: { b: _.constant(1) } }
];
_.map(objects, _.property('a.b'));
// → [ƒ, ƒ] // returns the functions
_.map(objects, _.method('a.b'));
// → [2, 1] // calls the functionsproperty. Call → method."function" for clarity in text._.property is a Lodash Util helper since 2.4.0. It runs anywhere Lodash 2.4+ / 4.x runs — modern browsers (CDN or bundle) and Node.js / Bun / Deno with npm install lodash.
Available in [email protected] full builds and the lodash/property modular import. Works in evergreen browsers and current Node LTS when Lodash is installed.
Bottom line: Safe for production once Lodash is loaded. Prefer import property from "lodash/property" for smaller bundles. Collection methods already accept path-string shorthands with the same rules.
Create a getter bound to one object — supply the path later.
10 people found this page helpful