JSONPath Tools / @jsonpath-tools/jsonpath

@jsonpath-tools/jsonpath

JSONPath (RFC 9535) query evaluation, analysis and editor services.

Enumerations

Enumeration	Description
ComparisonOperator	Comparison operator.
CompletionItemTextType	Type of a completion item text.
CompletionItemType	Type of a completion item.
DiagnosticsSeverity	Severity of the diagnostics.
QueryType	Type of a query.
SegmentType	Type of a segment.
SyntaxTreeType	Type of a syntax tree.
Type	Type from the JSONPath type system.

Classes

Class	Description
AndExpression	Logical AND.
AnyDataType	Top data type. Contains all values.
ArrayDataType	Data type for JSON arrays. Contains all JSON arrays that meet criteria from prefixElementTypes, restElementType and requiredElementCount.
BooleanLiteralExpression	Boolean literal.
Checker	JSONPath query checker.
ComparisonExpression	Comparison.
CompletionItem	Completion item.
CompletionService	Provides completion items.
DataType	Data type. Refines the JSONPath types.
DataTypeAnnotation	Annotation of a data type (description, example values, ...).
Diagnostics	Diagnostics related to the query.
DocumentHighlight	One document highlight.
DocumentHighlightsService	Provides highlights of related symbols.
EditorService	Provides services for JSONPath editors.
FilterExpression	Expression in a filter selector.
FilterQueryExpression	Subquery in a filter expression.
FilterSelector	Filter selector.
FormattingService	Formats query text to be more readable and consistent.
FunctionExpression	Function.
IndexSelector	Index selector.
JSONPath	JSONPath evaluator compliant with standard RFC 9535.
JSONPathError	Error meaning that a JSONPath query is not well-formed or valid.
LiteralDataType	Unit data type. Contains only the value.
MissingExpression	Missing expression.
MissingSelector	Missing selector.
NameSelector	Name selector.
NeverDataType	Bottom data type. Contains no values.
Node	JSON value with its location.
NodeList	List of Nodes.
NotExpression	Logical NOT.
NullLiteralExpression	Null literal.
NumberLiteralExpression	Number literal.
ObjectDataType	Data type for JSON objects. Contains all JSON objects that meet criteria from propertyTypes, restPropertyType and requiredProperties.
OrExpression	Logical OR.
ParanthesisExpression	Paranthesis.
Parser	JSONPath query parser.
PrimitiveDataType	Data type for primitive JSON values and a special JSONPath value Nothing. Contains all values from type.
Query	JSONPath query.
Segment	Query segment.
Selector	Selector.
Signature	Signature.
SignatureHelpService	Provides a signature for a called function.
SignatureParameter	Signature parameter.
SliceSelector	Slice selector.
StringLiteralExpression	String literal.
SubQuery	Query.
SyntaxDescriptionService	Provides a description for parts of a query syntax tree.
SyntaxTree	Part of a query syntax tree.
SyntaxTreeNode	Nonterminal symbols of the grammar.
SyntaxTreeToken	Terminal symbols of the grammar.
TextChange	Represents a change of a text.
TextRange	Represents a contiguous range in a text.
Tooltip	Tooltip.
TooltipService	Provides tooltips with information about query parts.
UnionDataType	Sum data type. Contains values from an union of the types.
WildcardSelector	Wildcard selector.

Interfaces

Interface	Description
FilterExpressionContext	Context of a query filter selector filter expression evaluation.
Function	JSONPath function.
FunctionContext	Context of a function execution.
FunctionParameter	Parameter of a JSONPath function.
IndexOnlyArray	Array that can only be read
JSONSchemaWithURI	JSON schema with its URI.
JSONTypeDefinition	JSON Type Definition.
ObjectJSONSchema	-
PushOnlyArray	Array that can only be read and pushed into.
QueryContext	Context of a query evaluation.
QueryOptions	Defines an environment in which the JSONPath query is executed.

Type Aliases

Type Alias	Description
FilterValue	Value in filter expressions.
FunctionHandler	JavaScript function that implements a JSONPath function.
JSONSchema	JSON Schema.
JSONSchemaDictionary	-
JSONSchemaType	-
JSONTypeDefinitionDictionary	-
JSONTypeDefinitionType	-
JSONValue	Any JSON value.
LogicalType	LogicalTrue or LogicalFalse.
NodesType	NodeList.
NormalizedPath	JSONPath query syntactically constrained in a way that each node corresponds to exactly one normalized path, and each normalized path leads to at most one node.
NormalizedPathSegment	Segment of NormalizedPath. Property name or index.
ValueType	JSONValue or Nothing.

Variables

Variable	Description
defaultQueryOptions	Query options with functions from the JSONPath standard.
LogicalFalse	Represents a falsy value in filter expressions.
LogicalTrue	Represents a truthy value in filter expressions.
Nothing	Represents the absence of a JSON value.

Functions

Function	Description
isLogicalType	Checks whether the given filter value is an instance of LogicalType.
isNodesType	Checks whether the given filter value is an instance of NodesType.
isValueType	Checks whether the given filter value is an instance of ValueType.
jsonSchemaToType	Converts the given JSON Schema to a data type.
jsonTypeDefinitionToType	Converts the given JSON Type Definition (RFC 8927) to a data type.
removeAtPaths	Removes JSON values at the given normalized paths.
replaceAtPaths	Replaces JSON values at the given normalized paths.
serializeBoolean	Converts a boolean to a text representation.
serializedNormalizedPath	Converts a normalized path to a text representation.
serializeLiteral	Converts a literal to a text representation.
serializeNull	Converts a null to a text representation.
serializeNumber	Converts a number to a text representation.
serializeString	Converts a string to a text representation.