Skip to main content

@terascope/types / data-types

data-types

Index​

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>

The DataType fields configuration

Source​

data-types.ts:173

DataTypeVersion​

DataTypeVersion: 1

The major DataType config version

Source​

data-types.ts:85

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"

Deprecated​

use the enum FieldType

Source​

data-types.ts:46

ReadonlyDataTypeConfig​

ReadonlyDataTypeConfig: Readonly<Overwrite<DataTypeConfig, object>>

A readonly version of the DataTypeConfig

Source​

data-types.ts:197

ReadonlyDataTypeFields​

ReadonlyDataTypeFields: Record<string, Readonly<DataTypeFieldConfig>>

A readonly version of DataType fields configuration

Source​

data-types.ts:177

Variables​

availableFieldTypes​

const availableFieldTypes: ReadonlyArray<FieldType>

A list of all of the Field Types

Source​

data-types.ts:78

dataTypeVersions​

const dataTypeVersions: ReadonlyArray<number>

A list of DataType config versions

Source​

data-types.ts:90

indexedRequiredFieldTypes​

const indexedRequiredFieldTypes: object

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

Source​

data-types.ts:204