es-toolkit/dist/compat/array/differenceBy.d.ts

A state-of-the-art, high-performance JavaScript utility library with a small bundle size and strong type annotations.

import { ValueIteratee } from "../_internal/ValueIteratee.js";

//#region src/compat/array/differenceBy.d.ts
/**
 * Creates an array of array values not included in the other given arrays using an iteratee function.
 *
 * @template T1, T2
 * @param array The array to inspect
 * @param values The values to exclude
 * @param iteratee The iteratee invoked per element
 * @returns Returns the new array of filtered values
 * @example
 * differenceBy([2.1, 1.2], [2.3, 3.4], Math.floor)
 * // => [1.2]
 */
declare function differenceBy<T1, T2>(array: ArrayLike<T1> | null | undefined, values: ArrayLike<T2>, iteratee: ValueIteratee<T1 | T2>): T1[];
/**
 * Creates an array of array values not included in the other given arrays using an iteratee function.
 *
 * @template T1, T2, T3
 * @param array The array to inspect
 * @param values1 The first array of values to exclude
 * @param values2 The second array of values to exclude
 * @param iteratee The iteratee invoked per element
 * @returns Returns the new array of filtered values
 * @example
 * differenceBy([2.1, 1.2], [2.3], [1.4], Math.floor)
 * // => []
 */
declare function differenceBy<T1, T2, T3>(array: ArrayLike<T1> | null | undefined, values1: ArrayLike<T2>, values2: ArrayLike<T3>, iteratee: ValueIteratee<T1 | T2 | T3>): T1[];
/**
 * Creates an array of array values not included in the other given arrays using an iteratee function.
 *
 * @template T1, T2, T3, T4
 * @param array The array to inspect
 * @param values1 The first array of values to exclude
 * @param values2 The second array of values to exclude
 * @param values3 The third array of values to exclude
 * @param iteratee The iteratee invoked per element
 * @returns Returns the new array of filtered values
 * @example
 * differenceBy([2.1, 1.2, 3.5], [2.3], [1.4], [3.2], Math.floor)
 * // => []
 */
declare function differenceBy<T1, T2, T3, T4>(array: ArrayLike<T1> | null | undefined, values1: ArrayLike<T2>, values2: ArrayLike<T3>, values3: ArrayLike<T4>, iteratee: ValueIteratee<T1 | T2 | T3 | T4>): T1[];
/**
 * Creates an array of array values not included in the other given arrays using an iteratee function.
 *
 * @template T1, T2, T3, T4, T5
 * @param array The array to inspect
 * @param values1 The first array of values to exclude
 * @param values2 The second array of values to exclude
 * @param values3 The third array of values to exclude
 * @param values4 The fourth array of values to exclude
 * @param iteratee The iteratee invoked per element
 * @returns Returns the new array of filtered values
 * @example
 * differenceBy([2.1, 1.2, 3.5, 4.8], [2.3], [1.4], [3.2], [4.1], Math.floor)
 * // => []
 */
declare function differenceBy<T1, T2, T3, T4, T5>(array: ArrayLike<T1> | null | undefined, values1: ArrayLike<T2>, values2: ArrayLike<T3>, values3: ArrayLike<T4>, values4: ArrayLike<T5>, iteratee: ValueIteratee<T1 | T2 | T3 | T4 | T5>): T1[];
/**
 * Creates an array of array values not included in the other given arrays using an iteratee function.
 *
 * @template T1, T2, T3, T4, T5, T6
 * @param array The array to inspect
 * @param values1 The first array of values to exclude
 * @param values2 The second array of values to exclude
 * @param values3 The third array of values to exclude
 * @param values4 The fourth array of values to exclude
 * @param values5 The fifth array of values to exclude
 * @param iteratee The iteratee invoked per element
 * @returns Returns the new array of filtered values
 * @example
 * differenceBy([2.1, 1.2, 3.5, 4.8, 5.3], [2.3], [1.4], [3.2], [4.1], [5.8], Math.floor)
 * // => []
 */
declare function differenceBy<T1, T2, T3, T4, T5, T6>(array: ArrayLike<T1> | null | undefined, values1: ArrayLike<T2>, values2: ArrayLike<T3>, values3: ArrayLike<T4>, values4: ArrayLike<T5>, values5: ArrayLike<T6>, iteratee: ValueIteratee<T1 | T2 | T3 | T4 | T5 | T6>): T1[];
/**
 * Creates an array of array values not included in the other given arrays using an iteratee function.
 *
 * @template T1, T2, T3, T4, T5, T6, T7
 * @param array The array to inspect
 * @param values1 The first array of values to exclude
 * @param values2 The second array of values to exclude
 * @param values3 The third array of values to exclude
 * @param values4 The fourth array of values to exclude
 * @param values5 The fifth array of values to exclude
 * @param values Additional arrays of values to exclude and iteratee
 * @returns Returns the new array of filtered values
 * @example
 * differenceBy([2.1, 1.2, 3.5, 4.8, 5.3, 6.7], [2.3], [1.4], [3.2], [4.1], [5.8], [6.2], Math.floor)
 * // => []
 */
declare function differenceBy<T1, T2, T3, T4, T5, T6, T7>(array: ArrayLike<T1> | null | undefined, values1: ArrayLike<T2>, values2: ArrayLike<T3>, values3: ArrayLike<T4>, values4: ArrayLike<T5>, values5: ArrayLike<T6>, ...values: Array<ArrayLike<T7> | ValueIteratee<T1 | T2 | T3 | T4 | T5 | T6 | T7>>): T1[];
/**
 * Creates an array of array values not included in the other given arrays.
 *
 * @template T
 * @param array The array to inspect
 * @param values The arrays of values to exclude
 * @returns Returns the new array of filtered values
 * @example
 * differenceBy([2, 1], [2, 3])
 * // => [1]
 */
declare function differenceBy<T>(array: ArrayLike<T> | null | undefined, ...values: Array<ArrayLike<T>>): T[];
//#endregion
export { differenceBy };