xLucene Parser: `utils`
Table of contents
Interfaces
Variables
Functions
- coordinateToXlucene
- createIPRangeFromTerm
- getField
- getFieldValue
- isBooleanDataType
- isConjunction
- isEmptyNode
- isExists
- isFieldGroup
- isFunctionNode
- isGroupLike
- isInfiniteMax
- isInfiniteMin
- isInfiniteValue
- isLogicalGroup
- isNegation
- isNumberDataType
- isRange
- isRegexp
- isStringDataType
- isTerm
- isTermList
- isTermType
- isWildcard
- isWildcardField
- makeCoerceFn
- parseRange
- validateVariables
Variables
coerceValueFns
• Const
coerceValueFns: CoerceValueFns
Defined in
xlucene-parser/src/utils.ts:246
groupTypes
• Const
groupTypes: NodeType
[]
logical group or field group with flow
Defined in
xlucene-parser/src/utils.ts:128
logger
• Const
logger: Logger
Defined in
xlucene-parser/src/utils.ts:32
numberDataTypes
• Const
numberDataTypes: xLuceneFieldType
[]
Defined in
xlucene-parser/src/utils.ts:95
termTypes
• Const
termTypes: readonly NodeType
[]
term level queries with field (string|null)
Defined in
xlucene-parser/src/utils.ts:114
Functions
coordinateToXlucene
▸ coordinateToXlucene(cord
): string
Parameters
Name | Type |
---|---|
cord | CoordinateTuple |
Returns
string
Defined in
xlucene-parser/src/utils.ts:240
createIPRangeFromTerm
▸ createIPRangeFromTerm(node
, value
): Range
Parameters
Name | Type |
---|---|
node | Term |
value | string |
Returns
Defined in
xlucene-parser/src/utils.ts:290
getField
▸ getField(node
): string
| undefined
Parameters
Name | Type |
---|---|
node | unknown |
Returns
string
| undefined
Defined in
xlucene-parser/src/utils.ts:107
getFieldValue
▸ getFieldValue<T
>(value
, variables
, allowNil
): Maybe
<T
>
Type parameters
Name |
---|
T |
Parameters
Name | Type |
---|---|
value | FieldValue <T > |
variables | xLuceneVariables |
allowNil | true |
Returns
Maybe
<T
>
Defined in
xlucene-parser/src/utils.ts:144
▸ getFieldValue<T
>(value
, variables
, allowNil?
): T
Type parameters
Name |
---|
T |
Parameters
Name | Type |
---|---|
value | FieldValue <T > |
variables | xLuceneVariables |
allowNil? | boolean |
Returns
T
Defined in
xlucene-parser/src/utils.ts:149
▸ getFieldValue<T
>(value
, variables
, allowNil?
): T
[]
Type parameters
Name |
---|
T |
Parameters
Name | Type |
---|---|
value | FieldValue <T >[] |
variables | xLuceneVariables |
allowNil? | boolean |
Returns
T
[]
Defined in
xlucene-parser/src/utils.ts:154
isBooleanDataType
▸ isBooleanDataType(node
): node is BooleanDataType
Parameters
Name | Type |
---|---|
node | unknown |
Returns
node is BooleanDataType
Defined in
xlucene-parser/src/utils.ts:103
isConjunction
▸ isConjunction(node
): node is Conjunction
Parameters
Name | Type |
---|---|
node | unknown |
Returns
node is Conjunction
Defined in
xlucene-parser/src/utils.ts:43
isEmptyNode
▸ isEmptyNode(node
): node is EmptyNode
Parameters
Name | Type |
---|---|
node | unknown |
Returns
node is EmptyNode
Defined in
xlucene-parser/src/utils.ts:87
isExists
▸ isExists(node
): node is Exists
Parameters
Name | Type |
---|---|
node | unknown |
Returns
node is Exists
Defined in
xlucene-parser/src/utils.ts:55
isFieldGroup
▸ isFieldGroup(node
): node is FieldGroup
Parameters
Name | Type |
---|---|
node | unknown |
Returns
node is FieldGroup
Defined in
xlucene-parser/src/utils.ts:51
isFunctionNode
▸ isFunctionNode(node
): node is FunctionNode
Parameters
Name | Type |
---|---|
node | unknown |
Returns
node is FunctionNode
Defined in
xlucene-parser/src/utils.ts:63
isGroupLike
▸ isGroupLike(node
): node is GroupLikeNode
Parameters
Name | Type |
---|---|
node | unknown |
Returns
node is GroupLikeNode
Defined in
xlucene-parser/src/utils.ts:130
isInfiniteMax
▸ isInfiniteMax(max?
): boolean
Parameters
Name | Type | |
---|---|---|
max? | string \ | number |
Returns
boolean
Defined in
xlucene-parser/src/utils.ts:209
isInfiniteMin
▸ isInfiniteMin(min?
): boolean
Parameters
Name | Type | |
---|---|---|
min? | string \ | number |
Returns
boolean
Defined in
xlucene-parser/src/utils.ts:204
isInfiniteValue
▸ isInfiniteValue(input?
): boolean
Parameters
Name | Type | |
---|---|---|
input? | string \ | number |
Returns
boolean
Defined in
xlucene-parser/src/utils.ts:200
isLogicalGroup
▸ isLogicalGroup(node
): node is LogicalGroup
Parameters
Name | Type |
---|---|
node | unknown |
Returns
node is LogicalGroup
Defined in
xlucene-parser/src/utils.ts:39
isNegation
▸ isNegation(node
): node is Negation
Parameters
Name | Type |
---|---|
node | unknown |
Returns
node is Negation
Defined in
xlucene-parser/src/utils.ts:47
isNumberDataType
▸ isNumberDataType(node
): node is NumberDataType
Parameters
Name | Type |
---|---|
node | unknown |
Returns
node is NumberDataType
Defined in
xlucene-parser/src/utils.ts:99
isRange
▸ isRange(node
): node is Range
Parameters
Name | Type |
---|---|
node | unknown |
Returns
node is Range
Defined in
xlucene-parser/src/utils.ts:59
isRegexp
▸ isRegexp(node
): node is Regexp
Parameters
Name | Type |
---|---|
node | unknown |
Returns
node is Regexp
Defined in
xlucene-parser/src/utils.ts:67
isStringDataType
▸ isStringDataType(node
): node is StringDataType
Parameters
Name | Type |
---|---|
node | unknown |
Returns
node is StringDataType
Defined in
xlucene-parser/src/utils.ts:91
isTerm
▸ isTerm(node
): node is Term
Parameters
Name | Type |
---|---|
node | unknown |
Returns
node is Term
Defined in
xlucene-parser/src/utils.ts:79
isTermList
▸ isTermList(node
): node is TermList
Parameters
Name | Type |
---|---|
node | unknown |
Returns
node is TermList
Defined in
xlucene-parser/src/utils.ts:83
isTermType
▸ isTermType(node
): node is TermLikeNode
Parameters
Name | Type |
---|---|
node | unknown |
Returns
node is TermLikeNode
Defined in
xlucene-parser/src/utils.ts:123
isWildcard
▸ isWildcard(node
): node is Wildcard
Parameters
Name | Type |
---|---|
node | unknown |
Returns
node is Wildcard
Defined in
xlucene-parser/src/utils.ts:71
isWildcardField
▸ isWildcardField(node
): boolean
Parameters
Name | Type |
---|---|
node | unknown |
Returns
boolean
Defined in
xlucene-parser/src/utils.ts:75
makeCoerceFn
▸ makeCoerceFn(fieldType
): (v
: any
) => any
Parameters
Name | Type | |
---|---|---|
fieldType | undefined \ | xLuceneFieldType |
Returns
fn
▸ (v
): any
Parameters
Name | Type |
---|---|
v | any |
Returns
any
Defined in
xlucene-parser/src/utils.ts:284
parseRange
▸ parseRange(node
, variables
, excludeInfinite?
): ParsedRange
Parameters
Name | Type | Default value |
---|---|---|
node | Range | undefined |
variables | xLuceneVariables | undefined |
excludeInfinite | boolean | false |
Returns
Defined in
xlucene-parser/src/utils.ts:221
validateVariables
▸ validateVariables(obj
): xLuceneVariables
Parameters
Name | Type |
---|---|
obj | xLuceneVariables |
Returns
xLuceneVariables