xLucene Parser: `Parser Parser`
parser.Parser
Parse a xLucene query
Table of contents
Constructors
Properties
Methods
Constructors
constructor
• new Parser(query
, options?
, _overrideNode?
): Parser
Parameters
Name | Type |
---|---|
query | string |
options? | ParserOptions |
_overrideNode? | Node |
Returns
Defined in
xlucene-parser/src/parser.ts:22
Properties
ast
• Readonly
ast: Node
Defined in
xlucene-parser/src/parser.ts:17
filterNilVariables
• Readonly
filterNilVariables: boolean
Defined in
xlucene-parser/src/parser.ts:20
query
• Readonly
query: string
Defined in
xlucene-parser/src/parser.ts:18
typeConfig
• Readonly
typeConfig: xLuceneTypeConfig
Defined in
xlucene-parser/src/parser.ts:19
Methods
filterNodes
▸ filterNodes(ast
, fn
): Node
Parameters
Name | Type |
---|---|
ast | Node |
fn | (node : Node , parent? : Node ) => boolean |
Returns
Defined in
xlucene-parser/src/parser.ts:88
forEachFieldValue
▸ forEachFieldValue(cb
): void
Iterate over all of the field value from Term-Like nodes, this is useful for validating values and variables.
Parameters
Name | Type |
---|---|
cb | (value : FieldValue <any >, node : TermLikeNode ) => void |
Returns
void
Defined in
xlucene-parser/src/parser.ts:264
forEachTermNode
▸ forEachTermNode(fieldValidator
, valueValidator
): void
Parameters
Name | Type |
---|---|
fieldValidator | (field : string ) => void |
valueValidator | (fieldValue : FieldValue <any >) => void |
Returns
void
Defined in
xlucene-parser/src/parser.ts:286
forTermTypes
▸ forTermTypes(cb
, skipFunctionParams?
): void
Iterate over all of the Term-Like nodes.
Parameters
Name | Type | Default value |
---|---|---|
cb | (node : TermLikeNode ) => void | undefined |
skipFunctionParams | boolean | true |
Returns
void
Defined in
xlucene-parser/src/parser.ts:249
forTypes
▸ forTypes<T
>(types
, cb
, skipFunctionParams?
): void
Recursively Iterate over all or select set of the nodes types
Type parameters
Name | Type | |
---|---|---|
T | extends readonly NodeType [] \ | NodeType [] |
Parameters
Name | Type | Default value |
---|---|---|
types | T | undefined |
cb | (node : Node ) => void | undefined |
skipFunctionParams | boolean | false |
Returns
void
Defined in
xlucene-parser/src/parser.ts:209
mapNode
▸ mapNode(fn
): Node
Map the Node and return a new Node
Parameters
Name | Type |
---|---|
fn | (node : Node , parent? : Node ) => Node |
Returns
Defined in
xlucene-parser/src/parser.ts:388
resolveVariables
▸ resolveVariables(variables
): Parser
Validate and resolve the variables, returns a new Parser instance
Parameters
Name | Type |
---|---|
variables | xLuceneVariables |