Data-Mate: `Data Frame Utils`
Table of contents
Functions
- buildRecords
- columnsToBuilderEntries
- columnsToDataTypeConfig
- concatColumnsToColumns
- createColumnsWithIndices
- distributeRowsToColumns
- getSortedColumnsByValueCount
- indicesFilterIterable
- isEmptyRow
- makeKeyForRow
- makeUniqueRowBuilder
- processFieldFilter
- splitOnNewLineIterator
Functions
buildRecords
▸ buildRecords<T
>(builders
, records
): [keyof T
, Builder
<any
>][]
Type parameters
Name | Type |
---|---|
T | extends Record <string , any > |
Parameters
Name | Type |
---|---|
builders | Map <keyof T , Builder <unknown >> |
records | T [] |
Returns
[keyof T
, Builder
<any
>][]
Defined in
data-mate/src/data-frame/utils.ts:9
columnsToBuilderEntries
▸ columnsToBuilderEntries<T
>(columns
, size
): Iterable
<[keyof T
, Builder
]>
Type parameters
Name | Type |
---|---|
T | extends Record <string , unknown > |
Parameters
Name | Type |
---|---|
columns | readonly Column <any , keyof T >[] |
size | number |
Returns
Iterable
<[keyof T
, Builder
]>
Defined in
data-mate/src/data-frame/utils.ts:84
columnsToDataTypeConfig
▸ columnsToDataTypeConfig<T
>(columns
): DataTypeConfig
Type parameters
Name | Type |
---|---|
T | extends Record <string , unknown > |
Parameters
Name | Type |
---|---|
columns | readonly Column <unknown , keyof T >[] |
Returns
DataTypeConfig
Defined in
data-mate/src/data-frame/utils.ts:63
concatColumnsToColumns
▸ concatColumnsToColumns<T
>(builders
, columns
, offset
): [keyof T
, Builder
<any
>][]
Type parameters
Name | Type |
---|---|
T | extends Record <string , any > |
Parameters
Name | Type |
---|---|
builders | Map <keyof T , Builder <any >> |
columns | readonly Column <any , keyof T >[] |
offset | number |
Returns
[keyof T
, Builder
<any
>][]
Defined in
data-mate/src/data-frame/utils.ts:47
createColumnsWithIndices
▸ createColumnsWithIndices<T
>(columns
, indices
, size
): readonly Column
<any
, keyof T
>[]
Type parameters
Name | Type |
---|---|
T | extends Record <string , any > |
Parameters
Name | Type |
---|---|
columns | readonly Column <any , keyof T >[] |
indices | Iterable <number > |
size | number |
Returns
readonly Column
<any
, keyof T
>[]
Defined in
data-mate/src/data-frame/utils.ts:117
distributeRowsToColumns
▸ distributeRowsToColumns<T
>(config
, records
): Column
<any
, keyof T
>[]
Type parameters
Name | Type |
---|---|
T | extends Record <string , any > |
Parameters
Name | Type | |
---|---|---|
config | DataTypeConfig \ | Readonly <Overwrite <DataTypeConfig , { fields : ReadonlyDataTypeFields }>> |
records | T [] |
Returns
Column
<any
, keyof T
>[]
Defined in
data-mate/src/data-frame/utils.ts:33
getSortedColumnsByValueCount
▸ getSortedColumnsByValueCount(_columns
): readonly Column
<any
, any
>[]
Sort the columns by likelihood of the values being there, this was initially created to be used in combination with isEmptyRow
Parameters
Name | Type |
---|---|
_columns | readonly Column <any , any >[] |
Returns
readonly Column
<any
, any
>[]
Defined in
data-mate/src/data-frame/utils.ts:201
indicesFilterIterable
▸ indicesFilterIterable(n
, fn
): Iterable
<number
>
Parameters
Name | Type |
---|---|
n | number |
fn | (index : number ) => boolean |
Returns
Iterable
<number
>
Defined in
data-mate/src/data-frame/utils.ts:139
isEmptyRow
▸ isEmptyRow(columns
, row
): boolean
Verify the a column has null fields in a
Parameters
Name | Type |
---|---|
columns | readonly Column <any , any >[] |
row | number |
Returns
boolean
Defined in
data-mate/src/data-frame/utils.ts:214
makeKeyForRow
▸ makeKeyForRow<T
>(keyAggs
, index
): { key
: string
; row
: Partial
<T
> } | undefined
Type parameters
Name | Type |
---|---|
T | extends Record <string , any > |
Parameters
Name | Type |
---|---|
keyAggs | Map <keyof T , KeyAggFn > |
index | number |
Returns
{ key
: string
; row
: Partial
<T
> } | undefined
Defined in
data-mate/src/data-frame/utils.ts:166
makeUniqueRowBuilder
▸ makeUniqueRowBuilder<T
>(builders
, buckets
, getColumnValue
): (row
: Partial
<T
>, key
: string
, index
: number
) => void
Type parameters
Name | Type |
---|---|
T | extends Record <string , any > |
Parameters
Name | Type |
---|---|
builders | Map <keyof T , Builder <any >> |
buckets | Set <string > |
getColumnValue | (name : keyof T , i : number ) => any |
Returns
fn
▸ (row
, key
, index
): void
Parameters
Name | Type |
---|---|
row | Partial <T > |
key | string |
index | number |
Returns
void
Defined in
data-mate/src/data-frame/utils.ts:147
processFieldFilter
▸ processFieldFilter(indices
, column
, filter
, json
): void
Parameters
Name | Type |
---|---|
indices | Set <number > |
column | Column <any , string > |
filter | (value : any ) => boolean |
json | boolean |
Returns
void
Defined in
data-mate/src/data-frame/utils.ts:101
splitOnNewLineIterator
▸ splitOnNewLineIterator(data
): Iterable
<Buffer
| string
>
Parameters
Name | Type | |
---|---|---|
data | string \ | Buffer |
Returns
Iterable
<Buffer
| string
>