mirror of
https://github.com/whoisclebs/lodash.git
synced 2026-01-29 14:37:49 +00:00
32 lines
1.0 KiB
JavaScript
32 lines
1.0 KiB
JavaScript
import basePullAll from './.internal/basePullAll.js'
|
|
|
|
/**
|
|
* This method is like `pullAll` except that it accepts `comparator` which
|
|
* is invoked to compare elements of `array` to `values`. The comparator is
|
|
* invoked with two arguments: (arrVal, othVal).
|
|
*
|
|
* **Note:** Unlike `differenceWith`, this method mutates `array`.
|
|
*
|
|
* @since 4.6.0
|
|
* @category Array
|
|
* @param {Array} array The array to modify.
|
|
* @param {Array} values The values to remove.
|
|
* @param {Function} [comparator] The comparator invoked per element.
|
|
* @returns {Array} Returns `array`.
|
|
* @see pull, pullAll, pullAllBy, pullAt, remove, reject
|
|
* @example
|
|
*
|
|
* const array = [{ 'x': 1, 'y': 2 }, { 'x': 3, 'y': 4 }, { 'x': 5, 'y': 6 }]
|
|
*
|
|
* pullAllWith(array, [{ 'x': 3, 'y': 4 }], isEqual)
|
|
* console.log(array)
|
|
* // => [{ 'x': 1, 'y': 2 }, { 'x': 5, 'y': 6 }]
|
|
*/
|
|
function pullAllWith(array, values, comparator) {
|
|
return (array != null && array.length && values != null && values.length)
|
|
? basePullAll(array, values, undefined, comparator)
|
|
: array
|
|
}
|
|
|
|
export default pullAllWith
|