JSONPath Tools / @jsonpath-tools/jsonpath / SyntaxTree
Abstract Class: SyntaxTree
Part of a query syntax tree.
Extended by
Constructors
Constructor
new SyntaxTree(position, length): SyntaxTree;Parameters
position
number
Position in the text.
length
number
Length in the text.
Returns
SyntaxTree
Properties
_parent
_parent: SyntaxTreeNode | null = null;Internal
length
readonly length: number;Length in the text.
position
readonly position: number;Position in the text.
skippedTextBefore
abstract readonly skippedTextBefore: string;Text that was skipped during parsing.
type
abstract readonly type: SyntaxTreeType;Type.
Accessors
parent
Get Signature
get parent(): SyntaxTreeNode | null;Parent or null when no parent is assigned.
Returns
SyntaxTreeNode | null
textRange
Get Signature
get textRange(): TextRange;Range in the text.
Returns
textRangeWithoutSkipped
Get Signature
get textRangeWithoutSkipped(): TextRange;Range in the text excluding skipped text before.
Returns
Methods
forEach()
abstract forEach(action): void;Executes the given action for this and all descendant trees in a pre-order tree traversal.
Parameters
action
(tree) => boolean | void
Action.
Returns
void
getAtPosition()
getAtPosition(characterPosition): SyntaxTree | null;Returns the innermost subtree that spans the given character position or null when the position is outside of a range of the current tree.
Parameters
characterPosition
number
Position (character index).
Returns
SyntaxTree | null
getContainingAtPosition()
getContainingAtPosition(caretPosition): SyntaxTree | null;Returns the innermost subtree that fully contains the given caret position (not just touches) or null when the position is not contained in a range of the current tree.
Parameters
caretPosition
number
Position (caret position index).
Returns
SyntaxTree | null
getTouchingAtPosition()
getTouchingAtPosition(caretPosition): SyntaxTree[];Returns all innermost subtrees that touch the given caret position.
Parameters
caretPosition
number
Position (caret position index).
Returns
SyntaxTree[]