Skip to main content

xlucene-parser / interfaces

interfaces

Enumerations​

EnumerationDescription
NodeTypeEnumeration of all possible AST node types.

Interfaces​

InterfaceDescription
AnyDataTypeInterface for nodes that can contain any type of data value.
BooleanDataTypeInterface for nodes that contain boolean data values.
ConjunctionAST node representing a conjunction of terms (implicit AND operation).
ContextArgContext argument passed to the PEG parser engine.
EmptyNodeBase interface for all AST nodes.
ExistsAST node representing a field existence check.
FieldGroupAST node representing multiple operations on the same field.
FunctionConfig-
FunctionDefinition-
FunctionMethods-
FunctionMethodsResultsSimilar to t.ElasticsearchDSLResult
FunctionNodeAST node representing a function call.
GroupLikeNodeBase interface for nodes that contain logical flow (LogicalGroup and FieldGroup).
LogicalGroupAST node representing a logical grouping of terms with AND/OR operations.
NegationAST node representing a negated term or group.
NodeBase interface for all AST nodes.
NumberDataTypeInterface for nodes that contain numeric data values.
ParserOptionsConfiguration options for the Parser constructor.
RangeAST node representing a range query.
RangeNodeConfiguration for one side of a range query.
RegexpAST node representing a regular expression pattern.
StringDataTypeInterface for nodes that contain string data values.
TermAST node representing a simple term query.
TermLikeNodeBase interface for nodes that represent searchable terms.
TermListAST node representing a list of terms.
WildcardAST node representing a wildcard pattern.

Type Aliases​

Field​

Field = string | null

Defined in: xlucene-parser/src/interfaces.ts:98


FieldValue​

FieldValue<T> = FieldValueValue<T> | FieldValueVariable

Defined in: xlucene-parser/src/interfaces.ts:116

Union type representing either a literal value or a variable reference.

Field values can be either concrete values or references to variables that will be resolved later.

Type Parameters​

Type Parameter
T

FieldValueValue​

FieldValueValue<T> = object

Defined in: xlucene-parser/src/interfaces.ts:100

Type Parameters​

Type Parameter
T

Properties​

type​

type: "value"

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

value​

value: T

Defined in: xlucene-parser/src/interfaces.ts:102


FieldValueVariable​

FieldValueVariable = object

Defined in: xlucene-parser/src/interfaces.ts:104

Properties​

scoped​

scoped: boolean

Defined in: xlucene-parser/src/interfaces.ts:106

type​

type: "variable"

Defined in: xlucene-parser/src/interfaces.ts:105

value​

value: string

Defined in: xlucene-parser/src/interfaces.ts:107


FunctionElasticsearchOptions​

FunctionElasticsearchOptions = t.XluceneTranslateQueryOptions

Defined in: xlucene-parser/src/interfaces.ts:357


GroupLike​

GroupLike = FieldGroup | LogicalGroup

Defined in: xlucene-parser/src/interfaces.ts:28


GroupLikeType​

GroupLikeType = LogicalGroup | FieldGroup

Defined in: xlucene-parser/src/interfaces.ts:29


RangeOperator​

RangeOperator = "gte" | "gt" | "lt" | "lte"

Defined in: xlucene-parser/src/interfaces.ts:242


TermLikeType​

TermLikeType = Term | Regexp | Range | Wildcard | Function | TermList

Defined in: xlucene-parser/src/interfaces.ts:52