JSONPath Tools

Appearance

JSONPath Tools / @jsonpath-tools/jsonpath / Query

Class: Query ​

JSONPath query.

Extends ​

Constructors ​

Constructor ​

ts
new Query(
   query, 
   endOfFileToken, 
   syntaxDiagnostics): Query;

Parameters ​

query ​

SubQuery

Actual query.

endOfFileToken ​

SyntaxTreeToken

End-of-file token. Its main purpose is to collect a skipped text after the query in its SyntaxTreeToken.skippedTextBefore.

syntaxDiagnostics ​

readonly Diagnostics[]

Diagnostics of the query related to syntax.

Returns ​

Query

Overrides ​

SyntaxTreeNode.constructor

Properties ​

_parent ​

ts
_parent: SyntaxTreeNode | null = null;

Internal

Inherited from ​

SyntaxTreeNode._parent

children ​

ts
readonly children: SyntaxTree[];

Children.

Inherited from ​

SyntaxTreeNode.children

endOfFileToken ​

ts
readonly endOfFileToken: SyntaxTreeToken;

End-of-file token. Its main purpose is to collect a skipped text after the query in its SyntaxTreeToken.skippedTextBefore.

length ​

ts
readonly length: number;

Length in the text.

Inherited from ​

SyntaxTreeNode.length

position ​

ts
readonly position: number;

Position in the text.

Inherited from ​

SyntaxTreeNode.position

query ​

ts
readonly query: SubQuery;

Actual query.

syntaxDiagnostics ​

ts
readonly syntaxDiagnostics: readonly Diagnostics[];

Diagnostics of the query related to syntax.

Accessors ​

parent ​

Get Signature ​

ts
get parent(): SyntaxTreeNode | null;

Parent or null when no parent is assigned.

Returns ​

SyntaxTreeNode | null

Inherited from ​

SyntaxTreeNode.parent

skippedTextBefore ​

Get Signature ​

ts
get skippedTextBefore(): string;

Text that was skipped during parsing.

Returns ​

string

Text that was skipped during parsing.

Inherited from ​

SyntaxTreeNode.skippedTextBefore

textRange ​

Get Signature ​

ts
get textRange(): TextRange;

Range in the text.

Returns ​

TextRange

Inherited from ​

SyntaxTreeNode.textRange

textRangeWithoutSkipped ​

Get Signature ​

ts
get textRangeWithoutSkipped(): TextRange;

Range in the text excluding skipped text before.

Returns ​

TextRange

Inherited from ​

SyntaxTreeNode.textRangeWithoutSkipped

type ​

Get Signature ​

ts
get type(): SyntaxTreeType;

Type.

Returns ​

SyntaxTreeType

Type.

Overrides ​

SyntaxTreeNode.type

Methods ​

forEach() ​

ts
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

Inherited from ​

SyntaxTreeNode.forEach

getAtPosition() ​

ts
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

Inherited from ​

SyntaxTreeNode.getAtPosition

getContainingAtPosition() ​

ts
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

Inherited from ​

SyntaxTreeNode.getContainingAtPosition

getTouchingAtPosition() ​

ts
getTouchingAtPosition(caretPosition): SyntaxTree[];

Returns all innermost subtrees that touch the given caret position.

Parameters ​

caretPosition ​

number

Position (caret position index).

Returns ​

SyntaxTree[]

Inherited from ​

SyntaxTreeNode.getTouchingAtPosition

select() ​

ts
select(queryContext): NodeList;

Selects nodes from the given query argument.

Parameters ​

queryContext ​

QueryContext

Query context.

Returns ​

NodeList