-
-
Notifications
You must be signed in to change notification settings - Fork 201
Expand file tree
/
Copy pathJSONPathOptions.html
More file actions
105 lines (96 loc) · 38 KB
/
Copy pathJSONPathOptions.html
File metadata and controls
105 lines (96 loc) · 38 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>JSONPathOptions | jsonpath-plus</title><meta name="description" content="Documentation for jsonpath-plus"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">jsonpath-plus</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">jsonpath-plus</a></li><li><a href="JSONPathOptions.html">JSONPathOptions</a></li></ul><h1>Interface JSONPathOptions</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">JSONPathOptions</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="JSONPathOptions.html#autostart">autostart</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="JSONPathOptions.html#callback">callback</a><span class="tsd-signature-symbol">?:</span> <a href="../types/JSONPathCallback.html" class="tsd-signature-type tsd-kind-type-alias">JSONPathCallback</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="JSONPathOptions.html#eval">eval</a><span class="tsd-signature-symbol">?:</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">boolean</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-keyword">typeof</span> <a href="../classes/EvalClass.html" class="tsd-signature-type tsd-kind-class">EvalClass</a><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"safe"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"native"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">context</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="JSONPathOptions.html#flatten">flatten</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="JSONPathOptions.html#ignoreevalerrors">ignoreEvalErrors</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="JSONPathOptions.html#json">json</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">object</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="JSONPathOptions.html#othertypecallback">otherTypeCallback</a><span class="tsd-signature-symbol">?:</span> <a href="../types/JSONPathOtherTypeCallback.html" class="tsd-signature-type tsd-kind-type-alias">JSONPathOtherTypeCallback</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="JSONPathOptions.html#parent">parent</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="JSONPathOptions.html#parentproperty">parentProperty</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="JSONPathOptions.html#path">path</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="JSONPathOptions.html#resulttype">resultType</a><span class="tsd-signature-symbol">?:</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"value"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"path"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"pointer"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"parent"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"parentProperty"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"all"</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="JSONPathOptions.html#sandbox">sandbox</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="JSONPathOptions.html#wrap">wrap</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy" data-refl="18"><h4>Hierarchy (<a href="../hierarchy.html#JSONPathOptions">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">JSONPathOptions</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="JSONPathOptionsAutoStart.html" class="tsd-signature-type tsd-kind-interface">JSONPathOptionsAutoStart</a></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/JSONPath-Plus/JSONPath/blob/af59d678c327e38b0e10cf724cdf563aa662546e/src/jsonpath.d.ts#L16">jsonpath.d.ts:16</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="JSONPathOptions.html#autostart" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>autostart?</span></a>
<a href="JSONPathOptions.html#callback" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>callback?</span></a>
<a href="JSONPathOptions.html#eval" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>eval?</span></a>
<a href="JSONPathOptions.html#flatten" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>flatten?</span></a>
<a href="JSONPathOptions.html#ignoreevalerrors" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ignore<wbr/>Eval<wbr/>Errors?</span></a>
<a href="JSONPathOptions.html#json" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>json</span></a>
<a href="JSONPathOptions.html#othertypecallback" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>other<wbr/>Type<wbr/>Callback?</span></a>
<a href="JSONPathOptions.html#parent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>parent?</span></a>
<a href="JSONPathOptions.html#parentproperty" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>parent<wbr/>Property?</span></a>
<a href="JSONPathOptions.html#path" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>path</span></a>
<a href="JSONPathOptions.html#resulttype" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>result<wbr/>Type?</span></a>
<a href="JSONPathOptions.html#sandbox" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>sandbox?</span></a>
<a href="JSONPathOptions.html#wrap" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>wrap?</span></a>
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="autostart" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>autostart</span><a href="#autostart" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">autostart</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>If this is supplied as false, one may call the evaluate method
manually.</p>
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link"><a id="default" class="tsd-anchor"></a>Default<a href="#default" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">true</span>
</code><button type="button">Copy</button></pre>
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/JSONPath-Plus/JSONPath/blob/af59d678c327e38b0e10cf724cdf563aa662546e/src/jsonpath.d.ts#L33">jsonpath.d.ts:33</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="callback" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>callback</span><a href="#callback" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">callback</span><span class="tsd-signature-symbol">?:</span> <a href="../types/JSONPathCallback.html" class="tsd-signature-type tsd-kind-type-alias">JSONPathCallback</a></div><div class="tsd-comment tsd-typography"><p>If supplied, a callback will be called immediately upon retrieval of
an end point value.</p>
<p>The three arguments supplied will be the value of the payload
(according to <code>resultType</code>), the type of the payload (whether it is
a normal "value" or a "property" name), and a full payload object
(with all <code>resultType</code>s).</p>
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link"><a id="default-1" class="tsd-anchor"></a>Default<a href="#default-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">undefined</span>
</code><button type="button">Copy</button></pre>
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/JSONPath-Plus/JSONPath/blob/af59d678c327e38b0e10cf724cdf563aa662546e/src/jsonpath.d.ts#L140">jsonpath.d.ts:140</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="eval" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>eval</span><a href="#eval" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">eval</span><span class="tsd-signature-symbol">?:</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">boolean</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-keyword">typeof</span> <a href="../classes/EvalClass.html" class="tsd-signature-type tsd-kind-class">EvalClass</a><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"safe"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"native"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">context</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">any</span></div><div class="tsd-comment tsd-typography"><p>Script evaluation method.</p>
<p><code>safe</code>: In browser, it will use a minimal scripting engine which doesn't
use <code>eval</code> or <code>Function</code> and satisfies Content Security Policy. In NodeJS,
it has no effect and is equivalent to native as scripting is safe there.</p>
<p><code>native</code>: uses the native scripting capabilities. i.e. unsafe <code>eval</code> or
<code>Function</code> in browser and <code>vm.Script</code> in nodejs.</p>
<p><code>true</code>: Same as 'safe'</p>
<p><code>false</code>: Disable Javascript executions in path string. Same as <code>preventEval: true</code> in previous versions.</p>
<p><code>callback [ (code, context) => value]</code>: A custom implementation which is called
with <code>code</code> and <code>context</code> as arguments to return the evaluated value.</p>
<p><code>class</code>: A class similar to nodejs vm.Script. It will be created with <code>code</code> as constructor argument and the code
is evaluated by calling <code>runInNewContext</code> with <code>context</code>.</p>
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link"><a id="default-2" class="tsd-anchor"></a>Default<a href="#default-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-2">'safe'</span>
</code><button type="button">Copy</button></pre>
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/JSONPath-Plus/JSONPath/blob/af59d678c327e38b0e10cf724cdf563aa662546e/src/jsonpath.d.ts#L102">jsonpath.d.ts:102</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="flatten" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>flatten</span><a href="#flatten" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">flatten</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Whether the returned array of results will be flattened to a
single dimension array.</p>
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link"><a id="default-3" class="tsd-anchor"></a>Default<a href="#default-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">false</span>
</code><button type="button">Copy</button></pre>
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/JSONPath-Plus/JSONPath/blob/af59d678c327e38b0e10cf724cdf563aa662546e/src/jsonpath.d.ts#L40">jsonpath.d.ts:40</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="ignoreevalerrors" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>ignore<wbr/>Eval<wbr/>Errors</span><a href="#ignoreevalerrors" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ignoreEvalErrors</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Ignore errors while evaluating JSONPath expression.</p>
<p><code>true</code>: Don't break entire search if an error occurs while evaluating JSONPath expression on one key/value pair.</p>
<p><code>false</code>: Break entire search if an error occurs while evaluating JSONPath expression on one key/value pair.</p>
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link"><a id="default-4" class="tsd-anchor"></a>Default<a href="#default-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">false</span>
</code><button type="button">Copy</button></pre>
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/JSONPath-Plus/JSONPath/blob/af59d678c327e38b0e10cf724cdf563aa662546e/src/jsonpath.d.ts#L113">jsonpath.d.ts:113</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="json" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>json</span><a href="#json" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">json</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">object</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>The JSON object to evaluate (whether of null, boolean, number,
string, object, or array type).</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/JSONPath-Plus/JSONPath/blob/af59d678c327e38b0e10cf724cdf563aa662546e/src/jsonpath.d.ts#L26">jsonpath.d.ts:26</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="othertypecallback" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>other<wbr/>Type<wbr/>Callback</span><a href="#othertypecallback" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">otherTypeCallback</span><span class="tsd-signature-symbol">?:</span> <a href="../types/JSONPathOtherTypeCallback.html" class="tsd-signature-type tsd-kind-type-alias">JSONPathOtherTypeCallback</a></div><div class="tsd-comment tsd-typography"><p>In the current absence of JSON Schema support,
one can determine types beyond the built-in types by adding the
perator <code>@other()</code> at the end of one's query.</p>
<p>If such a path is encountered, the <code>otherTypeCallback</code> 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).</p>
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link"><a id="default-5" class="tsd-anchor"></a>Default<a href="#default-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>undefined
<A function that throws an error when <code>@other()</code> is encountered></p>
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/JSONPath-Plus/JSONPath/blob/af59d678c327e38b0e10cf724cdf563aa662546e/src/jsonpath.d.ts#L155">jsonpath.d.ts:155</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="parent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>parent</span><a href="#parent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">parent</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div><div class="tsd-comment tsd-typography"><p>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.</p>
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link"><a id="default-6" class="tsd-anchor"></a>Default<a href="#default-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">null</span>
</code><button type="button">Copy</button></pre>
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/JSONPath-Plus/JSONPath/blob/af59d678c327e38b0e10cf724cdf563aa662546e/src/jsonpath.d.ts#L120">jsonpath.d.ts:120</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="parentproperty" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>parent<wbr/>Property</span><a href="#parentproperty" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">parentProperty</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div><div class="tsd-comment tsd-typography"><p>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.</p>
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link"><a id="default-7" class="tsd-anchor"></a>Default<a href="#default-7" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">null</span>
</code><button type="button">Copy</button></pre>
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/JSONPath-Plus/JSONPath/blob/af59d678c327e38b0e10cf724cdf563aa662546e/src/jsonpath.d.ts#L128">jsonpath.d.ts:128</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="path" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>path</span><a href="#path" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">path</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>The JSONPath expression as a (normalized or unnormalized) string or
array.</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/JSONPath-Plus/JSONPath/blob/af59d678c327e38b0e10cf724cdf563aa662546e/src/jsonpath.d.ts#L21">jsonpath.d.ts:21</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="resulttype" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>result<wbr/>Type</span><a href="#resulttype" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">resultType</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"value"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"path"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"pointer"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"parent"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"parentProperty"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"all"</span></div><div class="tsd-comment tsd-typography"><p>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.</p>
<p>If set to "all", all of these types will be returned on an object with
the type as key name.</p>
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link"><a id="default-8" class="tsd-anchor"></a>Default<a href="#default-8" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-2">'value'</span>
</code><button type="button">Copy</button></pre>
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/JSONPath-Plus/JSONPath/blob/af59d678c327e38b0e10cf724cdf563aa662546e/src/jsonpath.d.ts#L53">jsonpath.d.ts:53</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="sandbox" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>sandbox</span><a href="#sandbox" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">sandbox</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>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.)</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/JSONPath-Plus/JSONPath/blob/af59d678c327e38b0e10cf724cdf563aa662546e/src/jsonpath.d.ts#L62">jsonpath.d.ts:62</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="wrap" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>wrap</span><a href="#wrap" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">wrap</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Whether or not to wrap the results in an array.</p>
<p>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).</p>
<p>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).</p>
<p>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.</p>
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link"><a id="default-9" class="tsd-anchor"></a>Default<a href="#default-9" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">true</span>
</code><button type="button">Copy</button></pre>
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/JSONPath-Plus/JSONPath/blob/af59d678c327e38b0e10cf724cdf563aa662546e/src/jsonpath.d.ts#L79">jsonpath.d.ts:79</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#autostart" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>autostart</span></a><a href="#callback" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>callback</span></a><a href="#eval" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>eval</span></a><a href="#flatten" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>flatten</span></a><a href="#ignoreevalerrors" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ignore<wbr/>Eval<wbr/>Errors</span></a><a href="#json" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>json</span></a><a href="#othertypecallback" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>other<wbr/>Type<wbr/>Callback</span></a><a href="#parent" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>parent</span></a><a href="#parentproperty" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>parent<wbr/>Property</span></a><a href="#path" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>path</span></a><a href="#resulttype" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>result<wbr/>Type</span></a><a href="#sandbox" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>sandbox</span></a><a href="#wrap" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>wrap</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">jsonpath-plus</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>