Skip to main content

@terascope/types / data-types

data-types

Enumerations​

EnumerationDescription
DateFormatA list of valid valid formats for FieldType.Date. date-fns string format can be used, see https://date-fns.org/v2.16.1/docs/format
FieldTypeThe data type of a field
TimeResolution-

Interfaces​

InterfaceDescription
DataTypeConfigThe DataType fields config with version
DataTypeFieldConfigThe configuration for an individual field

Type Aliases​

DataTypeFields​

DataTypeFields = Record<string, DataTypeFieldConfig>

Defined in: packages/types/src/data-types.ts:179

The DataType fields configuration

DataTypeVersion​

DataTypeVersion = 1

Defined in: packages/types/src/data-types.ts:91

The major DataType config version

DeprecatedFieldType​

DeprecatedFieldType = "Boolean" | "Boundary" | "Byte" | "Date" | "Domain" | "Double" | "Float" | "Geo" | "GeoPoint" | "GeoJSON" | "Hostname" | "Integer" | "IPRange" | "IP" | "KeywordCaseInsensitive" | "KeywordTokensCaseInsensitive" | "KeywordPathAnalyzer" | "KeywordTokens" | "Keyword" | "Long" | "NgramTokens" | "Object" | "Short" | "Text" | "String" | "Number" | "Any"

Defined in: packages/types/src/data-types.ts:52

Deprecated​

use the enum FieldType

DTConfigWithDataGenOpts​

DTConfigWithDataGenOpts = Omit<DataTypeConfig, "fields"> & object

Defined in: packages/types/src/data-types.ts:262

Type Declaration​

fields​

fields: object

Index Signature​

[key: string]: DTFieldConfigWithDataGenOpts

DTFieldConfigWithDataGenOpts​

DTFieldConfigWithDataGenOpts = DataTypeFieldConfig & RandomDataFieldOptions

Defined in: packages/types/src/data-types.ts:260

RandomDataCategory​

RandomDataCategory = typeof _categories[number]

Defined in: packages/types/src/data-types.ts:225

ReadonlyDataTypeConfig​

ReadonlyDataTypeConfig = Readonly<Overwrite<DataTypeConfig, { fields: ReadonlyDataTypeFields; }>>

Defined in: packages/types/src/data-types.ts:203

A readonly version of the DataTypeConfig

ReadonlyDataTypeFields​

ReadonlyDataTypeFields = Record<string, Readonly<DataTypeFieldConfig>>

Defined in: packages/types/src/data-types.ts:183

A readonly version of DataType fields configuration

Variables​

availableFieldTypes​

const availableFieldTypes: ReadonlyArray<FieldType>

Defined in: packages/types/src/data-types.ts:84

A list of all of the Field Types

dataTypeVersions​

const dataTypeVersions: ReadonlyArray<number>

Defined in: packages/types/src/data-types.ts:96

A list of DataType config versions

indexedRequiredFieldTypes​

const indexedRequiredFieldTypes: object

Defined in: packages/types/src/data-types.ts:210

Type Declaration​

Domain​

Domain: boolean = true

GeoJSON​

GeoJSON: boolean = true

Hostname​

Hostname: boolean = true

KeywordCaseInsensitive​

KeywordCaseInsensitive: boolean = true

KeywordPathAnalyzer​

KeywordPathAnalyzer: boolean = true

KeywordTokens​

KeywordTokens: boolean = true

KeywordTokensCaseInsensitive​

KeywordTokensCaseInsensitive: boolean = true

NgramTokens​

NgramTokens: boolean = true

Vector​

Vector: boolean = true