Class EvalClass
Index
Constructors
constructor
+EvalClass | jsonpath-plus
Class JSONPathClass
Index
Constructors
constructor
+JSONPathClass | jsonpath-plus
to
to
to
to
to
to
\ No newline at end of file
+like Class JSONPathClass
Index
Constructors
constructor
- new JSONPath
Class(): JSONPathClass Returns JSONPathClass
Properties
cache
cache: any
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
Constructors
constructor
- new JSONPath
Class(): JSONPathClass Returns JSONPathClass
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
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]. +$['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
@string() are silently stripped.
+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
\ No newline at end of file
+like 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
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
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]. +$['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
@string() are silently stripped.
+Parameters
- path: string[]
Returns any
\ No newline at end of file
+
diff --git a/docs/ts/index.html b/docs/ts/index.html
index 0465b94..85841c4 100644
--- a/docs/ts/index.html
+++ b/docs/ts/index.html
@@ -1,41 +1,44 @@
-
jsonpath-plus
jsonpath-plus
(see also licenses for dev. deps.)
-
JSONPath Plus
Analyse, transform, and selectively extract data from JSON +
(see also licenses for dev. deps.)
+JSONPath Plus
Analyse, transform, and selectively extract data from JSON documents (and JavaScript objects).
jsonpath-plus expands on the original specification to add some
additional operators and makes explicit some behaviors the original
did not spell out.
Try the browser demo or -Runkit (Node).
+Try the browser demo or +Runkit (Node).
Please note: This project is not currently being actively maintained. We may accept well-documented PRs or some simple updates, but are not looking to make fixes or add new features ourselves.
-Features
-
+
- Compliant with the original jsonpath spec -
- Convenient additions or elaborations not provided in the original spec:
-
+
- Convenient additions or elaborations not provided in the original spec:
+
^for grabbing the parent of a matching item~for grabbing property names of matching items (as array)
-- Type selectors for obtaining:
-
+
- Type selectors for obtaining:
+
- Basic JSON types:
@null(),@boolean(),@number(),@string(),@array(),@object() @integer()- The compound type
@scalar()(which also acceptsundefinedand - non-finite numbers when querying JavaScript objects as well as all of the basic non-object/non-function types)
+non-finite numbers when querying JavaScript objects as well as all of the basic non-object/non-function types)
- Basic JSON types:
@other()usable in conjunction with a user-definedotherTypeCallback- Non-JSON types that can nevertheless be used when querying
- non-JSON JavaScript objects (
@undefined(),@function(),@nonFinite())
+non-JSON JavaScript objects (
@undefined(),@function(),@nonFinite()) - Type selectors for obtaining:
+
@path/@parent/@property/@parentProperty/@rootshorthand selectors within filters
-- Escaping
-
+
- Escaping
+
`for escaping remaining sequence
-@['...']/?@['...']syntax for escaping special characters within - property names in filters
+@['...']/?@['...']syntax for escaping special characters within +property names in filters
- Documents
$..(getting all parent components)
@@ -43,34 +46,40 @@
- Escaping
+
- ESM and UMD export formats
- In addition to queried values, can return various meta-information - including paths or pointers to the value, as well as the parent - object and parent property name (to allow for modification). +including paths or pointers to the value, as well as the parent +object and parent property name (to allow for modification).
- Convenient additions or elaborations not provided in the original spec:
+
- Utilities for converting between paths, arrays, and pointers
- Option to prevent evaluations permitted in the original spec or supply - a sandbox for evaluated values. +a sandbox for evaluated values.
- Option for callback to handle results as they are obtained.
Features
Benchmarking
jsonpath-plus is consistently performant with both large and small datasets compared to other json querying libraries per json-querying-performance-testing. You can verify these findings by running the project yourself and adding more perf cases.
Install
npm install jsonpath-plus
-Setup
Node.js
const {JSONPath} = require('jsonpath-plus');
const result = JSONPath({path: '...', json});
-Browser
For browser usage you can directly include dist/index-browser-umd.cjs; no
+
Benchmarking
jsonpath-plus is consistently performant with both large and small datasets compared to other json querying libraries per json-querying-performance-testing. You can verify these findings by running the project yourself and adding more perf cases.
Install
npm install jsonpath-plus
+Setup
Node.js
const {JSONPath} = require('jsonpath-plus');
const result = JSONPath({path: '...', json});
+Browser
For browser usage you can directly include dist/index-browser-umd.cjs; no
Browserify magic is necessary:
<script src="node_modules/jsonpath-plus/dist/index-browser-umd.cjs"></script>
<script>
const result = JSONPath.JSONPath({path: '...', json: {}});
</script>
-ESM (Modern browsers)
You may also use ES6 Module imports (for modern browsers):
-<script type="module">
import {
JSONPath
} from './node_modules/jsonpath-plus/dist/index-browser-esm.js';
const result = JSONPath({path: '...', json: {}});
</script>
-ESM (Bundlers)
Or if you are bundling your JavaScript (e.g., with Rollup), just use,
-noting that mainFields
+
<script src="node_modules/jsonpath-plus/dist/index-browser-umd.cjs"></script>
<script>
const result = JSONPath.JSONPath({path: '...', json: {}});
</script>
+ESM (Modern browsers)
You may also use ES6 Module imports (for modern browsers):
+<script type="module">
import {
JSONPath
} from './node_modules/jsonpath-plus/dist/index-browser-esm.js';
const result = JSONPath({path: '...', json: {}});
</script>
+ESM (Bundlers)
Or if you are bundling your JavaScript (e.g., with Rollup), just use,
+noting that mainFields
should include browser for browser builds (for Node, the default, which
checks module, should be fine):
import {JSONPath} from 'jsonpath-plus';
const result = JSONPath({path: '...', json});
-Usage
The full signature available is:
+import {JSONPath} from 'jsonpath-plus';
const result = JSONPath({path: '...', json});
+Usage
The full signature available is:
const result = JSONPath([options,] path, json, callback, otherTypeCallback);
The arguments path, json, callback, and otherTypeCallback
can alternatively be expressed (along with any other of the
available properties) on options.
JSONPath's available arguments.
-See also the API docs.
-Properties
The properties that can be supplied on the options object or
+See the docs below for more on JSONPath's available arguments.
See also the API docs.
+Properties
The properties that can be supplied on the options object or evaluate method (as the first argument) include:
- path (required) - The JSONPath expression as a (normalized @@ -95,8 +104,8 @@
- resultType (default: "value") - 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, or as their parent's +as their absolute paths, as JSON Pointers +to the absolute paths, as their parent objects, or as their parent's property name. If set to "all", all of these types will be returned on an object with the type as key name.
- sandbox (default: {}) - Key-value map of variables to be
@@ -114,7 +123,7 @@
and one which is an empty array), it is recommended to switch the
default to
false. - eval (default: "safe") - Script evaluation method.
-
safe: In browser, it will use a minimal scripting engine which doesn't +safe: In browser, it will use a minimal scripting engine which doesn't useevalorFunctionand satisfies Content Security Policy. In NodeJS, it has no effect and is equivalent to native as scripting is safe there.native: uses the native scripting capabilities. i.e. unsafeevalor @@ -138,17 +147,17 @@ supplied will be the value of the payload (according toresultType), the type of the payload (whether it is a normal "value" or a "property" name), and a full payload object (with allresultTypes).
- - otherTypeCallback (default: <A function that throws an error** -**when @other() is encountered>) - In the current absence of JSON +
- otherTypeCallback (default: <A function that throws an error
+when @other() is encountered>) - In the current absence of JSON
Schema support, one can determine types beyond the built-in types by
-adding the operator
@other()at the end of one's query. If such a +adding the operator@other()at the end of one's query. If such a path is encountered, theotherTypeCallbackwill be invoked with the -value of the item, its path, its parent, and its parent's property name, +value of the item, its path, its parent, and its parent's property name, and it should return a boolean indicating whether the supplied value belongs to the "other" type or not (or it may handle transformations and return false).
Instance methods
-
+
- evaluate(path, json, callback, otherTypeCallback) OR
evaluate({path: <path>, json: <json object>, callback:
<callback function>, otherTypeCallback:
@@ -159,34 +168,67 @@
accept any of the other allowed instance properties (except
for
autostartwhich would have no relevance here). - JSONPath.cache - Exposes the cache object for those who wish to preserve and reuse it for optimization purposes.
- JSONPath.toPathArray(pathAsString) - Accepts a normalized or
unnormalized path as string and converts to an array: for
-example,
['$', 'aProperty', 'anotherProperty'].
+example, - JSONPath.toPathString(pathAsArray) - 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 +like:$['aProperty']['anotherProperty][0]. The JSONPath terminal constructions~and^and type operators like@string()are silently stripped. - JSONPath.toPointer(pathAsArray) - Accepts a path array and
-converts to a JSON Pointer.
+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.
Instance methods
Class properties and methods
-
+
Class properties and methods
['$', 'aProperty', 'anotherProperty'].
Syntax through examples
Given the following JSON, taken from http://goessner.net/articles/JsonPath/:
-{
"store": {
"book": [
{
"category": "reference",
"author": "Nigel Rees",
"title": "Sayings of the Century",
"price": 8.95
},
{
"category": "fiction",
"author": "Evelyn Waugh",
"title": "Sword of Honour",
"price": 12.99
},
{
"category": "fiction",
"author": "Herman Melville",
"title": "Moby Dick",
"isbn": "0-553-21311-3",
"price": 8.99
},
{
"category": "fiction",
"author": "J. R. R. Tolkien",
"title": "The Lord of the Rings",
"isbn": "0-395-19395-8",
"price": 22.99
}
],
"bicycle": {
"color": "red",
"price": 19.95
}
}
}
-Syntax through examples
Given the following JSON, taken from http://goessner.net/articles/JsonPath/:
+{
"store": {
"book": [
{
"category": "reference",
"author": "Nigel Rees",
"title": "Sayings of the Century",
"price": 8.95
},
{
"category": "fiction",
"author": "Evelyn Waugh",
"title": "Sword of Honour",
"price": 12.99
},
{
"category": "fiction",
"author": "Herman Melville",
"title": "Moby Dick",
"isbn": "0-553-21311-3",
"price": 8.99
},
{
"category": "fiction",
"author": "J. R. R. Tolkien",
"title": "The Lord of the Rings",
"isbn": "0-395-19395-8",
"price": 22.99
}
],
"bicycle": {
"color": "red",
"price": 19.95
}
}
}
+and the following XML representation:
-<store>
<book>
<category>reference</category>
<author>Nigel Rees</author>
<title>Sayings of the Century</title>
<price>8.95</price>
</book>
<book>
<category>fiction</category>
<author>Evelyn Waugh</author>
<title>Sword of Honour</title>
<price>12.99</price>
</book>
<book>
<category>fiction</category>
<author>Herman Melville</author>
<title>Moby Dick</title>
<isbn>0-553-21311-3</isbn>
<price>8.99</price>
</book>
<book>
<category>fiction</category>
<author>J. R. R. Tolkien</author>
<title>The Lord of the Rings</title>
<isbn>0-395-19395-8</isbn>
<price>22.99</price>
</book>
<bicycle>
<color>red</color>
<price>19.95</price>
</bicycle>
</store>
-
+
+ reference
+ Nigel Rees
+ Sayings of the Century
+ 8.95
+
+
+ fiction
+ Evelyn Waugh
+ Sword of Honour
+ 12.99
+
+
+ fiction
+ Herman Melville
+ Moby Dick
+ 0-553-21311-3
+ 8.99
+
+
+ fiction
+ J. R. R. Tolkien
+ The Lord of the Rings
+ 0-395-19395-8
+ 22.99
+
+
+ red
+ 19.95
+
+
+Please note that the XPath examples below do not distinguish between
retrieving elements and their text content (except where useful for
comparisons or to prevent ambiguity). Note: to test the XPath examples
-(including 2.0 ones), this demo
+(including 2.0 ones), this demo
may be helpful (set to xml or xml-strict).
| Notes | -|||||||
|---|---|---|---|---|---|---|---|
| /store/book/author | $.store.book[*].author | The authors of all books in the store | @@ -231,7 +274,7 @@//book[last()] | $..book[(@.length-1)] $..book[-1:] |
The last book in order. | -To access a property with a special character, utilize [(@['...'])] for the filter (this particular feature is not present in the original spec) |
+To access a property with a special character, utilize [(@['...'])] for the filter (this particular feature is not present in the original spec) |
| //book[position()<3] | @@ -249,7 +292,7 @@//book[isbn] | $..book[?(@.isbn)] | Filter all books with an ISBN number | -To access a property with a special character, utilize [?@['...']] for the filter (this particular feature is not present in the original spec) |
+To access a property with a special character, utilize [?@['...']] for the filter (this particular feature is not present in the original spec) |
||
| //book[price<10] | @@ -258,8 +301,8 @@|||||||
| //*[name() = 'price' and . != 8.95] | -$..*[?(@property === 'price' && @ !== 8.95)] | +//*[name() = 'price' and . != 8.95] | +$..*[?(@property === 'price' && @ !== 8.95)] | Obtain all property values of objects whose property is price and which does not equal 8.95 | With the bare @ allowing filtering objects by property value (not necessarily within arrays), you can add ^ after the expression to get at the object possessing the filtered properties |
||
| /store/book[not(. is /store/book[1])] (in XPath 2.0) | -$.store.book[?(@path !== "$['store']['book'][0]")] | +$.store.book[?(@path !== "$['store']['book'][0]")] | All books besides that at the path pointing to the first | @path not present in the original spec | @parent is not present in the original spec | ||
| //book/*[name() != 'category'] | +//book/*[name() != 'category'] | $..book.*[?(@property !== "category")] | Grabs all children of "book" except for "category" ones | @property is not present in the original spec | @@ -318,9 +361,9 @@@property is not present in the original spec | ||
| /store/*/*[name(parent::*) != 'book'] | +/store/*/*[name(parent::*) != 'book'] | $.store.*[?(@parentProperty !== "book")] | -Grabs the grandchildren of store whose parent property is not book (i.e., bicycle's children, "color" and "price") | +Grabs the grandchildren of store whose parent property is not book (i.e., bicycle's children, "color" and "price") | @parentProperty is not present in the original spec | ||
@number(), the other basic types (@boolean(), @string()), other low-level derived types (@null(), @object(), @array()), the JSONSchema-added type, @integer(), the compound type @scalar() (which also accepts undefined and non-finite numbers for JavaScript objects as well as all of the basic non-object/non-function types), the type, @other(), to be used in conjunction with a user-defined callback (see otherTypeCallback) and the following non-JSON types that can nevertheless be used with JSONPath when querying non-JSON JavaScript objects (@undefined(), @function(), @nonFinite()) are not present in the original spec |
|||||||
| //book/*[name() = 'category' and matches(., 'tion$')] (XPath 2.0) | +//book/*[name() = 'category' and matches(., 'tion$')] (XPath 2.0) | $..book.*[?(@property === "category" && @.match(/TION$/i))] | -All categories of books which match the regex (end in 'TION' case insensitive) | +All categories of books which match the regex (end in 'TION' case insensitive) | @property is not present in the original spec. | ||
| //book/[matches(name(), 'bn$')]/parent:: (XPath 2.0) | +//book/[matches(name(), 'bn$')]/parent:: (XPath 2.0) | $..book.*[?(@property.match(/bn$/i))]^ | -All books which have a property matching the regex (end in 'TION' case insensitive) | +All books which have a property matching the regex (end in 'TION' case insensitive) | @property is not present in the original spec. Note: Uses the parent selector ^ at the end of the expression to return to the parent object; without the parent selector, it matches the two isbn key values. |
||
| Escapes the entire sequence following (to be treated as a literal) | ` is not present in the original spec; to get a literal backtick, use an additional backtick to escape |
Any additional variables supplied as properties on the optional "sandbox" object option are also available to (parenthetical-based) evaluations.
-Potential sources of confusion for XPath users
-
+
- In JSONPath, a filter expression, in addition to its
@being a reference to its children, actually selects the immediate children as well, whereas in XPath, filter conditions do not select the children @@ -373,24 +417,26 @@ - In JSONPath, equality tests utilize (as per JavaScript) multiple equal signs whereas in XPath, they use a single equal sign.
- Support OR outside of filters (as in XPath
|) and grouping. - Create syntax to work like XPath filters in not selecting children?
- Allow option for parentNode equivalent (maintaining entire chain of - parent-and-parentProperty objects up to root) +parent-and-parentProperty objects up to root)
- Serve the js/html files:
- Visit http://localhost:8082/test/. +
- Visit http://localhost:8082/test/.
Potential sources of confusion for XPath users
Command line interface
A basic command line interface (CLI) is provided. Access it using npx jsonpath-plus <json-file> <jsonpath-query>.
Ideas
-
+
Command line interface
A basic command line interface (CLI) is provided. Access it using npx jsonpath-plus <json-file> <jsonpath-query>.
Ideas
Development
Running the tests on Node:
-npm test
-Development
Running the tests on Node:
+npm test
+For in-browser tests:
npm run browser-test
-npm run browser-test
+-
-
License
-License
+Interface JSONPathCallable
interface JSONPathCallable {
    <T>(options): JSONPathClass;
    <T>(options): T;
    <T>(path, json, callback, otherTypeCallback): T;
}
    <T>(options): JSONPathClass;
    <T>(options): T;
    <T>(path, json, callback, otherTypeCallback): T;
}
- 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, context) => 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, context) => 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
\ No newline at end of file
+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
Properties
Optional autostart
autostart?: boolean
If this is supplied as false, one may call the evaluate method - manually.
-Default
true
-Optional callback
If supplied, a callback will be called immediately upon retrieval of +
Properties
Optionalautostart
autostart?: boolean
If this is supplied as false, one may call the evaluate method +manually.
+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
a normal "value" or a "property" name), and a full payload object
(with all resultTypes).
Default
undefined
-Optional eval
Script evaluation method.
-safe: In browser, it will use a minimal scripting engine which doesn't
+
Optionaleval
eval?:
    | boolean
    | typeof EvalClass
    | "safe"
    | "native"
    | ((code: string, context: object) => any)
    | boolean
    | typeof EvalClass
    | "safe"
    | "native"
    | ((code: string, context: object) => any)
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.
native: uses the native scripting capabilities. i.e. unsafe eval or
Function in browser and vm.Script in nodejs.
true: Same as 'safe'
true: Same as 'safe'
false: Disable Javascript executions in path string. Same as preventEval: true in previous versions.
callback [ (code, context) => value]: A custom implementation which is called
with code and context as arguments to return the evaluated value.
class: A class similar to nodejs vm.Script. It will be created with code as constructor argument and the code
is evaluated by calling runInNewContext with context.
Type declaration
- (code, context): any
Parameters
- code: string
- context: object
Returns any
Default
'safe'
-Optional flatten
flatten?: boolean
Whether the returned array of results will be flattened to a - single dimension array.
-Default
false
-Optional ignore
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.
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.
+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.
Default
false
-json
json: string | number | boolean | object | any[]
The JSON object to evaluate (whether of null, boolean, number, - string, object, or array type).
-Optional other
In the current absence of JSON Schema support, +
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,
one can determine types beyond the built-in types by adding the
-perator @other() at the end of one's query.
@other() at the end of one's query.
If such a path is encountered, the otherTypeCallback will be invoked
-with the value of the item, its path, its parent, and its parent's
+with the value of the item, its path, its parent, and its parent's
property name, and it should return a boolean indicating whether the
supplied value belongs to the "other" type or not (or it may handle
transformations and return false).
Default
undefined
- <A function that throws an error when @other() is encountered>
Optional parent
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.
-Default
null
-Optional parent
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.
-Default
null
-path
path: string | any[]
The JSONPath expression as a (normalized or unnormalized) string or - array.
-Optional result
result
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, - or as their parent's property name.
+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", +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, +or as their parent's property name.
If set to "all", all of these types will be returned on an object with - the type as key name.
-Default
'value'
-Optional sandbox
sandbox?: Map<string, any>
Key-value map of variables to be available to code evaluations such - as filtering expressions. +the type as key name.
+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.)
-Optional wrap
wrap?: boolean
Whether or not to wrap the results in an array.
+expressions; see the Syntax section for details.) +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).
+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 - result will be the only item returned (not within an array).
+result will be the only item returned (not within an array).An array will still be returned if multiple results are found, however. To avoid ambiguities (in the case where it is necessary to distinguish between a result which is a failure and one which is an empty array), it is recommended to switch the default to false.
-Default
true
-Interface JSONPathOptionsAutoStart
interface JSONPathOptionsAutoStart {
    autostart: false;
    callback?: JSONPathCallback;
    eval?: boolean | typeof EvalClass | "safe" | "native" | ((code, context) => 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, context) => 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
\ No newline at end of file
+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
Properties
autostart
autostart: false
If this is supplied as false, one may call the evaluate method - manually.
-Default
true
-Optional callback
If supplied, a callback will be called immediately upon retrieval of +
Properties
autostart
autostart
If this is supplied as false, one may call the evaluate method +manually.
+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
a normal "value" or a "property" name), and a full payload object
(with all resultTypes).
Default
undefined
-Optional eval
Script evaluation method.
-safe: In browser, it will use a minimal scripting engine which doesn't
+
Optionaleval
eval?:
    | boolean
    | typeof EvalClass
    | "safe"
    | "native"
    | ((code: string, context: object) => any)
    | boolean
    | typeof EvalClass
    | "safe"
    | "native"
    | ((code: string, context: object) => any)
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.
native: uses the native scripting capabilities. i.e. unsafe eval or
Function in browser and vm.Script in nodejs.
true: Same as 'safe'
true: Same as 'safe'
false: Disable Javascript executions in path string. Same as preventEval: true in previous versions.
callback [ (code, context) => value]: A custom implementation which is called
with code and context as arguments to return the evaluated value.
class: A class similar to nodejs vm.Script. It will be created with code as constructor argument and the code
is evaluated by calling runInNewContext with context.
Type declaration
- (code, context): any
Parameters
- code: string
- context: object
Returns any
Default
'safe'
-Optional flatten
flatten?: boolean
Whether the returned array of results will be flattened to a - single dimension array.
-Default
false
-Optional ignore
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.
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.
+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.
Default
false
-json
json: string | number | boolean | object | any[]
The JSON object to evaluate (whether of null, boolean, number, - string, object, or array type).
-Optional other
In the current absence of JSON Schema support, +
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,
one can determine types beyond the built-in types by adding the
-perator @other() at the end of one's query.
@other() at the end of one's query.
If such a path is encountered, the otherTypeCallback will be invoked
-with the value of the item, its path, its parent, and its parent's
+with the value of the item, its path, its parent, and its parent's
property name, and it should return a boolean indicating whether the
supplied value belongs to the "other" type or not (or it may handle
transformations and return false).
Default
undefined
- <A function that throws an error when @other() is encountered>
Optional parent
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.
-Default
null
-Optional parent
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.
-Default
null
-path
path: string | any[]
The JSONPath expression as a (normalized or unnormalized) string or - array.
-Optional result
result
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, - or as their parent's property name.
+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", +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, +or as their parent's property name.
If set to "all", all of these types will be returned on an object with - the type as key name.
-Default
'value'
-Optional sandbox
sandbox?: Map<string, any>
Key-value map of variables to be available to code evaluations such - as filtering expressions. +the type as key name.
+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.)
-Optional wrap
wrap?: boolean
Whether or not to wrap the results in an array.
+expressions; see the Syntax section for details.) +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).
+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 - result will be the only item returned (not within an array).
+result will be the only item returned (not within an array).An array will still be returned if multiple results are found, however. To avoid ambiguities (in the case where it is necessary to distinguish between a result which is a failure and one which is an empty array), it is recommended to switch the default to false.
-Default
true
-
diff --git a/docs/ts/types/JSONPathCallback.html b/docs/ts/types/JSONPathCallback.html
index bd72929..6526de6 100644
--- a/docs/ts/types/JSONPathCallback.html
+++ b/docs/ts/types/JSONPathCallback.html
@@ -1 +1 @@
-
Type alias JSONPathCallback
JSONPath
Type declaration
- (payload, payloadType, fullPayload): any
Parameters
- payload: any
- payloadType: any
- fullPayload: any
Returns any
Type Alias JSONPathCallback
JSONPath
Type alias JSONPathOtherTypeCallback
JSONPath
Type declaration
- (...args): void
Parameters
Rest...args: any[]
Returns void
Type Alias JSONPathOtherTypeCallback
JSONPath
Exposes the cache object for those who wish to preserve and reuse - it for optimization purposes.
-