Skip to content

Commit

Permalink
Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@arv
arv committed Dec 1, 2020
1 parent ad3a1e4 commit 194a53f
Show file tree
Hide file tree
Showing 10 changed files with 94 additions and 58 deletions.
2 changes: 1 addition & 1 deletion docs/assets/js/search.js
View file

Large diffs are not rendered by default.

76 changes: 56 additions & 20 deletions docs/classes/replicache.html
View file

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/classes/repmwasminvoker.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/ccae585/src/repm-invoker.ts#L38">src/repm-invoker.ts:38</a></li>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/01cfddd/src/repm-invoker.ts#L38">src/repm-invoker.ts:38</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -138,7 +138,7 @@ <h3>invoke</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/ccae585/src/repm-invoker.ts#L54">src/repm-invoker.ts:54</a></li>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/01cfddd/src/repm-invoker.ts#L54">src/repm-invoker.ts:54</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down
10 changes: 5 additions & 5 deletions docs/classes/scanresult.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/ccae585/src/scan-iterator.ts#L136">src/scan-iterator.ts:136</a></li>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/01cfddd/src/scan-iterator.ts#L136">src/scan-iterator.ts:136</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -144,7 +144,7 @@ <h3>[<wbr>Symbol.async<wbr>Iterator]</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/ccae585/src/scan-iterator.ts#L142">src/scan-iterator.ts:142</a></li>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/01cfddd/src/scan-iterator.ts#L142">src/scan-iterator.ts:142</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AsyncIterableIterator</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">JSONValue</span><span class="tsd-signature-symbol">&gt;</span></h4>
Expand All @@ -161,7 +161,7 @@ <h3>entries</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/ccae585/src/scan-iterator.ts#L154">src/scan-iterator.ts:154</a></li>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/01cfddd/src/scan-iterator.ts#L154">src/scan-iterator.ts:154</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AsyncIterableIterator</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></h4>
Expand All @@ -178,7 +178,7 @@ <h3>keys</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/ccae585/src/scan-iterator.ts#L150">src/scan-iterator.ts:150</a></li>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/01cfddd/src/scan-iterator.ts#L150">src/scan-iterator.ts:150</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AsyncIterableIterator</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">K</span><span class="tsd-signature-symbol">&gt;</span></h4>
Expand All @@ -195,7 +195,7 @@ <h3>values</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/ccae585/src/scan-iterator.ts#L146">src/scan-iterator.ts:146</a></li>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/01cfddd/src/scan-iterator.ts#L146">src/scan-iterator.ts:146</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AsyncIterableIterator</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">JSONValue</span><span class="tsd-signature-symbol">&gt;</span></h4>
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/transactionclosederror.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/ccae585/src/transaction-closed-error.ts#L4">src/transaction-closed-error.ts:4</a></li>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/01cfddd/src/transaction-closed-error.ts#L4">src/transaction-closed-error.ts:4</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="transactionclosederror.html" class="tsd-signature-type">TransactionClosedError</a></h4>
Expand Down
14 changes: 7 additions & 7 deletions docs/globals.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ <h3>Invoker</h3>
<div class="tsd-signature tsd-kind-icon">Invoker<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>invoke<span class="tsd-signature-symbol">: </span><a href="interfaces/repminvoke.html" class="tsd-signature-type">REPMInvoke</a><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/ccae585/src/repm-invoker.ts#L9">src/repm-invoker.ts:9</a></li>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/01cfddd/src/repm-invoker.ts#L9">src/repm-invoker.ts:9</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -131,7 +131,7 @@ <h3>Key<wbr>Type<wbr>For<wbr>Scan<wbr>Options</h3>
<div class="tsd-signature tsd-kind-icon">Key<wbr>Type<wbr>For<wbr>Scan<wbr>Options&lt;O&gt;<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">O</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-symbol">{ </span>indexName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> ? </span><span class="tsd-signature-type">ScanOptionIndexedStartKey</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/ccae585/src/scan-options.ts#L51">src/scan-options.ts:51</a></li>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/01cfddd/src/scan-options.ts#L51">src/scan-options.ts:51</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -153,7 +153,7 @@ <h3>Mutator</h3>
<div class="tsd-signature tsd-kind-icon">Mutator&lt;Return, Args&gt;<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Return</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/ccae585/src/replicache.ts#L19">src/replicache.ts:19</a></li>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/01cfddd/src/replicache.ts#L19">src/replicache.ts:19</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -200,7 +200,7 @@ <h3>Scan<wbr>Index<wbr>Options</h3>
<div class="tsd-signature tsd-kind-icon">Scan<wbr>Index<wbr>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>indexName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>prefix<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>start<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>exclusive<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">; </span>key<span class="tsd-signature-symbol">: </span><a href="globals.html#scanoptionindexedstartkey" class="tsd-signature-type">ScanOptionIndexedStartKey</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/ccae585/src/scan-options.ts#L28">src/scan-options.ts:28</a></li>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/01cfddd/src/scan-options.ts#L28">src/scan-options.ts:28</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -254,7 +254,7 @@ <h3>Scan<wbr>NoIndex<wbr>Options</h3>
<div class="tsd-signature tsd-kind-icon">Scan<wbr>NoIndex<wbr>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>prefix<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>start<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>exclusive<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">; </span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/ccae585/src/scan-options.ts#L7">src/scan-options.ts:7</a></li>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/01cfddd/src/scan-options.ts#L7">src/scan-options.ts:7</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -298,7 +298,7 @@ <h3>Scan<wbr>Option<wbr>Indexed<wbr>Start<wbr>Key</h3>
<div class="tsd-signature tsd-kind-icon">Scan<wbr>Option<wbr>Indexed<wbr>Start<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/ccae585/src/scan-options.ts#L63">src/scan-options.ts:63</a></li>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/01cfddd/src/scan-options.ts#L63">src/scan-options.ts:63</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -316,7 +316,7 @@ <h3>Scan<wbr>Options</h3>
<div class="tsd-signature tsd-kind-icon">Scan<wbr>Options<span class="tsd-signature-symbol">:</span> <a href="globals.html#scanindexoptions" class="tsd-signature-type">ScanIndexOptions</a><span class="tsd-signature-symbol"> | </span><a href="globals.html#scannoindexoptions" class="tsd-signature-type">ScanNoIndexOptions</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/ccae585/src/scan-options.ts#L2">src/scan-options.ts:2</a></li>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/01cfddd/src/scan-options.ts#L2">src/scan-options.ts:2</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
8 changes: 4 additions & 4 deletions docs/interfaces/readtransaction.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ <h3>get</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/ccae585/src/transactions.ts#L20">src/transactions.ts:20</a></li>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/01cfddd/src/transactions.ts#L20">src/transactions.ts:20</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -146,7 +146,7 @@ <h3>has</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/ccae585/src/transactions.ts#L25">src/transactions.ts:25</a></li>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/01cfddd/src/transactions.ts#L25">src/transactions.ts:25</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -174,7 +174,7 @@ <h3>scan</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/ccae585/src/transactions.ts#L39">src/transactions.ts:39</a></li>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/01cfddd/src/transactions.ts#L39">src/transactions.ts:39</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -218,7 +218,7 @@ <h3>scan<wbr>All</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/ccae585/src/transactions.ts#L46">src/transactions.ts:46</a></li>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/01cfddd/src/transactions.ts#L46">src/transactions.ts:46</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
Loading

4 comments on commit 194a53f

@vercel
Copy link

@vercel vercel bot commented on 194a53f Dec 1, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

replicache-sdk-js – ./

replicache-sdk-js.now.sh
replicache-sdk-js.rocicorp.now.sh
replicache-sdk-js-git-master.rocicorp.now.sh
replicache-sdk-js-git-master.rocicorp.vercel.app
replicache-sdk-js.rocicorp.vercel.app
js.replicache.dev

@vercel
Copy link

@vercel vercel bot commented on 194a53f Dec 1, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

lithtml-todo-sample-ui – ./sample/lit-todo

replicache-lit-todo.vercel.app
lithtml-todo-sample-ui.rocicorp.vercel.app
lithtml-todo-sample-ui-git-master.rocicorp.vercel.app
redo.replicache.dev

@vercel
Copy link

@vercel vercel bot commented on 194a53f Dec 1, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

replicache-sdk-js-perf – ./dev/bench

replicache-sdk-js-perf-git-master.rocicorp.vercel.app
replicache-sdk-js-perf.vercel.app
replicache-sdk-js-perf.rocicorp.vercel.app

@arv
Copy link
Contributor Author

@arv arv commented on 194a53f Dec 1, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Performance Alert ⚠️

Possible performance regression was detected for benchmark.
Benchmark result of this commit is worse than the previous benchmark result exceeding threshold 1.30.

Benchmark suite Current: 194a53f Previous: d7770b9 Ratio
read tx 1024x1000 5.52 MB/s (±0.0%) 7.23 MB/s (±0.0%) 1.31

This comment was automatically generated by workflow using github-action-benchmark.

Please sign in to comment.