Function partition

  • partition<T>(
        collection: Record<string, T>,
        predicate: KeyIteratee | RecordIteratee<T>,
    ): T[][]

  • Creates an array of elements split into two groups, the first of which contains elements predicate returns truthy for, the second of which contains elements predicate returns falsey for. The predicate is invoked with one argument: (value).

    Type Parameters

    • T

    Parameters

    • collection: Record<string, T>

      The collection to iterate over.

    • predicate: KeyIteratee | RecordIteratee<T>

      The function invoked per iteration.

    Returns T[][]

    Returns the array of grouped elements.

    Since

    5.11.0

    See

    [[groupBy]], [[keyBy]]

    Example

    const users = [
      { 'user': 'barney',  'age': 36, 'active': false },
      { 'user': 'fred',    'age': 40, 'active': true },
      { 'user': 'pebbles', 'age': 1,  'active': false }
    ]

    partition(users, ({ active }) => active)
    // => objects for [['fred'], ['barney', 'pebbles']]
  • partition<T>(collection: T[], predicate: KeyIteratee | ArrayIteratee<T>): T[][]

  • Creates an array of elements split into two groups, the first of which contains elements predicate returns truthy for, the second of which contains elements predicate returns falsey for. The predicate is invoked with one argument: (value).

    Type Parameters

    • T

    Parameters

    • collection: T[]

      The collection to iterate over.

    • predicate: KeyIteratee | ArrayIteratee<T>

      The function invoked per iteration.

    Returns T[][]

    Returns the array of grouped elements.

    Since

    5.11.0

    See

    [[groupBy]], [[keyBy]]

    Example

    const users = [
      { 'user': 'barney',  'age': 36, 'active': false },
      { 'user': 'fred',    'age': 40, 'active': true },
      { 'user': 'pebbles', 'age': 1,  'active': false }
    ]

    partition(users, ({ active }) => active)
    // => objects for [['fred'], ['barney', 'pebbles']]

Settings

Member Visibility