flattenDepth

arrays

Recursively flatten array up to depth times.

Installation

Import

import { flattenDepth } from '@tulx/utils';

Source Code

Implementation

/**
 * Recursively flatten array up to depth times.
 *
 * @param array - The array to flatten.
 * @param depth - The maximum recursion depth.
 * @returns The new flattened array.
 *
 * @example
 * ```ts
 * const array = [1, [2, [3, [4]], 5]];
 * flattenDepth(array, 1); // [1, 2, [3, [4]], 5]
 * flattenDepth(array, 2); // [1, 2, 3, [4], 5]
 * ```
 */
export function flattenDepth<T>(
  array: readonly unknown[],
  depth: number = 1
): T[] {
  if (depth <= 0) {
    return array as T[];
  }

  const result: unknown[] = [];
  for (const item of array) {
    if (Array.isArray(item) && depth > 0) {
      result.push(...flattenDepth(item, depth - 1));
    } else {
      result.push(item);
    }
  }
  return result as T[];
}

Example

import { flattenDepth } from '@tulx/utils';

const array = [1, [2, [3, [4]], 5]];
flattenDepth(array, 1); // [1, 2, [3, [4]], 5]
flattenDepth(array, 2); // [1, 2, 3, [4], 5]

Related Functions

chunk

Creates an array of elements split into groups the length of size. If array can't be split evenly, the final chunk will be the remaining elements.

compact

Creates an array with all falsy values removed. The values false, null, 0, "", undefined, and NaN are falsy.

concat

Creates a new array concatenating array with any additional arrays and/or values.

difference

Creates an array of array values not included in the other given arrays. The order and references of result values are determined by the first array.

differenceBy

This method is like difference except that it accepts iteratee which is invoked for each element of array and values to generate the criterion by which they're compared.

differenceWith

This method is like difference except that it accepts comparator which is invoked to compare elements of array to values.