Skip to main content

@terascope/data-mate / data-frame/utils

data-frame/utils

Functions

buildRecords()

buildRecords<T>(builders, records): [keyof T, Builder<any>][]

Defined in: data-mate/src/data-frame/utils.ts:9

Type Parameters

Type Parameter
T extends Record<string, any>

Parameters

ParameterType
buildersMap<keyof T, Builder<unknown>>
recordsT[]

Returns

[keyof T, Builder<any>][]


columnsToBuilderEntries()

columnsToBuilderEntries<T>(columns, size): Iterable<[keyof T, Builder<unknown>]>

Defined in: data-mate/src/data-frame/utils.ts:84

Type Parameters

Type Parameter
T extends Record<string, unknown>

Parameters

ParameterType
columnsreadonly Column<any, keyof T>[]
sizenumber

Returns

Iterable<[keyof T, Builder<unknown>]>


columnsToDataTypeConfig()

columnsToDataTypeConfig<T>(columns): DataTypeConfig

Defined in: data-mate/src/data-frame/utils.ts:63

Type Parameters

Type Parameter
T extends Record<string, unknown>

Parameters

ParameterType
columnsreadonly Column<unknown, keyof T>[]

Returns

DataTypeConfig


concatColumnsToColumns()

concatColumnsToColumns<T>(builders, columns, offset): [keyof T, Builder<any>][]

Defined in: data-mate/src/data-frame/utils.ts:47

Type Parameters

Type Parameter
T extends Record<string, any>

Parameters

ParameterType
buildersMap<keyof T, Builder<any>>
columnsreadonly Column<any, keyof T>[]
offsetnumber

Returns

[keyof T, Builder<any>][]


createColumnsWithIndices()

createColumnsWithIndices<T>(columns, indices, size): readonly Column<any, keyof T>[]

Defined in: data-mate/src/data-frame/utils.ts:118

Type Parameters

Type Parameter
T extends Record<string, any>

Parameters

ParameterType
columnsreadonly Column<any, keyof T>[]
indicesIterable<number>
sizenumber

Returns

readonly Column<any, keyof T>[]


distributeRowsToColumns()

distributeRowsToColumns<T>(config, records): Column<any, keyof T>[]

Defined in: data-mate/src/data-frame/utils.ts:33

Type Parameters

Type Parameter
T extends Record<string, any>

Parameters

ParameterType
configDataTypeConfig | Readonly<Overwrite<DataTypeConfig, { fields: ReadonlyDataTypeFields; }>>
recordsT[]

Returns

Column<any, keyof T>[]


getSortedColumnsByValueCount()

getSortedColumnsByValueCount(_columns): readonly Column<any, any>[]

Defined in: data-mate/src/data-frame/utils.ts:202

Sort the columns by likelihood of the values being there, this was initially created to be used in combination with isEmptyRow

Parameters

ParameterType
_columnsreadonly Column<any, any>[]

Returns

readonly Column<any, any>[]


indicesFilterIterable()

indicesFilterIterable(n, fn): Iterable<number>

Defined in: data-mate/src/data-frame/utils.ts:140

Parameters

ParameterType
nnumber
fn(index) => boolean

Returns

Iterable<number>


isEmptyRow()

isEmptyRow(columns, row): boolean

Defined in: data-mate/src/data-frame/utils.ts:215

Verify the a column has null fields in a

Parameters

ParameterType
columnsreadonly Column<any, any>[]
rownumber

Returns

boolean


makeKeyForRow()

makeKeyForRow<T>(keyAggs, index): undefined | { key: string; row: Partial<T>; }

Defined in: data-mate/src/data-frame/utils.ts:167

Type Parameters

Type Parameter
T extends Record<string, any>

Parameters

ParameterType
keyAggsMap<keyof T, KeyAggFn>
indexnumber

Returns

undefined | { key: string; row: Partial<T>; }


makeUniqueRowBuilder()

makeUniqueRowBuilder<T>(builders, buckets, getColumnValue): (row, key, index) => void

Defined in: data-mate/src/data-frame/utils.ts:148

Type Parameters

Type Parameter
T extends Record<string, any>

Parameters

ParameterType
buildersMap<keyof T, Builder<any>>
bucketsSet<string>
getColumnValue(name, i) => any

Returns

Function

Parameters
ParameterType
rowPartial<T>
keystring
indexnumber
Returns

void


processFieldFilter()

processFieldFilter(indices, column, filter, json): void

Defined in: data-mate/src/data-frame/utils.ts:102

Parameters

ParameterType
indicesSet<number>
columnColumn<any>
filter(value) => boolean
jsonboolean

Returns

void


splitOnNewLineIterator()

splitOnNewLineIterator(data): Iterable<string | Buffer<ArrayBufferLike>>

Defined in: data-mate/src/data-frame/utils.ts:222

Parameters

ParameterType
datastring | Buffer<ArrayBufferLike>

Returns

Iterable<string | Buffer<ArrayBufferLike>>