JSONPath Tools

Appearance

JSONPath Tools / @jsonpath-tools/jsonpath / SyntaxDescriptionService

Class: SyntaxDescriptionService ​

Provides a description for parts of a query syntax tree.

Constructors ​

Constructor ​

ts
new SyntaxDescriptionService(queryOptions): SyntaxDescriptionService;

Parameters ​

queryOptions ​

QueryOptions

Query options.

Returns ​

SyntaxDescriptionService

Methods ​

provideDescription() ​

ts
provideDescription(tree): SyntaxDescription | null;

Provides a description for the given part of a query syntax tree. When the part has no description available it returns null.

Parameters ​

tree ​

SyntaxTree

Part of a query syntax tree.

Returns ​

SyntaxDescription | null

provideDescriptionForAtToken() ​

ts
provideDescriptionForAtToken(): SyntaxDescription;

Provides a description for SyntaxTreeType.atToken.

Returns ​

SyntaxDescription

provideDescriptionForBooleanLiteralExpression() ​

ts
provideDescriptionForBooleanLiteralExpression(value): SyntaxDescription;

Provides a description for BooleanLiteralExpression.

Parameters ​

value ​

boolean

BooleanLiteralExpression.value.

Returns ​

SyntaxDescription

provideDescriptionForComparisonExpression() ​

ts
provideDescriptionForComparisonExpression(operator): SyntaxDescription;

Provides a description for ComparisonExpression.

Parameters ​

operator ​

ComparisonOperator

ComparisonExpression.operator.

Returns ​

SyntaxDescription

provideDescriptionForDollarToken() ​

ts
provideDescriptionForDollarToken(): SyntaxDescription;

Provides a description for SyntaxTreeType.dollarToken.

Returns ​

SyntaxDescription

provideDescriptionForFilterSelector() ​

ts
provideDescriptionForFilterSelector(): SyntaxDescription;

Provides a description for FilterSelector.

Returns ​

SyntaxDescription

provideDescriptionForFunctionExpression() ​

ts
provideDescriptionForFunctionExpression(name, functionDefinition?): SyntaxDescription;

Provides a description for FunctionExpression.

Parameters ​

name ​

string

FunctionExpression.name.

functionDefinition? ​

Function

Definition of the function.

Returns ​

SyntaxDescription

provideDescriptionForIndexSelector() ​

ts
provideDescriptionForIndexSelector(index?): SyntaxDescription;

Provides a description for IndexSelector.

Parameters ​

index? ​

number

IndexSelector.index.

Returns ​

SyntaxDescription

provideDescriptionForMissingSelector() ​

ts
provideDescriptionForMissingSelector(): SyntaxDescription;

Provides a description for MissingSelector.

Returns ​

SyntaxDescription

provideDescriptionForNameSelector() ​

ts
provideDescriptionForNameSelector(name?): SyntaxDescription;

Provides a description for NameSelector.

Parameters ​

name? ​

string

NameSelector.name.

Returns ​

SyntaxDescription

provideDescriptionForNullLiteralExpression() ​

ts
provideDescriptionForNullLiteralExpression(): SyntaxDescription;

Provides a description for NullLiteralExpression.

Returns ​

SyntaxDescription

provideDescriptionForNumberLiteralExpression() ​

ts
provideDescriptionForNumberLiteralExpression(value): SyntaxDescription;

Provides a description for NumberLiteralExpression.

Parameters ​

value ​

number

NumberLiteralExpression.value.

Returns ​

SyntaxDescription

provideDescriptionForQuery() ​

ts
provideDescriptionForQuery(queryType): SyntaxDescription;

Provides a description for SubQuery.

Parameters ​

queryType ​

QueryType

SubQuery.queryType.

Returns ​

SyntaxDescription

provideDescriptionForSliceSelector() ​

ts
provideDescriptionForSliceSelector(
   start?, 
   end?, 
   step?): SyntaxDescription;

Provides a description for SliceSelector.

Parameters ​

start? ​

number | null

SliceSelector.start.

end? ​

number | null

SliceSelector.end.

step? ​

number | null

SliceSelector.step.

Returns ​

SyntaxDescription

provideDescriptionForStringLiteralExpression() ​

ts
provideDescriptionForStringLiteralExpression(value): SyntaxDescription;

Provides a description for StringLiteralExpression.

Parameters ​

value ​

string

StringLiteralExpression.value.

Returns ​

SyntaxDescription

provideDescriptionForWildcardSelector() ​

ts
provideDescriptionForWildcardSelector(): SyntaxDescription;

Provides a description for WildcardSelector.

Returns ​

SyntaxDescription