Types: `data-types`
Table of contents
Enumerations
Interfaces
Type Aliases
Variables
Type Aliases
DataTypeFields
Ƭ DataTypeFields: Record
<string
, DataTypeFieldConfig
>
The DataType fields configuration
Defined in
DataTypeVersion
Ƭ DataTypeVersion: 1
The major DataType config version
Defined in
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
Defined in
ReadonlyDataTypeConfig
Ƭ ReadonlyDataTypeConfig: Readonly
<Overwrite
<DataTypeConfig
, { fields
: ReadonlyDataTypeFields
}>>
A readonly version of the DataTypeConfig
Defined in
ReadonlyDataTypeFields
Ƭ ReadonlyDataTypeFields: Record
<string
, Readonly
<DataTypeFieldConfig
>>
A readonly version of DataType fields configuration
Defined in
Variables
availableFieldTypes
• Const
availableFieldTypes: ReadonlyArray
<FieldType
>
A list of all of the Field Types
Defined in
dataTypeVersions
• Const
dataTypeVersions: ReadonlyArray
<number
>
A list of DataType config versions
Defined in
indexedRequiredFieldTypes
• Const
indexedRequiredFieldTypes: Object
Type declaration
Name | Type |
---|---|
Domain | boolean |
GeoJSON | boolean |
Hostname | boolean |
KeywordCaseInsensitive | boolean |
KeywordPathAnalyzer | boolean |
KeywordTokens | boolean |
KeywordTokensCaseInsensitive | boolean |
NgramTokens | boolean |