Function differenceWith

  • differenceWith<T, S>(array, ...values?): T[]

  • This method is like difference except that it accepts comparator which is invoked to compare elements of array to values. The order and references of result values are determined by the first array. The comparator is invoked with two arguments: (arrVal, othVal).

    Note: Unlike pullAllWith, this method returns a new array.

    Type Parameters

    • T
    • S

    Parameters

    • array: T[]

      The array to inspect.

    • Optional Rest...values: any[]

      The values to exclude.

    Returns T[]

    Returns the new array of filtered values.

    Since

    4.0.0

    Example

    const objects = [{ 'x': 1, 'y': 2 }, { 'x': 2, 'y': 1 }]

    differenceWith(objects, [{ 'x': 1, 'y': 2 }], isEqual)
    // => [{ 'x': 2, 'y': 1 }]

Settings

Member Visibility