@terascope/types / xlucene-interfaces

xlucene-interfaces

Enumerations

Enumeration	Description
xLuceneFieldType	-

Interfaces

Interface	Description
XluceneBaseOptions	-
xLuceneTypeConfig	-
xLuceneVariables	xLucene variable definitions

Type Aliases

XluceneGeoSortConfig

XluceneGeoSortConfig = object

Defined in: packages/types/src/xlucene-interfaces.ts:47

Properties

default_order

default_order: SortOrder

Defined in: packages/types/src/xlucene-interfaces.ts:55

default_unit

default_unit: GeoDistanceUnit

Defined in: packages/types/src/xlucene-interfaces.ts:56

field?

optional field?: string

Defined in: packages/types/src/xlucene-interfaces.ts:49

order?

optional order?: SortOrder

Defined in: packages/types/src/xlucene-interfaces.ts:52

point?

optional point?: GeoPoint

Defined in: packages/types/src/xlucene-interfaces.ts:50

unit?

optional unit?: GeoDistanceUnit

Defined in: packages/types/src/xlucene-interfaces.ts:53

---

XluceneTranslateQueryOptions

XluceneTranslateQueryOptions = XluceneBaseOptions & Partial<ClientMetadata> & object

Defined in: packages/types/src/xlucene-interfaces.ts:42

Type Declaration

geo_sort_config?

optional geo_sort_config?: XluceneGeoSortConfig

logger?

optional logger?: Logger

Functions

isXLuceneFieldType()

isXLuceneFieldType(value): value is xLuceneFieldType

Defined in: packages/types/src/xlucene-interfaces.ts:21

Parameters

Parameter	Type
value	any

Returns

value is xLuceneFieldType