true
Optional
callbackIf 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 resultType
s).
undefined
Optional
flattenWhether the returned array of results will be flattened to a single dimension array.
false
The JSON object to evaluate (whether of null, boolean, number, string, object, or array type).
Optional
otherIn 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
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).
undefined
<A function that throws an error when @other()
is encountered>
Optional
parentIn 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.
null
Optional
parentIn 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.
null
The JSONPath expression as a (normalized or unnormalized) string or array.
Optional
preventAlthough JavaScript evaluation expressions are allowed by default, for security reasons (if one is operating on untrusted user input, for example), one may wish to set this option to true to throw exceptions when these expressions are attempted.
false
Optional
resultCan 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.
'value'
Optional
sandboxKey-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
wrapWhether 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 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.
true
Generated using TypeDoc
If this is supplied as false, one may call the evaluate method manually.