Skip to content

Commit

Permalink
re-build docs website
Browse files Browse the repository at this point in the history
  • Loading branch information
@lucaong
lucaong committed Jun 25, 2021
1 parent 0f0d056 commit b0cdeec
Show file tree
Hide file tree
Showing 7 changed files with 110 additions and 73 deletions.
2 changes: 1 addition & 1 deletion docs/assets/css/main.css
View file

Large diffs are not rendered by default.

84 changes: 52 additions & 32 deletions docs/classes/_minisearch_.minisearch.html
View file

Large diffs are not rendered by default.

43 changes: 23 additions & 20 deletions docs/classes/_searchablemap_searchablemap_.searchablemap.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/a24d97c/src/SearchableMap/SearchableMap.ts#L30">SearchableMap/SearchableMap.ts:30</a></li>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/0f0d056/src/SearchableMap/SearchableMap.ts#L30">SearchableMap/SearchableMap.ts:30</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -192,7 +192,7 @@ <h3>size</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/a24d97c/src/SearchableMap/SearchableMap.ts#L203">SearchableMap/SearchableMap.ts:203</a></li>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/0f0d056/src/SearchableMap/SearchableMap.ts#L203">SearchableMap/SearchableMap.ts:203</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -219,7 +219,7 @@ <h3>[<wbr>Symbol.iterator]</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/a24d97c/src/SearchableMap/SearchableMap.ts#L246">SearchableMap/SearchableMap.ts:246</a></li>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/0f0d056/src/SearchableMap/SearchableMap.ts#L246">SearchableMap/SearchableMap.ts:246</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -243,7 +243,7 @@ <h3>at<wbr>Prefix</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/a24d97c/src/SearchableMap/SearchableMap.ts#L73">SearchableMap/SearchableMap.ts:73</a></li>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/0f0d056/src/SearchableMap/SearchableMap.ts#L73">SearchableMap/SearchableMap.ts:73</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -269,7 +269,8 @@ <h3>Usage:</h3>
<span class="hljs-keyword">let</span> univer = map.atPrefix(<span class="hljs-string">&quot;univer&quot;</span>)
univer.get(<span class="hljs-string">&quot;unique&quot;</span>) <span class="hljs-comment">// =&gt; undefined</span>
univer.get(<span class="hljs-string">&quot;universe&quot;</span>) <span class="hljs-comment">// =&gt; 2</span>
univer.get(<span class="hljs-string">&quot;university&quot;</span>) <span class="hljs-comment">// =&gt; 3</span></code></pre>
univer.get(<span class="hljs-string">&quot;university&quot;</span>) <span class="hljs-comment">// =&gt; 3</span>
</code></pre>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
Expand All @@ -295,7 +296,7 @@ <h3>clear</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/a24d97c/src/SearchableMap/SearchableMap.ts#L93">SearchableMap/SearchableMap.ts:93</a></li>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/0f0d056/src/SearchableMap/SearchableMap.ts#L93">SearchableMap/SearchableMap.ts:93</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -319,7 +320,7 @@ <h3>delete</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/a24d97c/src/SearchableMap/SearchableMap.ts#L102">SearchableMap/SearchableMap.ts:102</a></li>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/0f0d056/src/SearchableMap/SearchableMap.ts#L102">SearchableMap/SearchableMap.ts:102</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -352,7 +353,7 @@ <h3>entries</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/a24d97c/src/SearchableMap/SearchableMap.ts#L111">SearchableMap/SearchableMap.ts:111</a></li>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/0f0d056/src/SearchableMap/SearchableMap.ts#L111">SearchableMap/SearchableMap.ts:111</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -377,7 +378,7 @@ <h3>for<wbr>Each</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/a24d97c/src/SearchableMap/SearchableMap.ts#L119">SearchableMap/SearchableMap.ts:119</a></li>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/0f0d056/src/SearchableMap/SearchableMap.ts#L119">SearchableMap/SearchableMap.ts:119</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -434,7 +435,7 @@ <h3>fuzzy<wbr>Get</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/a24d97c/src/SearchableMap/SearchableMap.ts#L153">SearchableMap/SearchableMap.ts:153</a></li>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/0f0d056/src/SearchableMap/SearchableMap.ts#L153">SearchableMap/SearchableMap.ts:153</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -459,7 +460,8 @@ <h3>Usage:</h3>

<span class="hljs-comment">// In the example, the &quot;hello&quot; key has value &quot;world&quot; and edit distance of 1</span>
<span class="hljs-comment">// (change &quot;e&quot; to &quot;a&quot;), the key &quot;hell&quot; has value &quot;yeah&quot; and edit distance of 2</span>
<span class="hljs-comment">// (change &quot;e&quot; to &quot;a&quot;, delete &quot;o&quot;)</span></code></pre>
<span class="hljs-comment">// (change &quot;e&quot; to &quot;a&quot;, delete &quot;o&quot;)</span>
</code></pre>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
Expand Down Expand Up @@ -491,7 +493,7 @@ <h3>get</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/a24d97c/src/SearchableMap/SearchableMap.ts#L163">SearchableMap/SearchableMap.ts:163</a></li>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/0f0d056/src/SearchableMap/SearchableMap.ts#L163">SearchableMap/SearchableMap.ts:163</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -526,7 +528,7 @@ <h3>has</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/a24d97c/src/SearchableMap/SearchableMap.ts#L173">SearchableMap/SearchableMap.ts:173</a></li>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/0f0d056/src/SearchableMap/SearchableMap.ts#L173">SearchableMap/SearchableMap.ts:173</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -560,7 +562,7 @@ <h3>keys</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/a24d97c/src/SearchableMap/SearchableMap.ts#L182">SearchableMap/SearchableMap.ts:182</a></li>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/0f0d056/src/SearchableMap/SearchableMap.ts#L182">SearchableMap/SearchableMap.ts:182</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -585,7 +587,7 @@ <h3>set</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/a24d97c/src/SearchableMap/SearchableMap.ts#L192">SearchableMap/SearchableMap.ts:192</a></li>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/0f0d056/src/SearchableMap/SearchableMap.ts#L192">SearchableMap/SearchableMap.ts:192</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -625,7 +627,7 @@ <h3>update</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/a24d97c/src/SearchableMap/SearchableMap.ts#L227">SearchableMap/SearchableMap.ts:227</a></li>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/0f0d056/src/SearchableMap/SearchableMap.ts#L227">SearchableMap/SearchableMap.ts:227</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -638,7 +640,8 @@ <h3>update</h3>
<h3>Example:</h3>
</a>
<pre><code class="language-javascript"><span class="hljs-comment">// Increment the current value by one</span>
searchableMap.update(<span class="hljs-string">&#x27;somekey&#x27;</span>, <span class="hljs-function">(<span class="hljs-params">currentValue</span>) =&gt;</span> currentValue == <span class="hljs-literal">null</span> ? <span class="hljs-number">0</span> : currentValue + <span class="hljs-number">1</span>)</code></pre>
searchableMap.update(<span class="hljs-string">&#x27;somekey&#x27;</span>, <span class="hljs-function">(<span class="hljs-params">currentValue</span>) =&gt;</span> currentValue == <span class="hljs-literal">null</span> ? <span class="hljs-number">0</span> : currentValue + <span class="hljs-number">1</span>)
</code></pre>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
Expand Down Expand Up @@ -688,7 +691,7 @@ <h3>values</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/a24d97c/src/SearchableMap/SearchableMap.ts#L239">SearchableMap/SearchableMap.ts:239</a></li>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/0f0d056/src/SearchableMap/SearchableMap.ts#L239">SearchableMap/SearchableMap.ts:239</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -713,7 +716,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> from</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/a24d97c/src/SearchableMap/SearchableMap.ts#L256">SearchableMap/SearchableMap.ts:256</a></li>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/0f0d056/src/SearchableMap/SearchableMap.ts#L256">SearchableMap/SearchableMap.ts:256</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -751,7 +754,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> from<wbr>Object</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/a24d97c/src/SearchableMap/SearchableMap.ts#L270">SearchableMap/SearchableMap.ts:270</a></li>
<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/0f0d056/src/SearchableMap/SearchableMap.ts#L270">SearchableMap/SearchableMap.ts:270</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/app.js
View file

Large diffs are not rendered by default.

Binary file modified docs/examples/billboard_1965-2015.json.gz
View file
Binary file not shown.
Loading

0 comments on commit b0cdeec

Please sign in to comment.