xlucene-parser / utils

utils

Interfaces

Interface	Description
ParsedRange	-

Variables

coerceValueFns

const coerceValueFns: CoerceValueFns

Defined in: xlucene-parser/src/utils.ts:261

---

groupTypes

const groupTypes: NodeType[]

Defined in: xlucene-parser/src/utils.ts:115

logical group or field group with flow

---

logger

const logger: Logger

Defined in: xlucene-parser/src/utils.ts:19

---

numberDataTypes

const numberDataTypes: xLuceneFieldType[]

Defined in: xlucene-parser/src/utils.ts:82

---

termTypes

const termTypes: readonly NodeType[]

Defined in: xlucene-parser/src/utils.ts:101

term level queries with field (string|null)

Functions

coordinateToXlucene()

coordinateToXlucene(cord): string

Defined in: xlucene-parser/src/utils.ts:255

Parameters

Parameter	Type
cord	CoordinateTuple

Returns

string

---

createIPRangeFromTerm()

createIPRangeFromTerm(node, value): Range

Defined in: xlucene-parser/src/utils.ts:318

Convert an IP address or CIDR block term into a range query.

Parameters

Parameter	Type	Description
node	Term	The term node containing the IP value
value	string	The IP address or CIDR block string

Returns

Range

A range node representing the IP range

---

getField()

getField(node): string | undefined

Defined in: xlucene-parser/src/utils.ts:94

Parameters

Parameter	Type
node	unknown

Returns

string | undefined

---

getFieldValue()

Call Signature

getFieldValue<T>(value, variables, allowNil): Maybe<T>

Defined in: xlucene-parser/src/utils.ts:149

Resolve a field value or array of field values using the provided variables.

This function handles both literal values and variable references, resolving variables to their actual values from the variables object.

Type Parameters

Type Parameter
T

Parameters

Parameter	Type	Description
value	FieldValue<T>	The field value(s) to resolve
variables	xLuceneVariables	Object containing variable values
allowNil	true	Whether to allow undefined/null values

Returns

Maybe<T>

The resolved value(s)

Call Signature

getFieldValue<T>(value, variables, allowNil?): T

Defined in: xlucene-parser/src/utils.ts:154

Resolve a field value or array of field values using the provided variables.

This function handles both literal values and variable references, resolving variables to their actual values from the variables object.

Type Parameters

Type Parameter
T

Parameters

Parameter	Type	Description
value	FieldValue<T>	The field value(s) to resolve
variables	xLuceneVariables	Object containing variable values
allowNil?	boolean	Whether to allow undefined/null values

Returns

T

The resolved value(s)

Call Signature

getFieldValue<T>(value, variables, allowNil?): T[]

Defined in: xlucene-parser/src/utils.ts:159

Resolve a field value or array of field values using the provided variables.

This function handles both literal values and variable references, resolving variables to their actual values from the variables object.

Type Parameters

Type Parameter
T

Parameters

Parameter	Type	Description
value	FieldValue<T>[]	The field value(s) to resolve
variables	xLuceneVariables	Object containing variable values
allowNil?	boolean	Whether to allow undefined/null values

Returns

T[]

The resolved value(s)

---

isBooleanDataType()

isBooleanDataType(node): node is BooleanDataType

Defined in: xlucene-parser/src/utils.ts:90

Parameters

Parameter	Type
node	unknown

Returns

node is BooleanDataType

---

isConjunction()

isConjunction(node): node is Conjunction

Defined in: xlucene-parser/src/utils.ts:30

Parameters

Parameter	Type
node	unknown

Returns

node is Conjunction

---

isEmptyNode()

isEmptyNode(node): node is EmptyNode

Defined in: xlucene-parser/src/utils.ts:74

Parameters

Parameter	Type
node	unknown

Returns

node is EmptyNode

---

isExists()

isExists(node): node is Exists

Defined in: xlucene-parser/src/utils.ts:42

Parameters

Parameter	Type
node	unknown

Returns

node is Exists

---

isFieldGroup()

isFieldGroup(node): node is FieldGroup

Defined in: xlucene-parser/src/utils.ts:38

Parameters

Parameter	Type
node	unknown

Returns

node is FieldGroup

---

isFunctionNode()

isFunctionNode(node): node is FunctionNode

Defined in: xlucene-parser/src/utils.ts:50

Parameters

Parameter	Type
node	unknown

Returns

node is FunctionNode

---

isGroupLike()

isGroupLike(node): node is GroupLikeNode

Defined in: xlucene-parser/src/utils.ts:117

Parameters

Parameter	Type
node	unknown

Returns

node is GroupLikeNode

---

isInfiniteMax()

isInfiniteMax(max?): boolean

Defined in: xlucene-parser/src/utils.ts:214

Parameters

Parameter	Type
max?	string | number

Returns

boolean

---

isInfiniteMin()

isInfiniteMin(min?): boolean

Defined in: xlucene-parser/src/utils.ts:209

Parameters

Parameter	Type
min?	string | number

Returns

boolean

---

isInfiniteValue()

isInfiniteValue(input?): boolean

Defined in: xlucene-parser/src/utils.ts:205

Parameters

Parameter	Type
input?	string | number

Returns

boolean

---

isLogicalGroup()

isLogicalGroup(node): node is LogicalGroup

Defined in: xlucene-parser/src/utils.ts:26

Parameters

Parameter	Type
node	unknown

Returns

node is LogicalGroup

---

isNegation()

isNegation(node): node is Negation

Defined in: xlucene-parser/src/utils.ts:34

Parameters

Parameter	Type
node	unknown

Returns

node is Negation

---

isNumberDataType()

isNumberDataType(node): node is NumberDataType

Defined in: xlucene-parser/src/utils.ts:86

Parameters

Parameter	Type
node	unknown

Returns

node is NumberDataType

---

isRange()

isRange(node): node is Range

Defined in: xlucene-parser/src/utils.ts:46

Parameters

Parameter	Type
node	unknown

Returns

node is Range

---

isRegexp()

isRegexp(node): node is Regexp

Defined in: xlucene-parser/src/utils.ts:54

Parameters

Parameter	Type
node	unknown

Returns

node is Regexp

---

isStringDataType()

isStringDataType(node): node is StringDataType

Defined in: xlucene-parser/src/utils.ts:78

Parameters

Parameter	Type
node	unknown

Returns

node is StringDataType

---

isTerm()

isTerm(node): node is Term

Defined in: xlucene-parser/src/utils.ts:66

Parameters

Parameter	Type
node	unknown

Returns

node is Term

---

isTermList()

isTermList(node): node is TermList

Defined in: xlucene-parser/src/utils.ts:70

Parameters

Parameter	Type
node	unknown

Returns

node is TermList

---

isTermType()

isTermType(node): node is TermLikeNode

Defined in: xlucene-parser/src/utils.ts:110

Parameters

Parameter	Type
node	unknown

Returns

node is TermLikeNode

---

isWildcard()

isWildcard(node): node is Wildcard

Defined in: xlucene-parser/src/utils.ts:58

Parameters

Parameter	Type
node	unknown

Returns

node is Wildcard

---

isWildcardField()

isWildcardField(node): boolean

Defined in: xlucene-parser/src/utils.ts:62

Parameters

Parameter	Type
node	unknown

Returns

boolean

---

makeCoerceFn()

makeCoerceFn(fieldType): (v) => any

Defined in: xlucene-parser/src/utils.ts:305

Create a coercion function for the specified field type.

Parameters

Parameter	Type	Description
fieldType	xLuceneFieldType | undefined	The xLucene field type

Returns

A function that coerces values to the specified type

(v) => any

---

parseRange()

parseRange(node, variables, excludeInfinite?): ParsedRange

Defined in: xlucene-parser/src/utils.ts:234

Parse a range node into a simple object with comparison operators.

Parameters

Parameter	Type	Default value	Description
node	Range	undefined	The range node to parse
variables	xLuceneVariables	undefined	Variables for resolving variable references
excludeInfinite	boolean	false	Whether to exclude infinite values (* or ±Infinity)

Returns

ParsedRange

Object with comparison operators and their values

---

validateVariables()

validateVariables(obj): xLuceneVariables

Defined in: xlucene-parser/src/utils.ts:128

Validate and normalize a variables object.

Parameters

Parameter	Type	Description
obj	xLuceneVariables	The variables object to validate

Returns

xLuceneVariables

A normalized copy of the variables object

Throws

If the variables object is invalid