@terascope/data-mate / vector/utils
vector/utils
Type Aliases
ParsedNumericObject
ParsedNumericObject =
object
Defined in: data-mate/src/vector/utils.ts:85
Properties
original?
optionaloriginal:string
Defined in: data-mate/src/vector/utils.ts:85
parsed
parsed:
number|bigint
Defined in: data-mate/src/vector/utils.ts:85
Functions
_newVector()
_newVector<
T>(data,options):Vector<T>
Defined in: data-mate/src/vector/utils.ts:16
Type Parameters
| Type Parameter |
|---|
T |
Parameters
| Parameter | Type |
|---|---|
data | DataBuckets<any> |
options | VectorOptions |
Returns
Vector<T>
getCommonFieldType()
getCommonFieldType(
field,a,b):FieldType
Defined in: data-mate/src/vector/utils.ts:197
Given two field types, return a common field type format. This will be flexible for string like and number like values.
Parameters
| Parameter | Type |
|---|---|
field | string |
a | FieldType |
b | FieldType |
Returns
FieldType
getCommonTupleType()
getCommonTupleType(
tupleField,childConfig):FieldType
Defined in: data-mate/src/vector/utils.ts:221
Parameters
| Parameter | Type |
|---|---|
tupleField | string |
childConfig | undefined | DataTypeFields |
Returns
FieldType
getNumericValues()
getNumericValues(
value,allowIP):NumericValuesResult
Defined in: data-mate/src/vector/utils.ts:102
Get all of the numeric values from a value or Vector (will return as [] of number|bigint UNLESS allowing IP and value is IP, then will return object with original value and parsed to number)
Parameters
| Parameter | Type | Default value |
|---|---|---|
value | unknown | undefined |
allowIP | boolean | false |
Returns
NumericValuesResult
isFloatLike()
isFloatLike(
type):boolean
Defined in: data-mate/src/vector/utils.ts:166
Parameters
| Parameter | Type |
|---|---|
type | FieldType |
Returns
boolean
isIntLike()
isIntLike(
type):boolean
Defined in: data-mate/src/vector/utils.ts:173
Parameters
| Parameter | Type |
|---|---|
type | FieldType |
Returns
boolean
isNumberLike()
isNumberLike(
type):boolean
Defined in: data-mate/src/vector/utils.ts:160
Parameters
| Parameter | Type |
|---|---|
type | FieldType |
Returns
boolean
isStringLike()
isStringLike(
type):boolean
Defined in: data-mate/src/vector/utils.ts:180
Parameters
| Parameter | Type |
|---|---|
type | FieldType |
Returns
boolean