Skip to content

Commit 4a50b45

Browse files
hp4k1h5hp4k1h5
committed
edit: docs
1 parent 520556d commit 4a50b45

12 files changed

+28
-38
lines changed

‎docs/assets/js/main.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/globals.html

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,5 @@ <h2>Legend</h2>
129129
</div>
130130
<div class="overlay"></div>
131131
<script src="assets/js/main.js"></script>
132-
<script>if (location.protocol == 'file:') document.write('<script src="assets/js/search.js"><' + '/script>');</script>
133132
</body>
134133
</html>

‎docs/index.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -143,6 +143,7 @@ <h2>overview</h2>
143143
<p>If multiple collections are passed, the above query is essentially replicated
144144
across all collections, see examples in &#39;tests/cols.ts&#39;. In the future this
145145
will also accommodate multiple key searches.</p>
146+
<hr>
146147
<a href="#setup" id="setup" style="color: inherit; text-decoration: none;">
147148
<h2>setup</h2>
148149
</a>
@@ -151,10 +152,8 @@ <h2>setup</h2>
151152
<h2>installation</h2>
152153
</a>
153154
<p>currently there is only support for server-side use.</p>
154-
<p>1) clone this repository in your node compatible project.
155-
2) run <code>yarn add @hp4klh5/AQLqueryBuilder.js</code>
156-
or <code>npm install --save @hp4klh5/AQLqueryBuilder.js</code><br> in a directory containing a <code>package.json</code> file.
157-
3) import/require the exported functions</p>
155+
<p>1) clone this repository in your node compatible project.<br> <strong>or</strong><br> run <code>yarn add @hp4klh5/AQLqueryBuilder.js</code><br> or <code>npm install --save @hp4klh5/AQLqueryBuilder.js</code><br> in a directory containing a <code>package.json</code> file.
156+
2) import/require the exported functions</p>
158157
<pre><code class="language-js"><span class="hljs-comment">// use either</span>
159158
<span class="hljs-keyword">import</span> {buildAQL} <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;@hp4klh5/AQLqueryBuilder.js&#x27;</span>
160159
<span class="hljs-comment">// or</span>
@@ -247,6 +246,7 @@ <h4><code>query</code> Example</h4>
247246
}
248247
]
249248
}</code></pre>
249+
<hr>
250250
<a href="#boolean-search-logic" id="boolean-search-logic" style="color: inherit; text-decoration: none;">
251251
<h3>boolean search logic</h3>
252252
</a>
@@ -337,6 +337,7 @@ <h4>Example</h4>
337337
┃ buckle my shoe┃ ┃ ┃ ┃ ┃
338338
┗━━━━━━━━━━━━━━━━━━┛ ┗━━━━━━━━━━━━━━━━━━┛ ┗━━━━━━━━━━━━━━━━━━┛</code></pre>
339339
<p>only Document B is returned;<br>Document A is excluded by the phrase &quot;buckle my shoe&quot;<br>Document C does not contain the mandatory word &quot;two&quot;</p>
340+
<hr>
340341
<a href="#bugs" id="bugs" style="color: inherit; text-decoration: none;">
341342
<h2>bugs</h2>
342343
</a>
@@ -395,6 +396,5 @@ <h2>Legend</h2>
395396
</div>
396397
<div class="overlay"></div>
397398
<script src="assets/js/main.js"></script>
398-
<script>if (location.protocol == 'file:') document.write('<script src="assets/js/search.js"><' + '/script>');</script>
399399
</body>
400400
</html>

‎docs/interfaces/_lib_structs_.collection.html

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ <h3>analyzer</h3>
112112
<div class="tsd-signature tsd-kind-icon">analyzer<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
113113
<aside class="tsd-sources">
114114
<ul>
115-
<li>Defined in <a href="https://github.com/HP4k1h5/AQLqueryBuilder.js/blob/a4f1222/src/lib/structs.ts#L49">lib/structs.ts:49</a></li>
115+
<li>Defined in <a href="https://github.com/HP4k1h5/AQLqueryBuilder.js/blob/520556d/src/lib/structs.ts#L49">lib/structs.ts:49</a></li>
116116
</ul>
117117
</aside>
118118
<div class="tsd-comment tsd-typography">
@@ -127,7 +127,7 @@ <h3>name</h3>
127127
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
128128
<aside class="tsd-sources">
129129
<ul>
130-
<li>Defined in <a href="https://github.com/HP4k1h5/AQLqueryBuilder.js/blob/a4f1222/src/lib/structs.ts#L45">lib/structs.ts:45</a></li>
130+
<li>Defined in <a href="https://github.com/HP4k1h5/AQLqueryBuilder.js/blob/520556d/src/lib/structs.ts#L45">lib/structs.ts:45</a></li>
131131
</ul>
132132
</aside>
133133
<div class="tsd-comment tsd-typography">
@@ -211,6 +211,5 @@ <h2>Legend</h2>
211211
</div>
212212
<div class="overlay"></div>
213213
<script src="../assets/js/main.js"></script>
214-
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
215214
</body>
216215
</html>

‎docs/interfaces/_lib_structs_.filter.html

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ <h3>field</h3>
107107
<div class="tsd-signature tsd-kind-icon">field<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
108108
<aside class="tsd-sources">
109109
<ul>
110-
<li>Defined in <a href="https://github.com/HP4k1h5/AQLqueryBuilder.js/blob/a4f1222/src/lib/structs.ts#L86">lib/structs.ts:86</a></li>
110+
<li>Defined in <a href="https://github.com/HP4k1h5/AQLqueryBuilder.js/blob/520556d/src/lib/structs.ts#L86">lib/structs.ts:86</a></li>
111111
</ul>
112112
</aside>
113113
<div class="tsd-comment tsd-typography">
@@ -122,7 +122,7 @@ <h3>op</h3>
122122
<div class="tsd-signature tsd-kind-icon">op<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
123123
<aside class="tsd-sources">
124124
<ul>
125-
<li>Defined in <a href="https://github.com/HP4k1h5/AQLqueryBuilder.js/blob/a4f1222/src/lib/structs.ts#L88">lib/structs.ts:88</a></li>
125+
<li>Defined in <a href="https://github.com/HP4k1h5/AQLqueryBuilder.js/blob/520556d/src/lib/structs.ts#L88">lib/structs.ts:88</a></li>
126126
</ul>
127127
</aside>
128128
<div class="tsd-comment tsd-typography">
@@ -137,7 +137,7 @@ <h3>val</h3>
137137
<div class="tsd-signature tsd-kind-icon">val<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">Date</span></div>
138138
<aside class="tsd-sources">
139139
<ul>
140-
<li>Defined in <a href="https://github.com/HP4k1h5/AQLqueryBuilder.js/blob/a4f1222/src/lib/structs.ts#L90">lib/structs.ts:90</a></li>
140+
<li>Defined in <a href="https://github.com/HP4k1h5/AQLqueryBuilder.js/blob/520556d/src/lib/structs.ts#L90">lib/structs.ts:90</a></li>
141141
</ul>
142142
</aside>
143143
<div class="tsd-comment tsd-typography">
@@ -224,6 +224,5 @@ <h2>Legend</h2>
224224
</div>
225225
<div class="overlay"></div>
226226
<script src="../assets/js/main.js"></script>
227-
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
228227
</body>
229228
</html>

‎docs/interfaces/_lib_structs_.query.html

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ <h3>collections</h3>
110110
<div class="tsd-signature tsd-kind-icon">collections<span class="tsd-signature-symbol">:</span> <a href="_lib_structs_.collection.html" class="tsd-signature-type">collection</a><span class="tsd-signature-symbol">[]</span></div>
111111
<aside class="tsd-sources">
112112
<ul>
113-
<li>Defined in <a href="https://github.com/HP4k1h5/AQLqueryBuilder.js/blob/a4f1222/src/lib/structs.ts#L13">lib/structs.ts:13</a></li>
113+
<li>Defined in <a href="https://github.com/HP4k1h5/AQLqueryBuilder.js/blob/520556d/src/lib/structs.ts#L13">lib/structs.ts:13</a></li>
114114
</ul>
115115
</aside>
116116
<div class="tsd-comment tsd-typography">
@@ -125,7 +125,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> filters</h3>
125125
<div class="tsd-signature tsd-kind-icon">filters<span class="tsd-signature-symbol">:</span> <a href="_lib_structs_.filter.html" class="tsd-signature-type">filter</a><span class="tsd-signature-symbol">[]</span></div>
126126
<aside class="tsd-sources">
127127
<ul>
128-
<li>Defined in <a href="https://github.com/HP4k1h5/AQLqueryBuilder.js/blob/a4f1222/src/lib/structs.ts#L26">lib/structs.ts:26</a></li>
128+
<li>Defined in <a href="https://github.com/HP4k1h5/AQLqueryBuilder.js/blob/520556d/src/lib/structs.ts#L26">lib/structs.ts:26</a></li>
129129
</ul>
130130
</aside>
131131
<div class="tsd-comment tsd-typography">
@@ -140,7 +140,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> key</h3>
140140
<div class="tsd-signature tsd-kind-icon">key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
141141
<aside class="tsd-sources">
142142
<ul>
143-
<li>Defined in <a href="https://github.com/HP4k1h5/AQLqueryBuilder.js/blob/a4f1222/src/lib/structs.ts#L22">lib/structs.ts:22</a></li>
143+
<li>Defined in <a href="https://github.com/HP4k1h5/AQLqueryBuilder.js/blob/520556d/src/lib/structs.ts#L22">lib/structs.ts:22</a></li>
144144
</ul>
145145
</aside>
146146
<div class="tsd-comment tsd-typography">
@@ -156,7 +156,7 @@ <h3>terms</h3>
156156
<div class="tsd-signature tsd-kind-icon">terms<span class="tsd-signature-symbol">:</span> <a href="_lib_structs_.term.html" class="tsd-signature-type">term</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
157157
<aside class="tsd-sources">
158158
<ul>
159-
<li>Defined in <a href="https://github.com/HP4k1h5/AQLqueryBuilder.js/blob/a4f1222/src/lib/structs.ts#L17">lib/structs.ts:17</a></li>
159+
<li>Defined in <a href="https://github.com/HP4k1h5/AQLqueryBuilder.js/blob/520556d/src/lib/structs.ts#L17">lib/structs.ts:17</a></li>
160160
</ul>
161161
</aside>
162162
<div class="tsd-comment tsd-typography">
@@ -171,7 +171,7 @@ <h3>view</h3>
171171
<div class="tsd-signature tsd-kind-icon">view<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
172172
<aside class="tsd-sources">
173173
<ul>
174-
<li>Defined in <a href="https://github.com/HP4k1h5/AQLqueryBuilder.js/blob/a4f1222/src/lib/structs.ts#L9">lib/structs.ts:9</a></li>
174+
<li>Defined in <a href="https://github.com/HP4k1h5/AQLqueryBuilder.js/blob/520556d/src/lib/structs.ts#L9">lib/structs.ts:9</a></li>
175175
</ul>
176176
</aside>
177177
<div class="tsd-comment tsd-typography">
@@ -264,6 +264,5 @@ <h2>Legend</h2>
264264
</div>
265265
<div class="overlay"></div>
266266
<script src="../assets/js/main.js"></script>
267-
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
268267
</body>
269268
</html>

‎docs/interfaces/_lib_structs_.term.html

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ <h3>op</h3>
114114
<div class="tsd-signature tsd-kind-icon">op<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
115115
<aside class="tsd-sources">
116116
<ul>
117-
<li>Defined in <a href="https://github.com/HP4k1h5/AQLqueryBuilder.js/blob/a4f1222/src/lib/structs.ts#L78">lib/structs.ts:78</a></li>
117+
<li>Defined in <a href="https://github.com/HP4k1h5/AQLqueryBuilder.js/blob/520556d/src/lib/structs.ts#L78">lib/structs.ts:78</a></li>
118118
</ul>
119119
</aside>
120120
<div class="tsd-comment tsd-typography">
@@ -130,7 +130,7 @@ <h3>type</h3>
130130
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
131131
<aside class="tsd-sources">
132132
<ul>
133-
<li>Defined in <a href="https://github.com/HP4k1h5/AQLqueryBuilder.js/blob/a4f1222/src/lib/structs.ts#L69">lib/structs.ts:69</a></li>
133+
<li>Defined in <a href="https://github.com/HP4k1h5/AQLqueryBuilder.js/blob/520556d/src/lib/structs.ts#L69">lib/structs.ts:69</a></li>
134134
</ul>
135135
</aside>
136136
<div class="tsd-comment tsd-typography">
@@ -146,7 +146,7 @@ <h3>val</h3>
146146
<div class="tsd-signature tsd-kind-icon">val<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
147147
<aside class="tsd-sources">
148148
<ul>
149-
<li>Defined in <a href="https://github.com/HP4k1h5/AQLqueryBuilder.js/blob/a4f1222/src/lib/structs.ts#L73">lib/structs.ts:73</a></li>
149+
<li>Defined in <a href="https://github.com/HP4k1h5/AQLqueryBuilder.js/blob/520556d/src/lib/structs.ts#L73">lib/structs.ts:73</a></li>
150150
</ul>
151151
</aside>
152152
<div class="tsd-comment tsd-typography">
@@ -233,6 +233,5 @@ <h2>Legend</h2>
233233
</div>
234234
<div class="overlay"></div>
235235
<script src="../assets/js/main.js"></script>
236-
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
237236
</body>
238237
</html>

‎docs/modules/_filter_.html

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ <h3>build<wbr>Filters</h3>
9191
<li class="tsd-description">
9292
<aside class="tsd-sources">
9393
<ul>
94-
<li>Defined in <a href="https://github.com/HP4k1h5/AQLqueryBuilder.js/blob/a4f1222/src/filter.ts#L4">filter.ts:4</a></li>
94+
<li>Defined in <a href="https://github.com/HP4k1h5/AQLqueryBuilder.js/blob/520556d/src/filter.ts#L4">filter.ts:4</a></li>
9595
</ul>
9696
</aside>
9797
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -157,6 +157,5 @@ <h2>Legend</h2>
157157
</div>
158158
<div class="overlay"></div>
159159
<script src="../assets/js/main.js"></script>
160-
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
161160
</body>
162161
</html>

‎docs/modules/_index_.html

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ <h3>buildAQL</h3>
9292
<li class="tsd-description">
9393
<aside class="tsd-sources">
9494
<ul>
95-
<li>Defined in <a href="https://github.com/HP4k1h5/AQLqueryBuilder.js/blob/a4f1222/src/index.ts#L10">index.ts:10</a></li>
95+
<li>Defined in <a href="https://github.com/HP4k1h5/AQLqueryBuilder.js/blob/520556d/src/index.ts#L10">index.ts:10</a></li>
9696
</ul>
9797
</aside>
9898
<div class="tsd-comment tsd-typography">
@@ -123,7 +123,7 @@ <h3>validate<wbr>Query</h3>
123123
<li class="tsd-description">
124124
<aside class="tsd-sources">
125125
<ul>
126-
<li>Defined in <a href="https://github.com/HP4k1h5/AQLqueryBuilder.js/blob/a4f1222/src/index.ts#L28">index.ts:28</a></li>
126+
<li>Defined in <a href="https://github.com/HP4k1h5/AQLqueryBuilder.js/blob/520556d/src/index.ts#L28">index.ts:28</a></li>
127127
</ul>
128128
</aside>
129129
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -192,6 +192,5 @@ <h2>Legend</h2>
192192
</div>
193193
<div class="overlay"></div>
194194
<script src="../assets/js/main.js"></script>
195-
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
196195
</body>
197196
</html>

‎docs/modules/_lib_structs_.html

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,6 +143,5 @@ <h2>Legend</h2>
143143
</div>
144144
<div class="overlay"></div>
145145
<script src="../assets/js/main.js"></script>
146-
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
147146
</body>
148147
</html>

0 commit comments

Comments
 (0)