Class EvalClass
Index
Constructors
Class JSONPathClass
Index
Constructors
constructor
+JSONPathClass | jsonpath-plus
to
to
to
to
to
to
Class JSONPathClass
Index
Constructors
constructor
- new JSONPath
Class(): JSONPathClass Returns JSONPathClass
Methods
evaluate
- evaluate(path, json, callback, otherTypeCallback): any
Parameters
- path: string | any[]
- json:
| string
| number
| boolean
| object
| any[] - callback: JSONPathCallback
- otherTypeCallback: JSONPathOtherTypeCallback
Returns any
- evaluate(options): any
Parameters
- options: {
callback: JSONPathCallback;
json:
| string
| number
| boolean
| object
| any[];
otherTypeCallback: JSONPathOtherTypeCallback;
path: string | any[];
}callback: JSONPathCallback
json:
| string
| number
| boolean
| object
| any[]other
Type Callback: JSONPathOtherTypeCallback path: string | any[]
Returns any
- options: {
to
Methods
evaluate
- evaluate(path, json, callback, otherTypeCallback): any
Parameters
- path: string | any[]
- json:
| string
| number
| boolean
| object
| any[] - callback: JSONPathCallback
- otherTypeCallback: JSONPathOtherTypeCallback
Returns any
- evaluate(options): any
Parameters
- options: {
callback: JSONPathCallback;
json:
| string
| number
| boolean
| object
| any[];
otherTypeCallback: JSONPathOtherTypeCallback;
path: string | any[];
}callback: JSONPathCallback
json:
| string
| number
| boolean
| object
| any[]other
Type Callback: JSONPathOtherTypeCallback path: string | any[]
Returns any
- options: {
to
to
to
- to
Path String(path): string Accepts a path array and converts to a normalized path string. The string will be in a form like:
-$['aProperty']['anotherProperty][0]. The JSONPath terminal constructions~and^and type operators like@string()are silently stripped.Parameters
- path: string[]
Returns string
to
to
- to
Pointer(path): any Accepts a path array and converts to a JSON Pointer.
The string will be in a form like:
/aProperty/anotherProperty/0(with any~and/internal characters escaped as per the JSON Pointer spec).The JSONPath terminal constructions
-~and^and type operators like@string()are silently stripped.Parameters
- path: string[]
Returns any
Parameters
- path: string[]
Returns any
Function JSONPath
- JSONPath<T>(options): JSONPathClass
Type Parameters
Parameters
- options: JSONPathOptionsAutoStart
Returns JSONPathClass
- JSONPath<T>(options): T
Type Parameters
Parameters
- options: JSONPathOptions
Returns T
- JSONPath<T>(path, json, callback, otherTypeCallback): T
Type Parameters
Parameters
- path: string | any[]
- json:
| string
| number
| boolean
| object
| any[] - callback: JSONPathCallback
- otherTypeCallback: JSONPathOtherTypeCallback
Returns T
Index
Properties
cache
+JSONPath | jsonpath-plus
to
to
to
to
to
to
Function JSONPath
- JSONPath<T>(options): JSONPathClass
Type Parameters
Parameters
- options: JSONPathOptionsAutoStart
Returns JSONPathClass
- JSONPath<T>(options): T
Type Parameters
Parameters
- options: JSONPathOptions
Returns T
- JSONPath<T>(path, json, callback, otherTypeCallback): T
Type Parameters
Parameters
- path: string | any[]
- json:
| string
| number
| boolean
| object
| any[] - callback: JSONPathCallback
- otherTypeCallback: JSONPathOtherTypeCallback
Returns T
Index
Properties
Methods
Properties
cache
cache: any
Exposes the cache object for those who wish to preserve and reuse it for optimization purposes.
- Methods
evaluate
- evaluate(path, json, callback, otherTypeCallback): any
Parameters
- path: string | any[]
- json:
| string
| number
| boolean
| object
| any[] - callback: JSONPathCallback
- otherTypeCallback: JSONPathOtherTypeCallback
Returns any
- evaluate(options): any
Parameters
- options: {
callback: JSONPathCallback;
json:
| string
| number
| boolean
| object
| any[];
otherTypeCallback: JSONPathOtherTypeCallback;
path: string | any[];
}callback: JSONPathCallback
json:
| string
| number
| boolean
| object
| any[]other
Type Callback: JSONPathOtherTypeCallback path: string | any[]
Returns any
- options: {
to
Methods
evaluate
- evaluate(path, json, callback, otherTypeCallback): any
Parameters
- path: string | any[]
- json:
| string
| number
| boolean
| object
| any[] - callback: JSONPathCallback
- otherTypeCallback: JSONPathOtherTypeCallback
Returns any
- evaluate(options): any
Parameters
- options: {
callback: JSONPathCallback;
json:
| string
| number
| boolean
| object
| any[];
otherTypeCallback: JSONPathOtherTypeCallback;
path: string | any[];
}callback: JSONPathCallback
json:
| string
| number
| boolean
| object
| any[]other
Type Callback: JSONPathOtherTypeCallback path: string | any[]
Returns any
- options: {
to
to
to
- to
Path String(path): string Accepts a path array and converts to a normalized path string. The string will be in a form like:
-$['aProperty']['anotherProperty][0]. The JSONPath terminal constructions~and^and type operators like@string()are silently stripped.Parameters
- path: string[]
Returns string
to
to
- to
Pointer(path): any Accepts a path array and converts to a JSON Pointer.
The string will be in a form like:
/aProperty/anotherProperty/0(with any~and/internal characters escaped as per the JSON Pointer spec).The JSONPath terminal constructions
-~and^and type operators like@string()are silently stripped.Parameters
- path: string[]
Returns any
Parameters
- path: string[]
Returns any
+
diff --git a/docs/ts/index.html b/docs/ts/index.html
index 85841c4..0f4dd3d 100644
--- a/docs/ts/index.html
+++ b/docs/ts/index.html
@@ -1,4 +1,4 @@
-
jsonpath-plus
jsonpath-plus
Interface JSONPathCallable
- JSONPath
Callable<T>(options): JSONPathClass Type Parameters
Parameters
- options: JSONPathOptionsAutoStart
Returns JSONPathClass
- JSONPath
Callable<T>(options): T Type Parameters
Parameters
- options: JSONPathOptions
Returns T
- JSONPath
Callable<T>(path, json, callback, otherTypeCallback): T Type Parameters
Parameters
- path: string | any[]
- json:
| string
| number
| boolean
| object
| any[] - callback: JSONPathCallback
- otherTypeCallback: JSONPathOtherTypeCallback
Returns T
Interface JSONPathCallable
- JSONPath
Callable<T>(options): JSONPathClass Type Parameters
Parameters
- options: JSONPathOptionsAutoStart
Returns JSONPathClass
- JSONPath
Callable<T>(options): T Type Parameters
Parameters
- options: JSONPathOptions
Returns T
- JSONPath
Callable<T>(path, json, callback, otherTypeCallback): T Type Parameters
Parameters
- path: string | any[]
- json:
| string
| number
| boolean
| object
| any[] - callback: JSONPathCallback
- otherTypeCallback: JSONPathOtherTypeCallback
Returns T
Interface JSONPathOptions
interface JSONPathOptions {
autostart?: boolean;
callback?: JSONPathCallback;
eval?:
| boolean
| typeof EvalClass
| "safe"
| "native"
| ((code: string, context: object) => any);
flatten?: boolean;
ignoreEvalErrors?: boolean;
json:
| string
| number
| boolean
| object
| any[];
otherTypeCallback?: JSONPathOtherTypeCallback;
parent?: any;
parentProperty?: any;
path: string | any[];
resultType?:
| "value"
| "path"
| "pointer"
| "parent"
| "parentProperty"
| "all";
sandbox?: Map<string, any>;
wrap?: boolean;
}
autostart?: boolean;
callback?: JSONPathCallback;
eval?:
| boolean
| typeof EvalClass
| "safe"
| "native"
| ((code: string, context: object) => any);
flatten?: boolean;
ignoreEvalErrors?: boolean;
json:
| string
| number
| boolean
| object
| any[];
otherTypeCallback?: JSONPathOtherTypeCallback;
parent?: any;
parentProperty?: any;
path: string | any[];
resultType?:
| "value"
| "path"
| "pointer"
| "parent"
| "parentProperty"
| "all";
sandbox?: Map<string, any>;
wrap?: boolean;
}
Hierarchy (view full)
- JSONPathOptions
Index
Properties
autostart?
+JSONPathOptions | jsonpath-plus
Interface JSONPathOptions
interface JSONPathOptions {
autostart?: boolean;
callback?: JSONPathCallback;
eval?:
| boolean
| typeof EvalClass
| "safe"
| "native"
| ((code: string, context: object) => any);
flatten?: boolean;
ignoreEvalErrors?: boolean;
json:
| string
| number
| boolean
| object
| any[];
otherTypeCallback?: JSONPathOtherTypeCallback;
parent?: any;
parentProperty?: any;
path: string | any[];
resultType?:
| "value"
| "path"
| "pointer"
| "parent"
| "parentProperty"
| "all";
sandbox?: Map<string, any>;
wrap?: boolean;
}
autostart?: boolean;
callback?: JSONPathCallback;
eval?:
| boolean
| typeof EvalClass
| "safe"
| "native"
| ((code: string, context: object) => any);
flatten?: boolean;
ignoreEvalErrors?: boolean;
json:
| string
| number
| boolean
| object
| any[];
otherTypeCallback?: JSONPathOtherTypeCallback;
parent?: any;
parentProperty?: any;
path: string | any[];
resultType?:
| "value"
| "path"
| "pointer"
| "parent"
| "parentProperty"
| "all";
sandbox?: Map<string, any>;
wrap?: boolean;
}
Hierarchy (view full)
- JSONPathOptions
Optionalcallback
If supplied, a callback will be called immediately upon retrieval of an end point value.
The three arguments supplied will be the value of the payload
(according to resultType), the type of the payload (whether it is
@@ -25,7 +25,7 @@
Optionaleval
Script evaluation method.
+Optionaleval
Script evaluation method.
safe: In browser, it will use a minimal scripting engine which doesn't
use eval or Function and satisfies Content Security Policy. In NodeJS,
it has no effect and is equivalent to native as scripting is safe there.
Optionalflatten
flatten?: boolean
Whether the returned array of results will be flattened to a +
Optionalflatten
flatten?: boolean
Whether the returned array of results will be flattened to a single dimension array.
Optionalignore
ignore
Ignore errors while evaluating JSONPath expression.
+Optionalignore
ignore
Ignore errors while evaluating JSONPath expression.
true: Don't break entire search if an error occurs while evaluating JSONPath expression on one key/value pair.
false: Break entire search if an error occurs while evaluating JSONPath expression on one key/value pair.
json
json:
| string
| number
| boolean
| object
| any[]
| string
| number
| boolean
| object
| any[]
The JSON object to evaluate (whether of null, boolean, number, +
json
json:
| string
| number
| boolean
| object
| any[]
| string
| number
| boolean
| object
| any[]
The JSON object to evaluate (whether of null, boolean, number, string, object, or array type).
-Optionalother
In the current absence of JSON Schema support, +
Optionalother
In the current absence of JSON Schema support,
one can determine types beyond the built-in types by adding the
perator @other() at the end of one's query.
If such a path is encountered, the otherTypeCallback will be invoked
@@ -63,20 +63,20 @@
transformations and return false).
Optionalparent
parent?: any
In the event that a query could be made to return the root node, +
Optionalparent
parent?: any
In the event that a query could be made to return the root node, this allows the parent of that root node to be returned within results.
Optionalparent
parent
In the event that a query could be made to return the root node, +
Optionalparent
parent
In the event that a query could be made to return the root node, this allows the parentProperty of that root node to be returned within results.
path
path: string | any[]
The JSONPath expression as a (normalized or unnormalized) string or +
path
path: string | any[]
The JSONPath expression as a (normalized or unnormalized) string or array.
-Optionalresult
result
| "value"
| "path"
| "pointer"
| "parent"
| "parentProperty"
| "all"
| "value"
| "path"
| "pointer"
| "parent"
| "parentProperty"
| "all"
Can be case-insensitive form of "value", "path", "pointer", "parent", +
Optionalresult
result
| "value"
| "path"
| "pointer"
| "parent"
| "parentProperty"
| "all"
| "value"
| "path"
| "pointer"
| "parent"
| "parentProperty"
| "all"
Can be case-insensitive form of "value", "path", "pointer", "parent", or "parentProperty" to determine respectively whether to return results as the values of the found items, as their absolute paths, as JSON Pointers to the absolute paths, as their parent objects, @@ -86,11 +86,11 @@
Optionalsandbox
sandbox?: Map<string, any>
Key-value map of variables to be available to code evaluations such +
Optionalsandbox
sandbox?: Map<string, any>
Key-value map of variables to be available to code evaluations such as filtering expressions. (Note that the current path and value will also be available to those expressions; see the Syntax section for details.)
-Optionalwrap
wrap?: boolean
Whether or not to wrap the results in an array.
+Optionalwrap
wrap?: boolean
Whether or not to wrap the results in an array.
If wrap is set to false, and no results are found, undefined will be returned (as opposed to an empty array when wrap is set to true).
If wrap is set to false and a single non-array result is found, that @@ -102,4 +102,4 @@
Interface JSONPathOptionsAutoStart
interface JSONPathOptionsAutoStart {
autostart: false;
callback?: JSONPathCallback;
eval?:
| boolean
| typeof EvalClass
| "safe"
| "native"
| ((code: string, context: object) => any);
flatten?: boolean;
ignoreEvalErrors?: boolean;
json:
| string
| number
| boolean
| object
| any[];
otherTypeCallback?: JSONPathOtherTypeCallback;
parent?: any;
parentProperty?: any;
path: string | any[];
resultType?:
| "value"
| "path"
| "pointer"
| "parent"
| "parentProperty"
| "all";
sandbox?: Map<string, any>;
wrap?: boolean;
}
autostart: false;
callback?: JSONPathCallback;
eval?:
| boolean
| typeof EvalClass
| "safe"
| "native"
| ((code: string, context: object) => any);
flatten?: boolean;
ignoreEvalErrors?: boolean;
json:
| string
| number
| boolean
| object
| any[];
otherTypeCallback?: JSONPathOtherTypeCallback;
parent?: any;
parentProperty?: any;
path: string | any[];
resultType?:
| "value"
| "path"
| "pointer"
| "parent"
| "parentProperty"
| "all";
sandbox?: Map<string, any>;
wrap?: boolean;
}
Hierarchy (view full)
- JSONPathOptions
- JSONPathOptionsAutoStart
Index
Properties
autostart
+JSONPathOptionsAutoStart | jsonpath-plus
Interface JSONPathOptionsAutoStart
interface JSONPathOptionsAutoStart {
autostart: false;
callback?: JSONPathCallback;
eval?:
| boolean
| typeof EvalClass
| "safe"
| "native"
| ((code: string, context: object) => any);
flatten?: boolean;
ignoreEvalErrors?: boolean;
json:
| string
| number
| boolean
| object
| any[];
otherTypeCallback?: JSONPathOtherTypeCallback;
parent?: any;
parentProperty?: any;
path: string | any[];
resultType?:
| "value"
| "path"
| "pointer"
| "parent"
| "parentProperty"
| "all";
sandbox?: Map<string, any>;
wrap?: boolean;
}
autostart: false;
callback?: JSONPathCallback;
eval?:
| boolean
| typeof EvalClass
| "safe"
| "native"
| ((code: string, context: object) => any);
flatten?: boolean;
ignoreEvalErrors?: boolean;
json:
| string
| number
| boolean
| object
| any[];
otherTypeCallback?: JSONPathOtherTypeCallback;
parent?: any;
parentProperty?: any;
path: string | any[];
resultType?:
| "value"
| "path"
| "pointer"
| "parent"
| "parentProperty"
| "all";
sandbox?: Map<string, any>;
wrap?: boolean;
}
Hierarchy (view full)
- JSONPathOptions
- JSONPathOptionsAutoStart
Optionalcallback
If supplied, a callback will be called immediately upon retrieval of an end point value.
The three arguments supplied will be the value of the payload
(according to resultType), the type of the payload (whether it is
@@ -25,7 +25,7 @@
Optionaleval
Script evaluation method.
+Optionaleval
Script evaluation method.
safe: In browser, it will use a minimal scripting engine which doesn't
use eval or Function and satisfies Content Security Policy. In NodeJS,
it has no effect and is equivalent to native as scripting is safe there.
Optionalflatten
flatten?: boolean
Whether the returned array of results will be flattened to a +
Optionalflatten
flatten?: boolean
Whether the returned array of results will be flattened to a single dimension array.
Optionalignore
ignore
Ignore errors while evaluating JSONPath expression.
+Optionalignore
ignore
Ignore errors while evaluating JSONPath expression.
true: Don't break entire search if an error occurs while evaluating JSONPath expression on one key/value pair.
false: Break entire search if an error occurs while evaluating JSONPath expression on one key/value pair.
json
json:
| string
| number
| boolean
| object
| any[]
| string
| number
| boolean
| object
| any[]
The JSON object to evaluate (whether of null, boolean, number, +
json
json:
| string
| number
| boolean
| object
| any[]
| string
| number
| boolean
| object
| any[]
The JSON object to evaluate (whether of null, boolean, number, string, object, or array type).
-Optionalother
In the current absence of JSON Schema support, +
Optionalother
In the current absence of JSON Schema support,
one can determine types beyond the built-in types by adding the
perator @other() at the end of one's query.
If such a path is encountered, the otherTypeCallback will be invoked
@@ -63,20 +63,20 @@
transformations and return false).
Optionalparent
parent?: any
In the event that a query could be made to return the root node, +
Optionalparent
parent?: any
In the event that a query could be made to return the root node, this allows the parent of that root node to be returned within results.
Optionalparent
parent
In the event that a query could be made to return the root node, +
Optionalparent
parent
In the event that a query could be made to return the root node, this allows the parentProperty of that root node to be returned within results.
path
path: string | any[]
The JSONPath expression as a (normalized or unnormalized) string or +
path
path: string | any[]
The JSONPath expression as a (normalized or unnormalized) string or array.
-Optionalresult
result
| "value"
| "path"
| "pointer"
| "parent"
| "parentProperty"
| "all"
| "value"
| "path"
| "pointer"
| "parent"
| "parentProperty"
| "all"
Can be case-insensitive form of "value", "path", "pointer", "parent", +
Optionalresult
result
| "value"
| "path"
| "pointer"
| "parent"
| "parentProperty"
| "all"
| "value"
| "path"
| "pointer"
| "parent"
| "parentProperty"
| "all"
Can be case-insensitive form of "value", "path", "pointer", "parent", or "parentProperty" to determine respectively whether to return results as the values of the found items, as their absolute paths, as JSON Pointers to the absolute paths, as their parent objects, @@ -86,11 +86,11 @@
Optionalsandbox
sandbox?: Map<string, any>
Key-value map of variables to be available to code evaluations such +
Optionalsandbox
sandbox?: Map<string, any>
Key-value map of variables to be available to code evaluations such as filtering expressions. (Note that the current path and value will also be available to those expressions; see the Syntax section for details.)
-Optionalwrap
wrap?: boolean
Whether or not to wrap the results in an array.
+Optionalwrap
wrap?: boolean
Whether or not to wrap the results in an array.
If wrap is set to false, and no results are found, undefined will be returned (as opposed to an empty array when wrap is set to true).
If wrap is set to false and a single non-array result is found, that @@ -102,4 +102,4 @@
jsonpath-plus
Index
Classes
Evaljsonpath-plus
jsonpath-plus
Index
Classes
Interfaces
JSONPathJSONPathCallback | jsonpath-plus JSONPathCallback | jsonpath-plus JSONPathOtherTypeCallback | jsonpath-plus JSONPathOtherTypeCallback | jsonpath-plus JSONPathType | jsonpath-plus JSONPathType | jsonpath-plus
Type Alias JSONPathCallback
JSONPath
Type Alias JSONPathCallback
JSONPath
Type Alias JSONPathOtherTypeCallback
JSONPath
Type Alias JSONPathOtherTypeCallback
JSONPath
Exposes the cache object for those who wish to preserve and reuse it for optimization purposes.
-