xlucene-parser / interfaces
interfaces
Enumerations
| Enumeration | Description |
|---|---|
| NodeType | Enumeration of all possible AST node types. |
Interfaces
| Interface | Description |
|---|---|
| AnyDataType | Interface for nodes that can contain any type of data value. |
| BooleanDataType | Interface for nodes that contain boolean data values. |
| Conjunction | AST node representing a conjunction of terms (implicit AND operation). |
| ContextArg | Context argument passed to the PEG parser engine. |
| EmptyNode | Base interface for all AST nodes. |
| Exists | AST node representing a field existence check. |
| FieldGroup | AST node representing multiple operations on the same field. |
| FunctionConfig | - |
| FunctionDefinition | - |
| FunctionMethods | - |
| FunctionMethodsResults | - |
| FunctionNode | AST node representing a function call. |
| GroupLikeNode | Base interface for nodes that contain logical flow (LogicalGroup and FieldGroup). |
| LogicalGroup | AST node representing a logical grouping of terms with AND/OR operations. |
| Negation | AST node representing a negated term or group. |
| Node | Base interface for all AST nodes. |
| NumberDataType | Interface for nodes that contain numeric data values. |
| ParserOptions | Configuration options for the Parser constructor. |
| Range | AST node representing a range query. |
| RangeNode | Configuration for one side of a range query. |
| Regexp | AST node representing a regular expression pattern. |
| StringDataType | Interface for nodes that contain string data values. |
| Term | AST node representing a simple term query. |
| TermLikeNode | Base interface for nodes that represent searchable terms. |
| TermList | AST node representing a list of terms. |
| Wildcard | AST node representing a wildcard pattern. |
Type Aliases
Field
Field =
string|null
Defined in: packages/xlucene-parser/src/interfaces.ts:96
FieldValue<T>
FieldValue<
T> =FieldValueValue<T> |FieldValueVariable
Defined in: packages/xlucene-parser/src/interfaces.ts:114
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<T>
FieldValueValue<
T> =object
Defined in: packages/xlucene-parser/src/interfaces.ts:98
Type Parameters
| Type Parameter |
|---|
T |
Properties
type
type:
"value"
Defined in: packages/xlucene-parser/src/interfaces.ts:99
value
value:
T
Defined in: packages/xlucene-parser/src/interfaces.ts:100
FieldValueVariable
FieldValueVariable =
object
Defined in: packages/xlucene-parser/src/interfaces.ts:102
Properties
scoped
scoped:
boolean
Defined in: packages/xlucene-parser/src/interfaces.ts:104
type
type:
"variable"
Defined in: packages/xlucene-parser/src/interfaces.ts:103
value
value:
string
Defined in: packages/xlucene-parser/src/interfaces.ts:105
FunctionElasticsearchOptions
FunctionElasticsearchOptions =
object&Record<string,any>
Defined in: packages/xlucene-parser/src/interfaces.ts:354
Type Declaration
logger
logger:
Logger
type_config
type_config:
t.xLuceneTypeConfig
GroupLike
GroupLike =
FieldGroup|LogicalGroup
Defined in: packages/xlucene-parser/src/interfaces.ts:26
GroupLikeType
GroupLikeType =
LogicalGroup|FieldGroup
Defined in: packages/xlucene-parser/src/interfaces.ts:27
RangeOperator
RangeOperator =
"gte"|"gt"|"lt"|"lte"
Defined in: packages/xlucene-parser/src/interfaces.ts:240
TermLikeType
TermLikeType =
Term|Regexp|Range|Wildcard|Function|TermList
Defined in: packages/xlucene-parser/src/interfaces.ts:50