@terascope/data-types / types

types

Type Aliases

GetTypeArg

GetTypeArg = object

Defined in: data-types/src/types/index.ts:115

Properties

config

config: DataTypeFieldConfig

Defined in: data-types/src/types/index.ts:117

field

field: string

Defined in: data-types/src/types/index.ts:116

version?

optional version?: number

Defined in: data-types/src/types/index.ts:118

Variables

LATEST_VERSION

const LATEST_VERSION: 1 = 1

Defined in: data-types/src/types/index.ts:11

Functions

getGroupedFields()

getGroupedFields(fields): GroupedFields

Defined in: data-types/src/types/index.ts:13

Parameters

Parameter	Type
fields	DataTypeFields

Returns

GroupedFields

---

getType()

getType(__namedParameters): default

Defined in: data-types/src/types/index.ts:121

Parameters

Parameter	Type
__namedParameters	GetTypeArg

Returns

default

---

getTypes()

getTypes(fields, groupedFields, version?): default[]

Defined in: data-types/src/types/index.ts:33

Instantiate all of the types for the group

Parameters

Parameter	Type	Default value
fields	DataTypeFields	undefined
groupedFields	GroupedFields	undefined
version	number	LATEST_VERSION

Returns

default[]

Todo

support multiple levels deep nesting