Data-Mate: `Core Utils`
Table of contents
Functions
- flattenStringArg
- freezeArray
- freezeObject
- getChildDataTypeConfig
- getFieldsFromArg
- getPointerArray
- getTypedArrayClass
Functions
flattenStringArg
▸ flattenStringArg<K
>(arg
): ReadonlySet
<K
>
Type parameters
Name | Type | ||
---|---|---|---|
K | extends string \ | number \ | symbol |
Parameters
Name | Type |
---|---|
arg | FieldArg <K >[] |
Returns
ReadonlySet
<K
>
Defined in
data-mate/src/core/utils.ts:33
freezeArray
▸ freezeArray<T
>(input
): T
extends Readonly
<infer U> ? Readonly
<U
> : Readonly
<T
>
Type parameters
Name | Type |
---|---|
T | extends ArrLike |
Parameters
Name | Type |
---|---|
input | T |
Returns
T
extends Readonly
<infer U> ? Readonly
<U
> : Readonly
<T
>
Defined in
data-mate/src/core/utils.ts:90
freezeObject
▸ freezeObject<T
>(input
): T
extends Readonly
<infer U> ? Readonly
<U
> : Readonly
<T
>
Type parameters
Name | Type |
---|---|
T | extends Record <string , any > |
Parameters
Name | Type |
---|---|
input | T |
Returns
T
extends Readonly
<infer U> ? Readonly
<U
> : Readonly
<T
>
Defined in
data-mate/src/core/utils.ts:82
getChildDataTypeConfig
▸ getChildDataTypeConfig(config
, baseField
, fieldType
): DataTypeFields
| undefined
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
Name | Type | |
---|---|---|
config | DataTypeFields \ | ReadonlyDataTypeFields |
baseField | string | |
fieldType | FieldType |
Returns
DataTypeFields
| undefined
Defined in
data-mate/src/core/utils.ts:102
getFieldsFromArg
▸ getFieldsFromArg<K
>(fields
, arg
): ReadonlySet
<K
>
Type parameters
Name | Type | ||
---|---|---|---|
K | extends string \ | number \ | symbol |
Parameters
Name | Type |
---|---|
fields | readonly K [] |
arg | FieldArg <K >[] |
Returns
ReadonlySet
<K
>
Defined in
data-mate/src/core/utils.ts:13
getPointerArray
▸ getPointerArray(size
): TypedArray
Gets the correctly sized TypeArray depending on the length of items
Parameters
Name | Type |
---|---|
size | number |
Returns
TypedArray
Defined in
data-mate/src/core/utils.ts:62
getTypedArrayClass
▸ getTypedArrayClass(size
): TypedArrayConstructor
Gets the correctly sized TypeArray constructor depending on the size of values being stored
Parameters
Name | Type |
---|---|
size | number |
Returns
TypedArrayConstructor