Class Grouping<KeyType, RowType>

A companion for the Table data structure when working with grouped data.

Type parameters

KeyType
RowType

Hierarchy

Grouping

Index

Constructors

constructor

Properties

data

Methods

Constructors

constructor

new Grouping<KeyType, RowType>(data: Map<KeyType, RowType[]>): Grouping<KeyType, RowType>

- Defined in Table.ts:17
Type parameters
- KeyType
- RowType
Parameters
- data: Map<KeyType, RowType[]>
Returns Grouping<KeyType, RowType>

Properties

data

data: Map<KeyType, RowType[]>

Methods

aggregate

aggregate<AggType>(aggFunc: (row: RowType[]) => AggType): Table<AggType & { id: KeyType }>

- Defined in Table.ts:21
Type parameters
- AggType
Parameters
- aggFunc: (row: RowType[]) => AggType
  - - (row: RowType[]): AggType
    - Parameters
      - row: RowType[]
      Returns AggType
Returns Table<AggType & { id: KeyType }>

aggregateByColumn

aggregateByColumn<AggFuncsMapType>(aggregations: AggFuncsMapType): Table<ExtractObjectFuncResults<AggFuncsMapType> & { id: KeyType }>

- Defined in Table.ts:25
Type parameters
- AggFuncsMapType: AggregationFuncMap<RowType>
Parameters
- aggregations: AggFuncsMapType
Returns Table<ExtractObjectFuncResults<AggFuncsMapType> & { id: KeyType }>

counts

counts(): Map<KeyType, number>

- Defined in Table.ts:49
Aggregates a grouping by returning the number of rows for each key

Returns Map<KeyType, number>
a Map of key => count

first

first(): Table<NonNullable<RowType & { id: KeyType }>>

- Defined in Table.ts:33
Aggregates the grouping by returning the first row for each key

Returns Table<NonNullable<RowType & { id: KeyType }>>
A Table of the aggregated output

last

last(): Table<NonNullable<RowType & { id: KeyType }>>

- Defined in Table.ts:41
Aggregates the grouping by returning the last row for each key

Returns Table<NonNullable<RowType & { id: KeyType }>>
A Table of the aggregated output

Generated using TypeDoc