Function default

  • default<T, R = any>(
        collection: T[],
        iteratee?: Iteratee<number, T, T[]>,
        depth?: number,
    ): R[]

  • This method is like flatMap except that it recursively flattens the mapped results up to depth times.

    Type Parameters

    • T
    • R = any

    Parameters

    • collection: T[]

      The collection to iterate over.

    • Optionaliteratee: Iteratee<number, T, T[]>

      The function invoked per iteration.

    • Optionaldepth: number

      The maximum recursion depth.

    Returns R[]

    Returns the new flattened array.

    Since

    5.4.0

    See

    [[flatMap]],[[flatMapDepth]],[[flatten]],[[flattenDeep]],[[flattenDepth]],[[map]],[[mapKeys]],[[mapValues]]

    Example

    function duplicate(n) {
      return [[[n, n]]]
    }

    flatMapDepth([1, 2], duplicate, 2)
    // => [[1, 1], [2, 2]]
  • default<T, R = any>(
        collection: Record<string, T>,
        iteratee?: Iteratee<string, T, Record<string, T>>,
        depth?: number,
    ): R[]

  • This method is like flatMap except that it recursively flattens the mapped results up to depth times.

    Type Parameters

    • T
    • R = any

    Parameters

    • collection: Record<string, T>

      The collection to iterate over.

    • Optionaliteratee: Iteratee<string, T, Record<string, T>>

      The function invoked per iteration.

    • Optionaldepth: number

      The maximum recursion depth.

    Returns R[]

    Returns the new flattened array.

    Since

    5.4.0

    See

    [[flatMap]],[[flatMapDepth]],[[flatten]],[[flattenDeep]],[[flattenDepth]],[[map]],[[mapKeys]],[[mapValues]]

    Example

    function duplicate(n) {
      return [[[n, n]]]
    }

    flatMapDepth([1, 2], duplicate, 2)
    // => [[1, 1], [2, 2]]

Settings

Member Visibility