External module "utils/group-by/docs/types/index.d"

Export assignment groupBy

• groupBy<T, U>(collection: Collection<T>, indicator: Indicator<T, U>): ValuesResults<T>
• groupBy<T, U>(collection: Collection<T>, options: IndicesOptions<T, U>, indicator: Indicator<T, U>): IndicesResults
• groupBy<T, U>(collection: Collection<T>, options: ValuesOptions<T, U> | BaseOptions<T, U>, indicator: Indicator<T, U>): ValuesResults<T>
• groupBy<T, U>(collection: Collection<T>, options: IndicesAndValuesOptions<T, U>, indicator: Indicator<T, U>): IndicesAndValuesResults<T>

• Groups values according to an indicator function.

  Notes

  • When invoked, the indicator function is provided two arguments:

    • value: collection value
    • index: collection index

  • The value returned by an indicator function should be a value which can be serialized as an object key.

  • If provided an empty collection, the function returns an empty object.

  Type parameters

  • T

  • U

  Parameters

  • collection: Collection<T>

    collection to group

  • indicator: Indicator<T, U>

    indicator function specifying which group an element in the input collection belongs to

  Returns ValuesResults < T >

  group results

  Example

  function indicator( v ) {
      return v[ 0 ];
  }
  var arr = [ 'beep', 'boop', 'foo', 'bar' ];
  
  var out = groupBy( arr, indicator );
  // returns { 'b': [ 'beep', 'boop', 'bar' ], 'f': [ 'foo' ] }

• Groups values according to an indicator function.

  Notes

  • When invoked, the indicator function is provided two arguments:

    • value: collection value
    • index: collection index

  • The value returned by an indicator function should be a value which can be serialized as an object key.

  • If provided an empty collection, the function returns an empty object.

  Type parameters

  • T

  • U

  Parameters

  • collection: Collection<T>

    collection to group

  • options: IndicesOptions<T, U>

    function options

  • indicator: Indicator<T, U>

    indicator function specifying which group an element in the input collection belongs to

  Returns IndicesResults

  group results

  Example

  function indicator( v ) {
      return v[ 0 ];
  }
  var arr = [ 'beep', 'boop', 'foo', 'bar' ];
  
  var opts = {
      'returns': 'indices'
  };
  var out = groupBy( arr, opts, indicator );
  // returns { 'b': [ 0, 1, 3 ], 'f': [ 2 ] }

• Groups values according to an indicator function.

  Notes

  • When invoked, the indicator function is provided two arguments:

    • value: collection value
    • index: collection index

  • The value returned by an indicator function should be a value which can be serialized as an object key.

  • If provided an empty collection, the function returns an empty object.

  Type parameters

  • T

  • U

  Parameters

  • collection: Collection<T>

    collection to group

  • options: ValuesOptions<T, U> | BaseOptions<T, U>

    function options

  • indicator: Indicator<T, U>

    indicator function specifying which group an element in the input collection belongs to

  Returns ValuesResults < T >

  group results

  Example

  function indicator( v ) {
      return v[ 0 ];
  }
  var arr = [ 'beep', 'boop', 'foo', 'bar' ];
  
  var opts = {
      'returns': 'values'
  };
  var out = groupBy( arr, opts, indicator );
  // returns { 'b': [ 'beep', 'boop', 'bar' ], 'f': [ 'foo' ] }

• Groups values according to an indicator function.

  Notes

  • When invoked, the indicator function is provided two arguments:

    • value: collection value
    • index: collection index

  • The value returned by an indicator function should be a value which can be serialized as an object key.

  • If provided an empty collection, the function returns an empty object.

  Type parameters

  • T

  • U

  Parameters

  • collection: Collection<T>

    collection to group

  • options: IndicesAndValuesOptions<T, U>

    function options

  • indicator: Indicator<T, U>

    indicator function specifying which group an element in the input collection belongs to

  Returns IndicesAndValuesResults < T >

  group results

  Example

  function indicator( v ) {
      return v[ 0 ];
  }
  var arr = [ 'beep', 'boop', 'foo', 'bar' ];
  
  var opts = {
      'returns': '*'
  };
  var out = groupBy( arr, opts, indicator );
  // returns { 'b': [ [ 0, 'beep' ], [ 1, 'boop' ], [ 3, 'bar' ] ], 'f': [ [ 2, 'foo' ] ] }