Skip to main content

matchesProperty

_.matchesProperty(path, srcValue) # Ⓢ [Ⓣ][1] Ⓝ

Creates a function that performs a partial deep comparison between the



value at path of a given object to srcValue, returning true if the



object value is equivalent, else false.





Note: Partial comparisons will match empty array and empty object



srcValue values against any array or object value, respectively. See



_.isEqual for a list of supported value comparisons.





Note: Multiple values can be checked by combining several matchers



using _.overSome

Since​

3.2.0

Arguments​

  1. path (Array|string): The path of the property to get.
  2. srcValue (*): The value to match.

Returns​

(Function): Returns the new spec function.

Example​

var objects = [
{ 'a': 1, 'b': 2, 'c': 3 },
{ 'a': 4, 'b': 5, 'c': 6 }
];

_.find(_.matchesProperty('a', 4), objects);
// => { 'a': 4, 'b': 5, 'c': 6 }

// Checking for several possible values
_.filter(
_.overSome([_.matchesProperty('a', 1), _.matchesProperty('a', 4)]),
objects
);
// => [{ 'a': 1, 'b': 2, 'c': 3 }, { 'a': 4, 'b': 5, 'c': 6 }]