Function keyBy

  • keyBy<T>(
        collection: ArrayLike<T>,
        iteratee?: (obj: T) => any,
    ): Record<string, T>

  • 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 last element responsible for generating the key. The iteratee is invoked with one argument: (value).

    Type Parameters

    • T

    Parameters

    • collection: ArrayLike<T>

      The collection to iterate over.

    • Optionaliteratee: (obj: T) => any

      The iteratee to transform keys.

    Returns Record<string, T>

    Returns the composed aggregate object.

    Since

    5.6.0

    See

    [[groupBy]],[[partition]]

    Example

    const array = [
      { 'dir': 'left', 'code': 97 },
      { 'dir': 'right', 'code': 100 }
    ]

    keyBy(array, ({ code }) => String.fromCharCode(code))
    // => { 'a': { 'dir': 'left', 'code': 97 }, 'd': { 'dir': 'right', 'code': 100 } }

Settings

Member Visibility