@newdash/newdash
Version:
javascript/typescript utility library
25 lines (24 loc) • 923 B
TypeScript
/**
* This method is like `union` except that it accepts `comparator` which
* is invoked to compare elements of `arrays`. Result values are chosen from
* the first array in which the value occurs. The comparator is invoked
* with two arguments: (arrVal, othVal).
*
* @since 5.13.0
* @category Array
* @param {...Array} [arrays] The arrays to inspect.
* @param {Function} [comparator] The comparator invoked per element.
* @returns {Array} Returns the new array of combined values.
* @see [[difference]], [[union]], [[unionBy]], [[without]], [[xor]], [[xorBy]]
* @example
*
* ```js
* const objects = [{ 'x': 1, 'y': 2 }, { 'x': 2, 'y': 1 }]
* const others = [{ 'x': 1, 'y': 1 }, { 'x': 1, 'y': 2 }]
*
* unionWith(objects, others, isEqual)
* // => [{ 'x': 1, 'y': 2 }, { 'x': 2, 'y': 1 }, { 'x': 1, 'y': 1 }]
* ```
*/
export declare function unionWith(...arrays: any[]): any[];
export default unionWith;