Options
All
  • Public
  • Public/Protected
  • All
Menu

Module src/arrays/categoriseArrayByObjectPropertyName

Index

Functions

Const categoriseArrayByObjectPropertyName

  • categoriseArrayByObjectPropertyName<T>(data: T[], predicate: (item: T) => string | null): Record<string, T>
  • Converts an array to an object whose keys are generated via the predicate function

    example

    categoriseArrayByObjectPropertyName([ { 'name': 'andy', 'age': 27 }, { 'name': 'bob', 'age': 30 } ], 'name'); // return { 'andy': { 'name': 'andy', 'age': 27 }, 'bob': { 'name': 'bob', 'age': 30 } }

    Type parameters

    • T: Record<string, any>

    Parameters

    • data: T[]
    • predicate: (item: T) => string | null

      Receives the data at each array index and returns a string that is used as the object key

        • (item: T): string | null
        • Parameters

          • item: T

          Returns string | null

    Returns Record<string, T>

    {Record<string, T>}

Generated using TypeDoc