Function groupBy

groupBy<T extends IteratorOrIterable<string>, U = string>(
arg: T,
key?: Iteratee<string, U>,
): IterableIterator<[U, string[]]>
Groups consecutive keys in the input iterator by some key identifier function or property. Functionally equivalent to the itertools.groupby function in Python. Generally the input iterator needs to be sorted by the same key. Each iteration will return the next group of values with the same key, until the key changes. So unless the input iterator is sorted beforehand, you may have broken up groups with the same keys.
Type Parameters
- T extends IteratorOrIterable<string>
- U = string
Parameters
- arg: T
  The input iterator or iterable.
- Optionalkey: Iteratee<string, U>
  The key identifier function or property name. If left undefined, and the value is a primitive, the value itself is used as a key. Iterators for object like values must use a key identifier.
Returns IterableIterator<[U, string[]]>
Example
```
groupby('AAAABBBCCDAABBB') // =>
   // ['A', ['A', 'A', 'A', 'A']],
   // ['B', ['B', 'B', 'B']],
   // ['C', ['C', 'C']],
   // ['D', ['D']],
   // ['A', ['A', 'A']],
   // ['B', ['B', 'B', 'B']]
```
- Defined in src/groupBy.ts:22
groupBy<T extends IteratorOrIterable<number>, U = number>(
arg: T,
key?: Iteratee<number, U>,
): IterableIterator<[U, number[]]>
Groups consecutive keys in the input iterator by some key identifier function or property. Functionally equivalent to the itertools.groupby function in Python. Generally the input iterator needs to be sorted by the same key. Each iteration will return the next group of values with the same key, until the key changes. So unless the input iterator is sorted beforehand, you may have broken up groups with the same keys.
Type Parameters
- T extends IteratorOrIterable<number>
- U = number
Parameters
- arg: T
  The input iterator or iterable.
- Optionalkey: Iteratee<number, U>
  The key identifier function or property name. If left undefined, and the value is a primitive, the value itself is used as a key. Iterators for object like values must use a key identifier.
Returns IterableIterator<[U, number[]]>
Example
```
groupby('AAAABBBCCDAABBB') // =>
   // ['A', ['A', 'A', 'A', 'A']],
   // ['B', ['B', 'B', 'B']],
   // ['C', ['C', 'C']],
   // ['D', ['D']],
   // ['A', ['A', 'A']],
   // ['B', ['B', 'B', 'B']]
```
- Defined in src/groupBy.ts:26
groupBy<T extends IteratorOrIterable<boolean>, U = boolean>(
arg: T,
key?: Iteratee<boolean, U>,
): IterableIterator<[U, boolean[]]>
Groups consecutive keys in the input iterator by some key identifier function or property. Functionally equivalent to the itertools.groupby function in Python. Generally the input iterator needs to be sorted by the same key. Each iteration will return the next group of values with the same key, until the key changes. So unless the input iterator is sorted beforehand, you may have broken up groups with the same keys.
Type Parameters
- T extends IteratorOrIterable<boolean>
- U = boolean
Parameters
- arg: T
  The input iterator or iterable.
- Optionalkey: Iteratee<boolean, U>
  The key identifier function or property name. If left undefined, and the value is a primitive, the value itself is used as a key. Iterators for object like values must use a key identifier.
Returns IterableIterator<[U, boolean[]]>
Example
```
groupby('AAAABBBCCDAABBB') // =>
   // ['A', ['A', 'A', 'A', 'A']],
   // ['B', ['B', 'B', 'B']],
   // ['C', ['C', 'C']],
   // ['D', ['D']],
   // ['A', ['A', 'A']],
   // ['B', ['B', 'B', 'B']]
```
- Defined in src/groupBy.ts:30
groupBy<
    T extends IteratorOrIterable<any>,
    K extends
        string | number | symbol | Iteratee<IterSource<T>, any> = Iteratee<
        IterSource<T>,
        IterSource<T>,
    >,
>(
    arg: T,
    key?: K,
): IterableIterator<
    [KeyIdentifiersValue<IterSource<T>, K>, IterSource<T>[]],
>
Groups consecutive keys in the input iterator by some key identifier function or property. Functionally equivalent to the itertools.groupby function in Python. Generally the input iterator needs to be sorted by the same key. Each iteration will return the next group of values with the same key, until the key changes. So unless the input iterator is sorted beforehand, you may have broken up groups with the same keys.
Type Parameters
- T extends IteratorOrIterable<any>
- K extends string | number | symbol | Iteratee<IterSource<T>, any> = Iteratee<IterSource<T>, IterSource<T>>
Parameters
- arg: T
  The input iterator or iterable.
- Optionalkey: K
  The key identifier function or property name. If left undefined, and the value is a primitive, the value itself is used as a key. Iterators for object like values must use a key identifier.
Returns IterableIterator<[KeyIdentifiersValue<IterSource<T>, K>, IterSource<T>[]]>
Example
```
groupby('AAAABBBCCDAABBB') // =>
   // ['A', ['A', 'A', 'A', 'A']],
   // ['B', ['B', 'B', 'B']],
   // ['C', ['C', 'C']],
   // ['D', ['D']],
   // ['A', ['A', 'A']],
   // ['B', ['B', 'B', 'B']]
```
- Defined in src/groupBy.ts:34

Function groupBy

Type Parameters

Parameters

Returns IterableIterator<[U, string[]]>

Example

Type Parameters

Parameters

Returns IterableIterator<[U, number[]]>

Example

Type Parameters

Parameters

Returns IterableIterator<[U, boolean[]]>

Example

Type Parameters

Parameters

Returns IterableIterator<[KeyIdentifiersValue<IterSource<T>, K>, IterSource<T>[]]>

Example

Settings