Skip to main content

xlucene-parser / context

context

Functions​

makeContext()​

makeContext(arg): object

Defined in: xlucene-parser/src/context.ts:12

Parameters​

ParameterType
argContextArg

Returns​

coerceTermType​

coerceTermType: (node, _field?) => void

Parameters​
ParameterType
nodeany
_field?string
Returns​

void

getFieldType​

getFieldType: (field) => xLuceneFieldType | undefined

Parameters​
ParameterType
fieldstring
Returns​

xLuceneFieldType | undefined

isInferredTermType​

isInferredTermType: (field) => boolean

Parameters​
ParameterType
fieldstring
Returns​

boolean

logger​

logger: Logger = utils.logger

parseGeoDistance​

parseGeoDistance: (str) => GeoDistanceObj

Parameters​
ParameterType
strstring
Returns​

GeoDistanceObj

parseGeoPoint​

parseGeoPoint: {(point): GeoPoint; (point, throwInvalid): GeoPoint; (point, throwInvalid): GeoPoint | null; }

Call Signature​

(point): GeoPoint

Convert an input into a Geo Point object with lat and lon

Parameters​
ParameterType
pointunknown
Returns​

GeoPoint

Call Signature​

(point, throwInvalid): GeoPoint

Convert an input into a Geo Point object with lat and lon

Parameters​
ParameterType
pointunknown
throwInvalidtrue
Returns​

GeoPoint

Call Signature​

(point, throwInvalid): GeoPoint | null

Convert an input into a Geo Point object with lat and lon

Parameters​
ParameterType
pointunknown
throwInvalidfalse
Returns​

GeoPoint | null

parseInferredTermType​

parseInferredTermType: (field, value) => TermLikeNode

Parameters​
ParameterType
fieldstring
valueany
Returns​

TermLikeNode

propagateDefaultField​

propagateDefaultField: (node, field) => void

Propagate the default field on a field group expression

Parameters​
ParameterType
nodeNode
fieldstring
Returns​

void

throwOnOldGeoUsage​

throwOnOldGeoUsage: (term, field) => never

Parameters​
ParameterType
termRecord<string, any>
fieldstring
Returns​

never

validateScopedChars​

validateScopedChars: (chars) => void

Parameters​
ParameterType
charsstring[]
Returns​

void