Skip to content

Commit aca02ad

Browse files
deltossdeltoss
committed
feat: 🎸 Removed the redundant searchText option. Added tests
1 parent d22c465 commit aca02ad

50 files changed

Lines changed: 19817 additions & 21773 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎projects/mitch-datasource-documentation/docs/ast/source/AjaxDatasource.js.json‎

Lines changed: 4669 additions & 4389 deletions
Large diffs are not rendered by default.

‎projects/mitch-datasource-documentation/docs/ast/source/ArrayDatasource.js.json‎

Lines changed: 2054 additions & 3351 deletions
Large diffs are not rendered by default.

‎projects/mitch-datasource-documentation/docs/ast/source/DatasourceBase.js.json‎

Lines changed: 9804 additions & 12278 deletions
Large diffs are not rendered by default.

‎projects/mitch-datasource-documentation/docs/class/js/AjaxDatasource.js~AjaxDatasource.html‎

Lines changed: 8 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,6 @@
3535
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/js/QueryBuilder.js~QueryBuilder.html">QueryBuilder</a></span></span></li>
3636
<li data-ice="doc"><span data-ice="kind" class="kind-typedef">T</span><span data-ice="name"><span><a href="typedef/index.html#static-typedef-SortCallback">SortCallback</a></span></span></li>
3737
<li data-ice="doc"><span data-ice="kind" class="kind-typedef">T</span><span data-ice="name"><span><a href="typedef/index.html#static-typedef-SortCallback">SortCallback</a></span></span></li>
38-
<li data-ice="doc"><span data-ice="kind" class="kind-typedef">T</span><span data-ice="name"><span><a href="typedef/index.html#static-typedef-MultiColumnSearchArgs">MultiColumnSearchArgs</a></span></span></li>
39-
<li data-ice="doc"><span data-ice="kind" class="kind-typedef">T</span><span data-ice="name"><span><a href="typedef/index.html#static-typedef-MultiColumnSortArgs">MultiColumnSortArgs</a></span></span></li>
4038
<li data-ice="doc"><span data-ice="kind" class="kind-typedef">T</span><span data-ice="name"><span><a href="typedef/index.html#static-typedef-QueryStringOptions">QueryStringOptions</a></span></span></li>
4139
<li data-ice="doc"><span data-ice="kind" class="kind-typedef">T</span><span data-ice="name"><span><a href="typedef/index.html#static-typedef-SerialiseToQueryObjectCallback">SerialiseToQueryObjectCallback</a></span></span></li>
4240
<li data-ice="doc"><span data-ice="kind" class="kind-typedef">T</span><span data-ice="name"><span><a href="typedef/index.html#static-typedef-SerialiseToQueryStringCallback">SerialiseToQueryStringCallback</a></span></span></li>
@@ -133,8 +131,8 @@ <h4>Example:</h4>
133131

134132
async function exampleAsyncFunction() {
135133
let datasource = new AjaxDatasource({
136-
ajax: async function() {
137-
return await mockAjaxCall();
134+
ajax: async function(queryBuilder) {
135+
return await mockAjaxCall(queryBuilder);
138136
}
139137
});
140138
await datasource.update();
@@ -626,43 +624,13 @@ <h4>Example:</h4>
626624

627625

628626

629-
<span class="code" data-ice="name"><span><a href="class/js/DatasourceBase.js~DatasourceBase.html#instance-member-searchArguments">searchArguments</a></span></span><span class="code" data-ice="signature">: <span><a href="typedef/index.html#static-typedef-MultiColumnSearchArgs">MultiColumnSearchArgs</a></span></span>
627+
<span class="code" data-ice="name"><span><a href="class/js/DatasourceBase.js~DatasourceBase.html#instance-member-searchArguments">searchArguments</a></span></span><span class="code" data-ice="signature">: <span>*</span></span>
630628
</p>
631629
</div>
632630
<div>
633631

634632

635-
<div data-ice="description"><p>The search arguments object, for specific
636-
or multi-column searching purposes.</p>
637-
</div>
638-
</div>
639-
</td>
640-
<td>
641-
642-
643-
</td>
644-
</tr>
645-
<tr data-ice="target">
646-
<td>
647-
<span class="access" data-ice="access">public</span>
648-
649-
650-
651-
<span class="override" data-ice="override"></span>
652-
</td>
653-
<td>
654-
<div>
655-
<p>
656-
657-
658-
659-
<span class="code" data-ice="name"><span><a href="class/js/DatasourceBase.js~DatasourceBase.html#instance-member-searchText">searchText</a></span></span><span class="code" data-ice="signature">: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">String</a></span></span>
660-
</p>
661-
</div>
662-
<div>
663-
664-
665-
<div data-ice="description"><p>The text to search for.</p>
633+
<div data-ice="description"><p>The search arguments object, for searching purposes.</p>
666634
</div>
667635
</div>
668636
</td>
@@ -714,14 +682,13 @@ <h4>Example:</h4>
714682

715683

716684

717-
<span class="code" data-ice="name"><span><a href="class/js/DatasourceBase.js~DatasourceBase.html#instance-member-sortArguments">sortArguments</a></span></span><span class="code" data-ice="signature">: <span><a href="typedef/index.html#static-typedef-MultiColumnSortArgs">MultiColumnSortArgs</a></span></span>
685+
<span class="code" data-ice="name"><span><a href="class/js/DatasourceBase.js~DatasourceBase.html#instance-member-sortArguments">sortArguments</a></span></span><span class="code" data-ice="signature">: <span>*</span></span>
718686
</p>
719687
</div>
720688
<div>
721689

722690

723-
<div data-ice="description"><p>The search arguments object, for specific
724-
or multi-column sorting purposes.</p>
691+
<div data-ice="description"><p>The search arguments, for sorting purposes.</p>
725692
</div>
726693
</div>
727694
</td>
@@ -831,7 +798,7 @@ <h4>Example:</h4>
831798

832799
<span data-ice="async">async</span>
833800

834-
<span class="code" data-ice="name"><span><a href="class/js/DatasourceBase.js~DatasourceBase.html#instance-method-search">search</a></span></span><span class="code" data-ice="signature">(searchArguments: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">String</a></span>): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a></span></span>
801+
<span class="code" data-ice="name"><span><a href="class/js/DatasourceBase.js~DatasourceBase.html#instance-method-search">search</a></span></span><span class="code" data-ice="signature">(searchArguments: <span>*</span>): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a></span></span>
835802
</p>
836803
</div>
837804
<div>
@@ -860,7 +827,7 @@ <h4>Example:</h4>
860827

861828
<span data-ice="async">async</span>
862829

863-
<span class="code" data-ice="name"><span><a href="class/js/DatasourceBase.js~DatasourceBase.html#instance-method-sort">sort</a></span></span><span class="code" data-ice="signature">(sortArguments: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span>): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a></span></span>
830+
<span class="code" data-ice="name"><span><a href="class/js/DatasourceBase.js~DatasourceBase.html#instance-method-sort">sort</a></span></span><span class="code" data-ice="signature">(sortArguments: <span>*</span>): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a></span></span>
864831
</p>
865832
</div>
866833
<div>

‎projects/mitch-datasource-documentation/docs/class/js/ArrayDatasource.js~ArrayDatasource.html‎

Lines changed: 8 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,6 @@
3535
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/js/QueryBuilder.js~QueryBuilder.html">QueryBuilder</a></span></span></li>
3636
<li data-ice="doc"><span data-ice="kind" class="kind-typedef">T</span><span data-ice="name"><span><a href="typedef/index.html#static-typedef-SortCallback">SortCallback</a></span></span></li>
3737
<li data-ice="doc"><span data-ice="kind" class="kind-typedef">T</span><span data-ice="name"><span><a href="typedef/index.html#static-typedef-SortCallback">SortCallback</a></span></span></li>
38-
<li data-ice="doc"><span data-ice="kind" class="kind-typedef">T</span><span data-ice="name"><span><a href="typedef/index.html#static-typedef-MultiColumnSearchArgs">MultiColumnSearchArgs</a></span></span></li>
39-
<li data-ice="doc"><span data-ice="kind" class="kind-typedef">T</span><span data-ice="name"><span><a href="typedef/index.html#static-typedef-MultiColumnSortArgs">MultiColumnSortArgs</a></span></span></li>
4038
<li data-ice="doc"><span data-ice="kind" class="kind-typedef">T</span><span data-ice="name"><span><a href="typedef/index.html#static-typedef-QueryStringOptions">QueryStringOptions</a></span></span></li>
4139
<li data-ice="doc"><span data-ice="kind" class="kind-typedef">T</span><span data-ice="name"><span><a href="typedef/index.html#static-typedef-SerialiseToQueryObjectCallback">SerialiseToQueryObjectCallback</a></span></span></li>
4240
<li data-ice="doc"><span data-ice="kind" class="kind-typedef">T</span><span data-ice="name"><span><a href="typedef/index.html#static-typedef-SerialiseToQueryStringCallback">SerialiseToQueryStringCallback</a></span></span></li>
@@ -585,43 +583,13 @@ <h4>Example:</h4>
585583

586584

587585

588-
<span class="code" data-ice="name"><span><a href="class/js/DatasourceBase.js~DatasourceBase.html#instance-member-searchArguments">searchArguments</a></span></span><span class="code" data-ice="signature">: <span><a href="typedef/index.html#static-typedef-MultiColumnSearchArgs">MultiColumnSearchArgs</a></span></span>
586+
<span class="code" data-ice="name"><span><a href="class/js/DatasourceBase.js~DatasourceBase.html#instance-member-searchArguments">searchArguments</a></span></span><span class="code" data-ice="signature">: <span>*</span></span>
589587
</p>
590588
</div>
591589
<div>
592590

593591

594-
<div data-ice="description"><p>The search arguments object, for specific
595-
or multi-column searching purposes.</p>
596-
</div>
597-
</div>
598-
</td>
599-
<td>
600-
601-
602-
</td>
603-
</tr>
604-
<tr data-ice="target">
605-
<td>
606-
<span class="access" data-ice="access">public</span>
607-
608-
609-
610-
<span class="override" data-ice="override"></span>
611-
</td>
612-
<td>
613-
<div>
614-
<p>
615-
616-
617-
618-
<span class="code" data-ice="name"><span><a href="class/js/DatasourceBase.js~DatasourceBase.html#instance-member-searchText">searchText</a></span></span><span class="code" data-ice="signature">: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">String</a></span></span>
619-
</p>
620-
</div>
621-
<div>
622-
623-
624-
<div data-ice="description"><p>The text to search for.</p>
592+
<div data-ice="description"><p>The search arguments object, for searching purposes.</p>
625593
</div>
626594
</div>
627595
</td>
@@ -673,14 +641,13 @@ <h4>Example:</h4>
673641

674642

675643

676-
<span class="code" data-ice="name"><span><a href="class/js/DatasourceBase.js~DatasourceBase.html#instance-member-sortArguments">sortArguments</a></span></span><span class="code" data-ice="signature">: <span><a href="typedef/index.html#static-typedef-MultiColumnSortArgs">MultiColumnSortArgs</a></span></span>
644+
<span class="code" data-ice="name"><span><a href="class/js/DatasourceBase.js~DatasourceBase.html#instance-member-sortArguments">sortArguments</a></span></span><span class="code" data-ice="signature">: <span>*</span></span>
677645
</p>
678646
</div>
679647
<div>
680648

681649

682-
<div data-ice="description"><p>The search arguments object, for specific
683-
or multi-column sorting purposes.</p>
650+
<div data-ice="description"><p>The search arguments, for sorting purposes.</p>
684651
</div>
685652
</div>
686653
</td>
@@ -790,7 +757,7 @@ <h4>Example:</h4>
790757

791758
<span data-ice="async">async</span>
792759

793-
<span class="code" data-ice="name"><span><a href="class/js/DatasourceBase.js~DatasourceBase.html#instance-method-search">search</a></span></span><span class="code" data-ice="signature">(searchArguments: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">String</a></span>): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a></span></span>
760+
<span class="code" data-ice="name"><span><a href="class/js/DatasourceBase.js~DatasourceBase.html#instance-method-search">search</a></span></span><span class="code" data-ice="signature">(searchArguments: <span>*</span>): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a></span></span>
794761
</p>
795762
</div>
796763
<div>
@@ -819,7 +786,7 @@ <h4>Example:</h4>
819786

820787
<span data-ice="async">async</span>
821788

822-
<span class="code" data-ice="name"><span><a href="class/js/DatasourceBase.js~DatasourceBase.html#instance-method-sort">sort</a></span></span><span class="code" data-ice="signature">(sortArguments: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span>): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a></span></span>
789+
<span class="code" data-ice="name"><span><a href="class/js/DatasourceBase.js~DatasourceBase.html#instance-method-sort">sort</a></span></span><span class="code" data-ice="signature">(sortArguments: <span>*</span>): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a></span></span>
823790
</p>
824791
</div>
825792
<div>
@@ -998,7 +965,7 @@ <h3 data-ice="anchor" id="instance-get-data">
998965
<span class="right-info">
999966

1000967

1001-
<span data-ice="source"><span><a href="file/js/ArrayDatasource.js.html#lineNumber224">source</a></span></span>
968+
<span data-ice="source"><span><a href="file/js/ArrayDatasource.js.html#lineNumber222">source</a></span></span>
1002969
</span>
1003970
</h3>
1004971

@@ -1043,7 +1010,7 @@ <h3 data-ice="anchor" id="instance-get-total">
10431010
<span class="right-info">
10441011

10451012

1046-
<span data-ice="source"><span><a href="file/js/ArrayDatasource.js.html#lineNumber209">source</a></span></span>
1013+
<span data-ice="source"><span><a href="file/js/ArrayDatasource.js.html#lineNumber207">source</a></span></span>
10471014
</span>
10481015
</h3>
10491016

0 commit comments

Comments
 (0)