xlucene-parser / parser / Parser
Class: Parser
Defined in: packages/xlucene-parser/src/parser.ts:17
Parse a xLucene query
Constructors
new Parser()
new Parser(
query,options?,_overrideNode?):Parser
Defined in: packages/xlucene-parser/src/parser.ts:23
Parameters
| Parameter | Type |
|---|---|
query | string |
options? | ParserOptions |
_overrideNode? | Node |
Returns
Properties
| Property | Modifier | Type | Defined in |
|---|---|---|---|
ast | readonly | Node | packages/xlucene-parser/src/parser.ts:18 |
filterNilVariables | readonly | boolean | packages/xlucene-parser/src/parser.ts:21 |
query | readonly | string | packages/xlucene-parser/src/parser.ts:19 |
typeConfig | readonly | xLuceneTypeConfig | packages/xlucene-parser/src/parser.ts:20 |
Methods
filterNodes()
filterNodes(
ast,fn):Node
Defined in: packages/xlucene-parser/src/parser.ts:89
Parameters
| Parameter | Type |
|---|---|
ast | Node |
fn | (node, parent?) => boolean |
Returns
forEachFieldValue()
forEachFieldValue(
cb):void
Defined in: packages/xlucene-parser/src/parser.ts:267
Iterate over all of the field value from Term-Like nodes, this is useful for validating values and variables.
Parameters
| Parameter | Type |
|---|---|
cb | (value, node) => void |
Returns
void
forEachTermNode()
forEachTermNode(
fieldValidator,valueValidator):void
Defined in: packages/xlucene-parser/src/parser.ts:289
Parameters
| Parameter | Type |
|---|---|
fieldValidator | (field) => void |
valueValidator | (fieldValue) => void |
Returns
void
forTermTypes()
forTermTypes(
cb,skipFunctionParams):void
Defined in: packages/xlucene-parser/src/parser.ts:252
Iterate over all of the Term-Like nodes.
Parameters
| Parameter | Type | Default value |
|---|---|---|
cb | (node) => void | undefined |
skipFunctionParams | boolean | true |
Returns
void
forTypes()
forTypes<
T>(types,cb,skipFunctionParams):void
Defined in: packages/xlucene-parser/src/parser.ts:212
Recursively Iterate over all or select set of the nodes types
Type Parameters
| Type Parameter |
|---|
T extends readonly NodeType[] | NodeType[] |
Parameters
| Parameter | Type | Default value |
|---|---|---|
types | T | undefined |
cb | (node) => void | undefined |
skipFunctionParams | boolean | false |
Returns
void
mapNode()
mapNode(
fn):Node
Defined in: packages/xlucene-parser/src/parser.ts:391
Map the Node and return a new Node
Parameters
| Parameter | Type |
|---|---|
fn | (node, parent?) => Node |
Returns
resolveVariables()
resolveVariables(
variables):Parser
Defined in: packages/xlucene-parser/src/parser.ts:358
Validate and resolve the variables, returns a new Parser instance
Parameters
| Parameter | Type |
|---|---|
variables | xLuceneVariables |