24 lines
1.1 KiB
TypeScript
24 lines
1.1 KiB
TypeScript
/**
|
|
* Maps each element in the array using the iteratee function and flattens the result up to the specified depth.
|
|
*
|
|
* @template T - The type of elements within the array.
|
|
* @template U - The type of elements within the returned array from the iteratee function.
|
|
* @template D - The depth to which the array should be flattened.
|
|
* @param {T[]} arr - The array to flatten.
|
|
* @param {(item: T, index: number, array: readonly T[]) => U} iteratee - The function that produces the new array elements. It receives the element, its index, and the array.
|
|
* @param {D} depth - The depth level specifying how deep a nested array structure should be flattened. Defaults to 1.
|
|
* @returns {Array<FlatArray<U[], D>>} The new array with the mapped and flattened elements.
|
|
*
|
|
* @example
|
|
* const arr = [1, 2, 3];
|
|
*
|
|
* flatMap(arr, (item: number) => [item, item]);
|
|
* // [1, 1, 2, 2, 3, 3]
|
|
*
|
|
* flatMap(arr, (item: number) => [[item, item]], 2);
|
|
* // [1, 1, 2, 2, 3, 3]
|
|
*/
|
|
declare function flatMap<T, U, D extends number = 1>(arr: readonly T[], iteratee: (item: T, index: number, array: readonly T[]) => U, depth?: D): Array<FlatArray<U[], D>>;
|
|
|
|
export { flatMap };
|