array/unionWith.js

  1. import { unionWith as _unionWith } from 'lodash'
  2. import { apply } from 'immutadot/core'
  3. /**
  4. * This method is like {@link array.union} except that it accepts <code>comparator</code> to compare elements.
  5. * @function
  6. * @memberof array
  7. * @param {Object} object The object to modify.
  8. * @param {Array|string} path The path of the property to set.
  9. * @param {...Array} [arrays] The arrays to inspect.
  10. * @param {Function} [comparator] The comparator invoked per element.
  11. * @return {Object} Returns the updated object.
  12. * @example unionWith({ nested: { prop: [{ x: 1 }, { x: 2 }] } }, 'nested.prop', [{ x: 2 }, { x: 3 }], (a, b) => a.x === b.x) // => { nested: { prop: [{ x: 1 }, { x: 2 }, { x: 3 }] } }
  13. * @see {@link https://lodash.com/docs#unionWith|lodash.unionWith} for more information.
  14. * @since 1.0.0
  15. */
  16. const unionWith = apply(_unionWith, { arity: 2 })
  17. export { unionWith }