Function matches

  • Creates a function that performs a partial deep comparison between a given object and source, returning true if the given object has equivalent property values, else false.

    Note: The created function is equivalent to isMatch with source partially applied.

    Partial comparisons will match empty array and empty object source values against any array or object value, respectively. See isEqual for a list of supported value comparisons.

    Type Parameters

    • T

    Parameters

    • source: T[]

      The object of property values to match.

    Returns ((obj) => boolean)

    Returns the new spec function.

      • (obj): boolean
      • Parameters

        • obj: T

        Returns boolean

    Since

    5.11.0

    Example

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

    filter(objects, matches({ 'a': 4, 'c': 6 }))
    // => [{ 'a': 4, 'b': 5, 'c': 6 }]