@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

Parameter	Type
builders	Map<keyof T, Builder<unknown>>
records	T[]

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

Parameter	Type
columns	readonly Column<any, keyof T>[]
size	number

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

Parameter	Type
columns	readonly 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

Parameter	Type
builders	Map<keyof T, Builder<any>>
columns	readonly Column<any, keyof T>[]
offset	number

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

Parameter	Type
columns	readonly Column<any, keyof T>[]
indices	Iterable<number>
size	number

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

Parameter	Type
config	DataTypeConfig | Readonly<Overwrite<DataTypeConfig, { fields: ReadonlyDataTypeFields; }>>
records	T[]

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

Parameter	Type
_columns	readonly 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

Parameter	Type
n	number
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

Parameter	Type
columns	readonly Column<any, any>[]
row	number

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

Parameter	Type
keyAggs	Map<keyof T, KeyAggFn>
index	number

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

Parameter	Type
builders	Map<keyof T, Builder<any>>
buckets	Set<string>
getColumnValue	(name, i) => any

Returns

(row, key, index): void

Parameters

Parameter	Type
row	Partial<T>
key	string
index	number

Returns

void

---

processFieldFilter()

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

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

Parameters

Parameter	Type
indices	Set<number>
column	Column<any>
filter	(value) => boolean
json	boolean

Returns

void

---

splitOnNewLineIterator()

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

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

Parameters

Parameter	Type
data	string | Buffer<ArrayBufferLike>

Returns

Iterable<string | Buffer<ArrayBufferLike>>