Options
All
  • Public
  • Public/Protected
  • All
Menu

Module keyBy

Index

References

Functions Collection

References

Renames and re-exports keyBy

Collection Functions

  • 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).

    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 } }

    Type parameters

    • T

    Parameters

    • collection: ArrayLike<T>

      The collection to iterate over.

    • Optional iteratee: (obj: T) => any

      The iteratee to transform keys.

        • (obj: T): any
        • Parameters

          • obj: T

          Returns any

    Returns Record<string, T>

    Returns the composed aggregate object.