xlucene-parser / utils

utils

Interfaces

Interface	Description
ParsedRange	-

Variables

coerceValueFns

const coerceValueFns: CoerceValueFns

Defined in: packages/xlucene-parser/src/utils.ts:247

---

groupTypes

const groupTypes: NodeType[]

Defined in: packages/xlucene-parser/src/utils.ts:129

logical group or field group with flow

---

logger

const logger: Logger

Defined in: packages/xlucene-parser/src/utils.ts:33

---

numberDataTypes

const numberDataTypes: xLuceneFieldType[]

Defined in: packages/xlucene-parser/src/utils.ts:96

---

termTypes

const termTypes: readonly NodeType[]

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

term level queries with field (string|null)

Functions

coordinateToXlucene()

coordinateToXlucene(cord): string

Defined in: packages/xlucene-parser/src/utils.ts:241

Parameters

Parameter	Type
cord	CoordinateTuple

Returns

string

---

createIPRangeFromTerm()

createIPRangeFromTerm(node, value): Range

Defined in: packages/xlucene-parser/src/utils.ts:291

Parameters

Parameter	Type
node	Term
value	string

Returns

Range

---

getField()

getField(node): undefined | string

Defined in: packages/xlucene-parser/src/utils.ts:108

Parameters

Parameter	Type
node	unknown

Returns

undefined | string

---

getFieldValue()

Call Signature

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

Defined in: packages/xlucene-parser/src/utils.ts:145

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
value	FieldValue<T>
variables	xLuceneVariables
allowNil	true

Returns

Maybe<T>

Call Signature

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

Defined in: packages/xlucene-parser/src/utils.ts:150

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
value	FieldValue<T>
variables	xLuceneVariables
allowNil?	boolean

Returns

T

Call Signature

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

Defined in: packages/xlucene-parser/src/utils.ts:155

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
value	FieldValue<T>[]
variables	xLuceneVariables
allowNil?	boolean

Returns

T[]

---

isBooleanDataType()

isBooleanDataType(node): node is BooleanDataType

Defined in: packages/xlucene-parser/src/utils.ts:104

Parameters

Parameter	Type
node	unknown

Returns

node is BooleanDataType

---

isConjunction()

isConjunction(node): node is Conjunction

Defined in: packages/xlucene-parser/src/utils.ts:44

Parameters

Parameter	Type
node	unknown

Returns

node is Conjunction

---

isEmptyNode()

isEmptyNode(node): node is EmptyNode

Defined in: packages/xlucene-parser/src/utils.ts:88

Parameters

Parameter	Type
node	unknown

Returns

node is EmptyNode

---

isExists()

isExists(node): node is Exists

Defined in: packages/xlucene-parser/src/utils.ts:56

Parameters

Parameter	Type
node	unknown

Returns

node is Exists

---

isFieldGroup()

isFieldGroup(node): node is FieldGroup

Defined in: packages/xlucene-parser/src/utils.ts:52

Parameters

Parameter	Type
node	unknown

Returns

node is FieldGroup

---

isFunctionNode()

isFunctionNode(node): node is FunctionNode

Defined in: packages/xlucene-parser/src/utils.ts:64

Parameters

Parameter	Type
node	unknown

Returns

node is FunctionNode

---

isGroupLike()

isGroupLike(node): node is GroupLikeNode

Defined in: packages/xlucene-parser/src/utils.ts:131

Parameters

Parameter	Type
node	unknown

Returns

node is GroupLikeNode

---

isInfiniteMax()

isInfiniteMax(max?): boolean

Defined in: packages/xlucene-parser/src/utils.ts:210

Parameters

Parameter	Type
max?	string | number

Returns

boolean

---

isInfiniteMin()

isInfiniteMin(min?): boolean

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

Parameters

Parameter	Type
min?	string | number

Returns

boolean

---

isInfiniteValue()

isInfiniteValue(input?): boolean

Defined in: packages/xlucene-parser/src/utils.ts:201

Parameters

Parameter	Type
input?	string | number

Returns

boolean

---

isLogicalGroup()

isLogicalGroup(node): node is LogicalGroup

Defined in: packages/xlucene-parser/src/utils.ts:40

Parameters

Parameter	Type
node	unknown

Returns

node is LogicalGroup

---

isNegation()

isNegation(node): node is Negation

Defined in: packages/xlucene-parser/src/utils.ts:48

Parameters

Parameter	Type
node	unknown

Returns

node is Negation

---

isNumberDataType()

isNumberDataType(node): node is NumberDataType

Defined in: packages/xlucene-parser/src/utils.ts:100

Parameters

Parameter	Type
node	unknown

Returns

node is NumberDataType

---

isRange()

isRange(node): node is Range

Defined in: packages/xlucene-parser/src/utils.ts:60

Parameters

Parameter	Type
node	unknown

Returns

node is Range

---

isRegexp()

isRegexp(node): node is Regexp

Defined in: packages/xlucene-parser/src/utils.ts:68

Parameters

Parameter	Type
node	unknown

Returns

node is Regexp

---

isStringDataType()

isStringDataType(node): node is StringDataType

Defined in: packages/xlucene-parser/src/utils.ts:92

Parameters

Parameter	Type
node	unknown

Returns

node is StringDataType

---

isTerm()

isTerm(node): node is Term

Defined in: packages/xlucene-parser/src/utils.ts:80

Parameters

Parameter	Type
node	unknown

Returns

node is Term

---

isTermList()

isTermList(node): node is TermList

Defined in: packages/xlucene-parser/src/utils.ts:84

Parameters

Parameter	Type
node	unknown

Returns

node is TermList

---

isTermType()

isTermType(node): node is TermLikeNode

Defined in: packages/xlucene-parser/src/utils.ts:124

Parameters

Parameter	Type
node	unknown

Returns

node is TermLikeNode

---

isWildcard()

isWildcard(node): node is Wildcard

Defined in: packages/xlucene-parser/src/utils.ts:72

Parameters

Parameter	Type
node	unknown

Returns

node is Wildcard

---

isWildcardField()

isWildcardField(node): boolean

Defined in: packages/xlucene-parser/src/utils.ts:76

Parameters

Parameter	Type
node	unknown

Returns

boolean

---

makeCoerceFn()

makeCoerceFn(fieldType): (v) => any

Defined in: packages/xlucene-parser/src/utils.ts:285

Parameters

Parameter	Type
fieldType	undefined | xLuceneFieldType

Returns

Function

Parameters

Parameter	Type
v	any

Returns

any

---

parseRange()

parseRange(node, variables, excludeInfinite): ParsedRange

Defined in: packages/xlucene-parser/src/utils.ts:222

Parameters

Parameter	Type	Default value
node	Range	undefined
variables	xLuceneVariables	undefined
excludeInfinite	boolean	false

Returns

ParsedRange

---

validateVariables()

validateVariables(obj): xLuceneVariables

Defined in: packages/xlucene-parser/src/utils.ts:135

Parameters

Parameter	Type
obj	xLuceneVariables

Returns

xLuceneVariables