source: node_modules/es-toolkit/dist/array/flatMap.d.mts

Last change on this file was a762898, checked in by istevanoska <ilinastevanoska@…>, 5 months ago

Added visualizations

  • Property mode set to 100644
File size: 1.1 KB
Line 
1/**
2 * Maps each element in the array using the iteratee function and flattens the result up to the specified depth.
3 *
4 * @template T - The type of elements within the array.
5 * @template U - The type of elements within the returned array from the iteratee function.
6 * @template D - The depth to which the array should be flattened.
7 * @param {T[]} arr - The array to flatten.
8 * @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.
9 * @param {D} depth - The depth level specifying how deep a nested array structure should be flattened. Defaults to 1.
10 * @returns {Array<FlatArray<U[], D>>} The new array with the mapped and flattened elements.
11 *
12 * @example
13 * const arr = [1, 2, 3];
14 *
15 * flatMap(arr, (item: number) => [item, item]);
16 * // [1, 1, 2, 2, 3, 3]
17 *
18 * flatMap(arr, (item: number) => [[item, item]], 2);
19 * // [1, 1, 2, 2, 3, 3]
20 */
21declare 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>>;
22
23export { flatMap };
Note: See TracBrowser for help on using the repository browser.