28 lines
1.2 KiB
TypeScript
28 lines
1.2 KiB
TypeScript
type Comparator<T> = (a: T, b: T) => boolean;
|
|
/**
|
|
* This method is like `uniq`, except that it accepts a `comparator` which is used to determine the equality of elements.
|
|
*
|
|
* It creates a duplicate-free version of an array, in which only the first occurrence of each element is kept.
|
|
* If a `comparator` is provided, it will be invoked with two arguments: `(arrVal, othVal)` to compare elements.
|
|
* If no comparator is provided, shallow equality is used.
|
|
*
|
|
* The order of result values is determined by the order they appear in the input array.
|
|
*
|
|
* @template T - The type of elements in the array.
|
|
* @param {ArrayLike<T> | null | undefined} arr - The array to process.
|
|
* @param {Comparator<T>} [comparator] - Optional function to compare elements for equality.
|
|
* @returns {T[]} A new array with only unique values based on the comparator.
|
|
*
|
|
* @example
|
|
* const array = [1, 2, 2, 3];
|
|
* const result = uniqWith(array);
|
|
* // result will be [1, 2, 3]
|
|
*
|
|
* const array = [1, 2, 3];
|
|
* const result = uniqWith(array, (a, b) => a % 2 === b % 2)
|
|
* // result will be [1, 2]
|
|
*/
|
|
declare function uniqWith<T>(arr: ArrayLike<T> | null | undefined, comparator?: Comparator<T>): T[];
|
|
|
|
export { uniqWith };
|