@terascope/data-mate / core/utils
core/utils
Functions
flattenStringArg()
flattenStringArg<
K>(arg):ReadonlySet<K>
Defined in: data-mate/src/core/utils.ts:31
Type Parameters
| Type Parameter |
|---|
K extends string | number | symbol |
Parameters
| Parameter | Type |
|---|---|
arg | FieldArg<K>[] |
Returns
ReadonlySet<K>
freezeArray()
freezeArray<
T>(input):TextendsReadonly<U> ?Readonly<U> :Readonly<T>
Defined in: data-mate/src/core/utils.ts:88
Type Parameters
| Type Parameter |
|---|
T extends ArrLike |
Parameters
| Parameter | Type |
|---|---|
input | T |
Returns
T extends Readonly<U> ? Readonly<U> : Readonly<T>
freezeObject()
freezeObject<
T>(input):TextendsReadonly<U> ?Readonly<U> :Readonly<T>
Defined in: data-mate/src/core/utils.ts:80
Type Parameters
| Type Parameter |
|---|
T extends Record<string, any> |
Parameters
| Parameter | Type |
|---|---|
input | T |
Returns
T extends Readonly<U> ? Readonly<U> : Readonly<T>
getChildDataTypeConfig()
getChildDataTypeConfig(
config,baseField,fieldType):DataTypeFields|undefined
Defined in: data-mate/src/core/utils.ts:100
This is used in the Vector and Builder classes to get the correctly scoped field configurations since we use dot notation for nested field configurations
Parameters
| Parameter | Type |
|---|---|
config | DataTypeFields | ReadonlyDataTypeFields |
baseField | string |
fieldType | FieldType |
Returns
DataTypeFields | undefined
getFieldsFromArg()
getFieldsFromArg<
K>(fields,arg):ReadonlySet<K>
Defined in: data-mate/src/core/utils.ts:11
Type Parameters
| Type Parameter |
|---|
K extends string | number | symbol |
Parameters
| Parameter | Type |
|---|---|
fields | readonly K[] |
arg | FieldArg<K>[] |
Returns
ReadonlySet<K>
getPointerArray()
getPointerArray(
size):TypedArray
Defined in: data-mate/src/core/utils.ts:60
Gets the correctly sized TypeArray depending on the length of items
Parameters
| Parameter | Type |
|---|---|
size | number |
Returns
TypedArray
getTypedArrayClass()
getTypedArrayClass(
size):TypedArrayConstructor
Defined in: data-mate/src/core/utils.ts:68
Gets the correctly sized TypeArray constructor depending on the size of values being stored
Parameters
| Parameter | Type |
|---|---|
size | number |
Returns
TypedArrayConstructor