xlucene-parser / utils

utils

Index

Interfaces

Interface	Description
ParsedRange	-

Variables

coerceValueFns

const coerceValueFns: CoerceValueFns

Source

xlucene-parser/src/utils.ts:247

---

groupTypes

const groupTypes: NodeType[]

logical group or field group with flow

Source

xlucene-parser/src/utils.ts:129

---

logger

const logger: Logger

Source

xlucene-parser/src/utils.ts:33

---

numberDataTypes

const numberDataTypes: xLuceneFieldType[]

Source

xlucene-parser/src/utils.ts:96

---

termTypes

const termTypes: readonly NodeType[]

term level queries with field (string|null)

Source

xlucene-parser/src/utils.ts:115

Functions

coordinateToXlucene()

coordinateToXlucene(cord): string

Parameters

Parameter	Type
cord	CoordinateTuple

Returns

string

Source

xlucene-parser/src/utils.ts:241

---

createIPRangeFromTerm()

createIPRangeFromTerm(node, value): Range

Parameters

Parameter	Type
node	Term
value	string

Returns

Range

Source

xlucene-parser/src/utils.ts:291

---

getField()

getField(node): string | undefined

Parameters

Parameter	Type
node	unknown

Returns

string | undefined

Source

xlucene-parser/src/utils.ts:108

---

getFieldValue()

getFieldValue(value, variables, allowNil)

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

Type parameters

Type parameter
T

Parameters

Parameter	Type
value	FieldValue<T>
variables	xLuceneVariables
allowNil	true

Returns

Maybe<T>

Source

xlucene-parser/src/utils.ts:145

getFieldValue(value, variables, allowNil)

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

Type parameters

Type parameter
T

Parameters

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

Returns

T

Source

xlucene-parser/src/utils.ts:150

getFieldValue(value, variables, allowNil)

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

Type parameters

Type parameter
T

Parameters

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

Returns

T[]

Source

xlucene-parser/src/utils.ts:155

---

isBooleanDataType()

isBooleanDataType(node): node is BooleanDataType

Parameters

Parameter	Type
node	unknown

Returns

node is BooleanDataType

Source

xlucene-parser/src/utils.ts:104

---

isConjunction()

isConjunction(node): node is Conjunction

Parameters

Parameter	Type
node	unknown

Returns

node is Conjunction

Source

xlucene-parser/src/utils.ts:44

---

isEmptyNode()

isEmptyNode(node): node is EmptyNode

Parameters

Parameter	Type
node	unknown

Returns

node is EmptyNode

Source

xlucene-parser/src/utils.ts:88

---

isExists()

isExists(node): node is Exists

Parameters

Parameter	Type
node	unknown

Returns

node is Exists

Source

xlucene-parser/src/utils.ts:56

---

isFieldGroup()

isFieldGroup(node): node is FieldGroup

Parameters

Parameter	Type
node	unknown

Returns

node is FieldGroup

Source

xlucene-parser/src/utils.ts:52

---

isFunctionNode()

isFunctionNode(node): node is FunctionNode

Parameters

Parameter	Type
node	unknown

Returns

node is FunctionNode

Source

xlucene-parser/src/utils.ts:64

---

isGroupLike()

isGroupLike(node): node is GroupLikeNode

Parameters

Parameter	Type
node	unknown

Returns

node is GroupLikeNode

Source

xlucene-parser/src/utils.ts:131

---

isInfiniteMax()

isInfiniteMax(max?): boolean

Parameters

Parameter	Type
max?	string | number

Returns

boolean

Source

xlucene-parser/src/utils.ts:210

---

isInfiniteMin()

isInfiniteMin(min?): boolean

Parameters

Parameter	Type
min?	string | number

Returns

boolean

Source

xlucene-parser/src/utils.ts:205

---

isInfiniteValue()

isInfiniteValue(input?): boolean

Parameters

Parameter	Type
input?	string | number

Returns

boolean

Source

xlucene-parser/src/utils.ts:201

---

isLogicalGroup()

isLogicalGroup(node): node is LogicalGroup

Parameters

Parameter	Type
node	unknown

Returns

node is LogicalGroup

Source

xlucene-parser/src/utils.ts:40

---

isNegation()

isNegation(node): node is Negation

Parameters

Parameter	Type
node	unknown

Returns

node is Negation

Source

xlucene-parser/src/utils.ts:48

---

isNumberDataType()

isNumberDataType(node): node is NumberDataType

Parameters

Parameter	Type
node	unknown

Returns

node is NumberDataType

Source

xlucene-parser/src/utils.ts:100

---

isRange()

isRange(node): node is Range

Parameters

Parameter	Type
node	unknown

Returns

node is Range

Source

xlucene-parser/src/utils.ts:60

---

isRegexp()

isRegexp(node): node is Regexp

Parameters

Parameter	Type
node	unknown

Returns

node is Regexp

Source

xlucene-parser/src/utils.ts:68

---

isStringDataType()

isStringDataType(node): node is StringDataType

Parameters

Parameter	Type
node	unknown

Returns

node is StringDataType

Source

xlucene-parser/src/utils.ts:92

---

isTerm()

isTerm(node): node is Term

Parameters

Parameter	Type
node	unknown

Returns

node is Term

Source

xlucene-parser/src/utils.ts:80

---

isTermList()

isTermList(node): node is TermList

Parameters

Parameter	Type
node	unknown

Returns

node is TermList

Source

xlucene-parser/src/utils.ts:84

---

isTermType()

isTermType(node): node is TermLikeNode

Parameters

Parameter	Type
node	unknown

Returns

node is TermLikeNode

Source

xlucene-parser/src/utils.ts:124

---

isWildcard()

isWildcard(node): node is Wildcard

Parameters

Parameter	Type
node	unknown

Returns

node is Wildcard

Source

xlucene-parser/src/utils.ts:72

---

isWildcardField()

isWildcardField(node): boolean

Parameters

Parameter	Type
node	unknown

Returns

boolean

Source

xlucene-parser/src/utils.ts:76

---

makeCoerceFn()

makeCoerceFn(fieldType): (v) => any

Parameters

Parameter	Type
fieldType	undefined | xLuceneFieldType

Returns

Function

Parameters

Parameter	Type
v	any

Returns

any

Source

xlucene-parser/src/utils.ts:285

---

parseRange()

parseRange(node, variables, excludeInfinite): ParsedRange

Parameters

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

Returns

ParsedRange

Source

xlucene-parser/src/utils.ts:222

---

validateVariables()

validateVariables(obj): xLuceneVariables

Parameters

Parameter	Type
obj	xLuceneVariables

Returns

xLuceneVariables

Source

xlucene-parser/src/utils.ts:135