rapid-sdk
    Preparing search index...

    Function utilArrayGroupBy

    • Groups the items of the Array according to the given key

      Type Parameters

      • T

      Parameters

      • a: T[]

        target items

      • key: keyof T | ((item: T) => string)

        property or a key function

      Returns Record<string, T[]>

      grouped items

      let pets = [
      { type: 'Dog', name: 'Spot' },
      { type: 'Cat', name: 'Tiger' },
      { type: 'Dog', name: 'Rover' },
      { type: 'Cat', name: 'Leo' }
      ];
      utilArrayGroupBy(pets, 'type')
      returns:
      {
      'Dog': [{type: 'Dog', name: 'Spot'}, {type: 'Dog', name: 'Rover'}],
      'Cat': [{type: 'Cat', name: 'Tiger'}, {type: 'Cat', name: 'Leo'}]
      }

      utilArrayGroupBy(pets, function(item) { return item.name.length; })
      returns:
      {
      3: [{type: 'Cat', name: 'Leo'}],
      4: [{type: 'Dog', name: 'Spot'}],
      5: [{type: 'Cat', name: 'Tiger'}, {type: 'Dog', name: 'Rover'}]
      }