@newdash/newdash/matchesProperty.d.ts

javascript/typescript utility library

import { Path } from "./types";
/**
 * 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.
 *
 * @since 5.11.0
 * @category Util
 * @param path The path of the property to get.
 * @param srcValue The value to match.
 * @returns {Function} Returns the new spec function.
 * @example
 *
 * ```js
 * const objects = [
 *   { 'a': 1, 'b': 2, 'c': 3 },
 *   { 'a': 4, 'b': 5, 'c': 6 }
 * ]
 *
 * find(objects, matchesProperty('a', 4))
 * // => { 'a': 4, 'b': 5, 'c': 6 }
 * ```
 */
export declare function matchesProperty(path: Path, srcValue: any): (object: any) => boolean;
export default matchesProperty;