Options
All
  • Public
  • Public/Protected
  • All
Menu

Module groupBy

Index

References

Functions Collection

References

Renames and re-exports groupBy

Collection Functions

  • groupBy<T>(result: Collection<T>): Record<string, T[]>
  • groupBy<T>(result: ArrayLike<T>, iteratee: KeyIteratee): Record<string, T[]>
  • groupBy<T>(result: Record<string, T>, iteratee: KeyIteratee): Record<string, T[]>
  • groupBy<T>(result: ArrayLike<T>, iteratee: ArrayIteratee<T, any>): Record<string, T[]>
  • groupBy<T>(result: Record<string, T>, iteratee: RecordIteratee<T, any>): Record<string, T[]>
  • Creates an object composed of keys generated from the results of running each element of collection thru iteratee. The order of grouped values is determined by the order they occur in collection. The corresponding value of each key is an array of elements responsible for generating the key. The iteratee is invoked with one argument: (value).

    since

    5.5.0

    example
    groupBy([6.1, 4.2, 6.3], Math.floor);
    // => { '4': [4.2], '6': [6.1, 6.3] }

    // The `property` iteratee shorthand.
    groupBy(['one', 'two', 'three'], 'length');
    // => { '3': ['one', 'two'], '5': ['three'] }

    Type parameters

    • T

    Parameters

    • result: Collection<T>

    Returns Record<string, T[]>

    Returns the composed aggregate object.

  • Type parameters

    • T

    Parameters

    • result: ArrayLike<T>
    • iteratee: KeyIteratee

    Returns Record<string, T[]>

  • Type parameters

    • T

    Parameters

    • result: Record<string, T>
    • iteratee: KeyIteratee

    Returns Record<string, T[]>

  • Type parameters

    • T

    Parameters

    • result: ArrayLike<T>
    • iteratee: ArrayIteratee<T, any>

    Returns Record<string, T[]>

  • Type parameters

    • T

    Parameters

    • result: Record<string, T>
    • iteratee: RecordIteratee<T, any>

    Returns Record<string, T[]>