flatMapDepth
collection
This method is like flatMap except that it recursively flattens the mapped results up to depth times.
Installation
Import
import { flatMapDepth } from '@tulx/utils';Source Code
Implementation
/**
* This method is like flatMap except that it recursively flattens the mapped results up to depth times.
*
* @param collection - The collection to iterate over.
* @param iteratee - The function invoked per iteration.
* @param depth - The maximum recursion depth.
* @returns Returns the new flattened array.
*
* @example
* ```ts
* function duplicate(n: number) {
* return [[[n, n]]];
* }
* flatMapDepth([1, 2], duplicate, 2); // [[1, 1], [2, 2]]
* ```
*/
export function flatMapDepth<T, TResult>(
collection: readonly T[] | Record<string, T>,
iteratee: (
value: T,
index: number | string,
collection: readonly T[] | Record<string, T>
) => TResult | readonly TResult[],
depth: number = 1
): TResult[] {
const result: unknown[] = [];
function flattenRecursive(
arr: readonly unknown[],
currentDepth: number
): void {
for (const item of arr) {
if (Array.isArray(item) && currentDepth > 0) {
flattenRecursive(item, currentDepth - 1);
} else {
result.push(item);
}
}
}
if (Array.isArray(collection)) {
for (let i = 0; i < collection.length; i++) {
const mapped = iteratee(collection[i], i, collection);
if (Array.isArray(mapped)) {
flattenRecursive(mapped, depth);
} else {
result.push(mapped);
}
}
} else {
const record = collection as Record<string, T>;
for (const key in record) {
if (Object.prototype.hasOwnProperty.call(record, key)) {
const mapped = iteratee(record[key], key, record);
if (Array.isArray(mapped)) {
flattenRecursive(mapped, depth);
} else {
result.push(mapped);
}
}
}
}
return result as TResult[];
}
Example
import { flatMapDepth } from '@tulx/utils';
function duplicate(n: number) {
return [[[n, n]]];
}
flatMapDepth([1, 2], duplicate, 2); // [[1, 1], [2, 2]]Related Functions
countBy
Creates an object composed of keys generated from the results of running each element of collection thru iteratee. The corresponding value of each key is the number of times the key was returned by iteratee.
each
Iterates over elements of collection and invokes iteratee for each element. The iteratee is invoked with three arguments: (value, index|key, collection).
eachRight
This method is like each except that it iterates over elements of collection from right to left.
every
Checks if predicate returns truthy for all elements of collection.
filter
Iterates over elements of collection, returning an array of all elements predicate returns truthy for.
find
Iterates over elements of collection, returning the first element predicate returns truthy for.