Skip to content

Commit 6181be8

Browse files
80avinbrettz9
authored andcommitted
docs: update ignoreEvalErrors option in docs/demo
update browser demo to include ignoreEvalErrors option and minor enhancements update docs
1 parent 0c8dbcf commit 6181be8

25 files changed

+390
-224
lines changed

badges/tests-badge.svg

Lines changed: 1 addition & 1 deletion
Loading

demo/index.css

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,17 @@
1-
#jsonpath {
2-
width: 90%;
1+
.row {
2+
display: flex;
3+
gap: 8px;
34
margin-bottom: 10px;
45
}
56

7+
.grow, #jsonpath {
8+
flex-grow: 1;
9+
}
10+
11+
.row label {
12+
display: flex;
13+
}
14+
615
.container {
716
float: left;
817
width: 48%;

demo/index.html

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@
1010
<h2>JSONPath Demo <i id="demoNode">(To demo on Node instead, see the <a href="https://npm.runkit.com/jsonpath-plus">library on Runkit</a>.)</i>
1111
</h2>
1212
<form onsubmit="return false">
13-
<div>
14-
<label><b>JSONPath:</b>
13+
<div class="row">
14+
<label class="grow"><b>JSONPath:</b>
1515
<input type="text" id="jsonpath" placeholder="$.books" value="$..book[?(@parent.bicycle && @parent.bicycle.color === &quot;red&quot;)].category" />
1616
</label>
1717
<label><b>eval:</b>
@@ -21,6 +21,12 @@ <h2>JSONPath Demo <i id="demoNode">(To demo on Node instead, see the <a href="ht
2121
<option value="false">false</option>
2222
</select>
2323
</label>
24+
<label><b>ignoreEvalErrors:</b>
25+
<select id="ignoreEvalErrors">
26+
<option value="false">false (default)</option>
27+
<option value="true">true</option>
28+
</select>
29+
</label>
2430
</div>
2531
<div id="jsonSampleContainer" class="container">
2632
<label><b>JSON sample:</b>

demo/index.js

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,8 @@ const updateResults = () => {
3434
const result = new JSONPath.JSONPath({
3535
path: $('#jsonpath').value,
3636
json,
37-
eval: $('#eval').value === 'false' ? false : $('#eval').value
37+
eval: $('#eval').value === 'false' ? false : $('#eval').value,
38+
ignoreEvalErrors: $('#ignoreEvalErrors').value === 'true'
3839
});
3940

4041
$('#results').value = JSON.stringify(result, null, 2);
@@ -51,3 +52,10 @@ $('#jsonSample').addEventListener('input', () => {
5152
$('#eval').addEventListener('change', () => {
5253
updateResults();
5354
});
55+
56+
$('#ignoreEvalErrors').addEventListener('change', () => {
57+
updateResults();
58+
});
59+
60+
window.addEventListener('load', updateResults);
61+

docs/ts/assets/main.js

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/ts/assets/navigation.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/ts/assets/search.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/ts/assets/style.css

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -327,17 +327,14 @@ dd {
327327
}
328328

329329
/* Footer */
330-
.tsd-generator {
330+
footer {
331331
border-top: 1px solid var(--color-accent);
332332
padding-top: 1rem;
333333
padding-bottom: 1rem;
334334
max-height: 3.5rem;
335335
}
336-
337-
.tsd-generator > p {
338-
margin-top: 0;
339-
margin-bottom: 0;
340-
padding: 0 1rem;
336+
.tsd-generator {
337+
margin: 0 1em;
341338
}
342339

343340
.container-main {
@@ -405,7 +402,8 @@ dd {
405402
}
406403
body {
407404
background: var(--color-background);
408-
font-family: "Segoe UI", sans-serif;
405+
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", "Noto Sans",
406+
Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji";
409407
font-size: 16px;
410408
color: var(--color-text);
411409
}

docs/ts/classes/EvalClass.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>EvalClass | 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></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" data-base=".."><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"><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"><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="EvalClass.html">EvalClass</a></li></ul><h1>Class EvalClass</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/80avin/JSONPath/blob/0c8dbcf656523fadc738cacee254ee8b96894bd7/src/jsonpath.d.ts#L11">jsonpath.d.ts:11</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-index-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"><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">Constructors</h3><div class="tsd-index-list"><a href="EvalClass.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
2+
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="EvalClass.html#runInNewContext" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>run<wbr/>In<wbr/>New<wbr/>Context</span></a>
3+
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_EvalClass" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Eval<wbr/>Class</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">code</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="EvalClass.html" class="tsd-signature-type tsd-kind-class">EvalClass</a><a href="#constructor.new_EvalClass" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">code</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="EvalClass.html" class="tsd-signature-type tsd-kind-class">EvalClass</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/80avin/JSONPath/blob/0c8dbcf656523fadc738cacee254ee8b96894bd7/src/jsonpath.d.ts#L12">jsonpath.d.ts:12</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="runInNewContext" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>run<wbr/>In<wbr/>New<wbr/>Context</span><a href="#runInNewContext" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="runInNewContext.runInNewContext-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">run<wbr/>In<wbr/>New<wbr/>Context</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">context</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><a href="#runInNewContext.runInNewContext-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">context</span>: <span class="tsd-signature-type">object</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/80avin/JSONPath/blob/0c8dbcf656523fadc738cacee254ee8b96894bd7/src/jsonpath.d.ts#L13">jsonpath.d.ts:13</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><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-private" name="private"/><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>Private</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></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><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-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#runInNewContext" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>run<wbr/>In<wbr/>New<wbr/>Context</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>jsonpath-plus</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><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>

0 commit comments

Comments
 (0)