Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@aboodman
aboodman committed Oct 16, 2020
1 parent 5416d7f commit 6e926be
Show file tree
Hide file tree
Showing 11 changed files with 84 additions and 49 deletions.
2 changes: 1 addition & 1 deletion docs/assets/js/search.js
View file

Large diffs are not rendered by default.

41 changes: 22 additions & 19 deletions docs/classes/replicache.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,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/96c90f0/src/replicache.ts#L85">src/replicache.ts:85</a></li>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/5a0a2f7/src/replicache.ts#L85">src/replicache.ts:85</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down Expand Up @@ -182,7 +182,7 @@ <h3>get<wbr>Data<wbr>Layer<wbr>Auth</h3>
<div class="tsd-signature tsd-kind-icon">get<wbr>Data<wbr>Layer<wbr>Auth<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-symbol"> =&gt; </span><span class="tsd-signature-type">MaybePromise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> = null</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/96c90f0/src/replicache.ts#L82">src/replicache.ts:82</a></li>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/5a0a2f7/src/replicache.ts#L82">src/replicache.ts:82</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -199,7 +199,7 @@ <h3>on<wbr>Sync</h3>
<div class="tsd-signature tsd-kind-icon">on<wbr>Sync<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>syncing<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> = null</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/96c90f0/src/replicache.ts#L75">src/replicache.ts:75</a></li>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/5a0a2f7/src/replicache.ts#L75">src/replicache.ts:75</a></li>
</ul>
</aside>
</section>
Expand All @@ -209,7 +209,7 @@ <h3>push<wbr>Delay</h3>
<div class="tsd-signature tsd-kind-icon">push<wbr>Delay<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/96c90f0/src/replicache.ts#L73">src/replicache.ts:73</a></li>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/5a0a2f7/src/replicache.ts#L73">src/replicache.ts:73</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -232,7 +232,7 @@ <h3>closed</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/96c90f0/src/replicache.ts#L123">src/replicache.ts:123</a></li>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/5a0a2f7/src/replicache.ts#L123">src/replicache.ts:123</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
Expand All @@ -249,7 +249,7 @@ <h3>online</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/96c90f0/src/replicache.ts#L119">src/replicache.ts:119</a></li>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/5a0a2f7/src/replicache.ts#L119">src/replicache.ts:119</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
Expand All @@ -267,7 +267,7 @@ <h3>sync<wbr>Interval</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/96c90f0/src/replicache.ts#L131">src/replicache.ts:131</a></li>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/5a0a2f7/src/replicache.ts#L131">src/replicache.ts:131</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -281,7 +281,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</s
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/96c90f0/src/replicache.ts#L134">src/replicache.ts:134</a></li>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/5a0a2f7/src/replicache.ts#L134">src/replicache.ts:134</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -313,7 +313,7 @@ <h3>close</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/96c90f0/src/replicache.ts#L153">src/replicache.ts:153</a></li>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/5a0a2f7/src/replicache.ts#L153">src/replicache.ts:153</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
Expand All @@ -331,7 +331,7 @@ <h3>get</h3>
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/readtransaction.html">ReadTransaction</a>.<a href="../interfaces/readtransaction.html#get">get</a></p>
<ul>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/96c90f0/src/replicache.ts#L213">src/replicache.ts:213</a></li>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/5a0a2f7/src/replicache.ts#L213">src/replicache.ts:213</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -360,7 +360,7 @@ <h3>has</h3>
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/readtransaction.html">ReadTransaction</a>.<a href="../interfaces/readtransaction.html#has">has</a></p>
<ul>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/96c90f0/src/replicache.ts#L218">src/replicache.ts:218</a></li>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/5a0a2f7/src/replicache.ts#L218">src/replicache.ts:218</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -388,7 +388,7 @@ <h3>query</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/96c90f0/src/replicache.ts#L508">src/replicache.ts:508</a></li>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/5a0a2f7/src/replicache.ts#L509">src/replicache.ts:509</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -442,7 +442,7 @@ <h3>register</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/96c90f0/src/replicache.ts#L550">src/replicache.ts:550</a></li>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/5a0a2f7/src/replicache.ts#L551">src/replicache.ts:551</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -504,13 +504,13 @@ <h4 class="tsd-returns-title">Returns <a href="../globals.html#mutator" class="t
<a name="scan" class="tsd-anchor"></a>
<h3>scan</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">scan<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>prefix<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><a href="../interfaces/scanbound.html" class="tsd-signature-type">ScanBound</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="scanresult.html" class="tsd-signature-type">ScanResult</a></li>
<li class="tsd-signature tsd-kind-icon">scan<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>indexName<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>prefix<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><a href="../interfaces/scanbound.html" class="tsd-signature-type">ScanBound</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="scanresult.html" class="tsd-signature-type">ScanResult</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/96c90f0/src/replicache.ts#L227">src/replicache.ts:227</a></li>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/5a0a2f7/src/replicache.ts#L227">src/replicache.ts:227</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -523,8 +523,11 @@ <h3>scan</h3>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> __namedParameters: <span class="tsd-signature-symbol">{ </span>prefix<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><a href="../interfaces/scanbound.html" class="tsd-signature-type">ScanBound</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = {}</span></h5>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> __namedParameters: <span class="tsd-signature-symbol">{ </span>indexName<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>prefix<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><a href="../interfaces/scanbound.html" class="tsd-signature-type">ScanBound</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = {}</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>index<wbr>Name<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></h5>
</li>
<li class="tsd-parameter">
<h5>prefix<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
Expand All @@ -549,7 +552,7 @@ <h3>scan<wbr>All</h3>
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/readtransaction.html">ReadTransaction</a>.<a href="../interfaces/readtransaction.html#scanall">scanAll</a></p>
<ul>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/96c90f0/src/replicache.ts#L248">src/replicache.ts:248</a></li>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/5a0a2f7/src/replicache.ts#L249">src/replicache.ts:249</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -577,7 +580,7 @@ <h3>subscribe</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/96c90f0/src/replicache.ts#L472">src/replicache.ts:472</a></li>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/5a0a2f7/src/replicache.ts#L473">src/replicache.ts:473</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -683,7 +686,7 @@ <h3>sync</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/96c90f0/src/replicache.ts#L409">src/replicache.ts:409</a></li>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/5a0a2f7/src/replicache.ts#L410">src/replicache.ts:410</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
4 changes: 2 additions & 2 deletions docs/classes/repmwasminvoker.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,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/96c90f0/src/repm-invoker.ts#L35">src/repm-invoker.ts:35</a></li>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/5a0a2f7/src/repm-invoker.ts#L35">src/repm-invoker.ts:35</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -127,7 +127,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/96c90f0/src/repm-invoker.ts#L42">src/repm-invoker.ts:42</a></li>
<li>Defined in <a href="https://github.com/rocicorp/replicache-sdk-js/blob/5a0a2f7/src/repm-invoker.ts#L42">src/repm-invoker.ts:42</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down
Loading

1 comment on commit 6e926be

@vercel
Copy link

@vercel vercel bot commented on 6e926be Oct 16, 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
js.replicache.dev
replicache-sdk-js.rocicorp.vercel.app
replicache-sdk-js-git-master.rocicorp.vercel.app
replicache-sdk-js.rocicorp.now.sh
replicache-sdk-js-git-master.rocicorp.now.sh

Please sign in to comment.