Skip to content

Commit

Permalink
Rewrite demo application in plain JavaScript (#232)
Browse files Browse the repository at this point in the history
A plain JavaScript demo, with no framework, is better to illustrate the
capabilities of MiniSearch to all audiences. Moreover, avoiding the
complex React setup, makes it much easier to maintain the demo.
  • Loading branch information
lucaong authored Oct 5, 2023
1 parent 93bb0bc commit e475be2
Show file tree
Hide file tree
Showing 23 changed files with 1,088 additions and 6,119 deletions.
44 changes: 22 additions & 22 deletions docs/classes/_minisearch_.minisearch.html
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/b2463a0/src/MiniSearch.ts#L487">MiniSearch.ts:487</a></li>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/93bb0bc/src/MiniSearch.ts#L487">MiniSearch.ts:487</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -287,7 +287,7 @@ <h3>dirt<wbr>Count</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/b2463a0/src/MiniSearch.ts#L1015">MiniSearch.ts:1015</a></li>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/93bb0bc/src/MiniSearch.ts#L1015">MiniSearch.ts:1015</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -309,7 +309,7 @@ <h3>dirt<wbr>Factor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/b2463a0/src/MiniSearch.ts#L1026">MiniSearch.ts:1026</a></li>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/93bb0bc/src/MiniSearch.ts#L1026">MiniSearch.ts:1026</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -335,7 +335,7 @@ <h3>document<wbr>Count</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/b2463a0/src/MiniSearch.ts#L1309">MiniSearch.ts:1309</a></li>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/93bb0bc/src/MiniSearch.ts#L1309">MiniSearch.ts:1309</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -357,7 +357,7 @@ <h3>is<wbr>Vacuuming</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/b2463a0/src/MiniSearch.ts#L1008">MiniSearch.ts:1008</a></li>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/93bb0bc/src/MiniSearch.ts#L1008">MiniSearch.ts:1008</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -379,7 +379,7 @@ <h3>term<wbr>Count</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/b2463a0/src/MiniSearch.ts#L1316">MiniSearch.ts:1316</a></li>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/93bb0bc/src/MiniSearch.ts#L1316">MiniSearch.ts:1316</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -404,7 +404,7 @@ <h3>add</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/b2463a0/src/MiniSearch.ts#L602">MiniSearch.ts:602</a></li>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/93bb0bc/src/MiniSearch.ts#L602">MiniSearch.ts:602</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -435,7 +435,7 @@ <h3>add<wbr>All</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/b2463a0/src/MiniSearch.ts#L644">MiniSearch.ts:644</a></li>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/93bb0bc/src/MiniSearch.ts#L644">MiniSearch.ts:644</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -466,7 +466,7 @@ <h3>add<wbr>All<wbr>Async</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/b2463a0/src/MiniSearch.ts#L659">MiniSearch.ts:659</a></li>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/93bb0bc/src/MiniSearch.ts#L659">MiniSearch.ts:659</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -512,7 +512,7 @@ <h3>auto<wbr>Suggest</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/b2463a0/src/MiniSearch.ts#L1281">MiniSearch.ts:1281</a></li>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/93bb0bc/src/MiniSearch.ts#L1281">MiniSearch.ts:1281</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -598,7 +598,7 @@ <h3>discard</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/b2463a0/src/MiniSearch.ts#L806">MiniSearch.ts:806</a></li>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/93bb0bc/src/MiniSearch.ts#L806">MiniSearch.ts:806</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -669,7 +669,7 @@ <h3>discard<wbr>All</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/b2463a0/src/MiniSearch.ts#L848">MiniSearch.ts:848</a></li>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/93bb0bc/src/MiniSearch.ts#L848">MiniSearch.ts:848</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -704,7 +704,7 @@ <h3>get<wbr>Stored<wbr>Fields</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/b2463a0/src/MiniSearch.ts#L1047">MiniSearch.ts:1047</a></li>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/93bb0bc/src/MiniSearch.ts#L1047">MiniSearch.ts:1047</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -737,7 +737,7 @@ <h3>has</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/b2463a0/src/MiniSearch.ts#L1036">MiniSearch.ts:1036</a></li>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/93bb0bc/src/MiniSearch.ts#L1036">MiniSearch.ts:1036</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -769,7 +769,7 @@ <h3>remove</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/b2463a0/src/MiniSearch.ts#L694">MiniSearch.ts:694</a></li>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/93bb0bc/src/MiniSearch.ts#L694">MiniSearch.ts:694</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -807,7 +807,7 @@ <h3>remove<wbr>All</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/b2463a0/src/MiniSearch.ts#L746">MiniSearch.ts:746</a></li>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/93bb0bc/src/MiniSearch.ts#L746">MiniSearch.ts:746</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -842,7 +842,7 @@ <h3>replace</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/b2463a0/src/MiniSearch.ts#L879">MiniSearch.ts:879</a></li>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/93bb0bc/src/MiniSearch.ts#L879">MiniSearch.ts:879</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -881,7 +881,7 @@ <h3>search</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/b2463a0/src/MiniSearch.ts#L1193">MiniSearch.ts:1193</a></li>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/93bb0bc/src/MiniSearch.ts#L1193">MiniSearch.ts:1193</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -1033,7 +1033,7 @@ <h3>toJSON</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/b2463a0/src/MiniSearch.ts#L1557">MiniSearch.ts:1557</a></li>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/93bb0bc/src/MiniSearch.ts#L1557">MiniSearch.ts:1557</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -1073,7 +1073,7 @@ <h3>vacuum</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/b2463a0/src/MiniSearch.ts#L926">MiniSearch.ts:926</a></li>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/93bb0bc/src/MiniSearch.ts#L926">MiniSearch.ts:926</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -1134,7 +1134,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> get<wbr>Default</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/b2463a0/src/MiniSearch.ts#L1369">MiniSearch.ts:1369</a></li>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/93bb0bc/src/MiniSearch.ts#L1369">MiniSearch.ts:1369</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -1180,7 +1180,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> loadJSON</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/b2463a0/src/MiniSearch.ts#L1341">MiniSearch.ts:1341</a></li>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/93bb0bc/src/MiniSearch.ts#L1341">MiniSearch.ts:1341</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
Loading

0 comments on commit e475be2

Please sign in to comment.