Skip to content

Commit

Permalink
Generated docs now point to master, this reduces the noisyness of doc…
Browse files Browse the repository at this point in the history 
… generation
  • Loading branch information
@CMCDragonkai
CMCDragonkai committed Nov 1, 2021
1 parent 4be28e0 commit 2732d79
Show file tree
Hide file tree
Showing 833 changed files with 174,114 additions and 73,431 deletions.
2 changes: 1 addition & 1 deletion docs/assets/js/search.js
View file

Large diffs are not rendered by default.

69 changes: 36 additions & 33 deletions docs/classes/PolykeyAgent.default.html
View file

Large diffs are not rendered by default.

33 changes: 18 additions & 15 deletions docs/classes/PolykeyClient.default.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ <h3>constructor</h3>
<aside class="tsd-sources">
<p>Inherited from CreateDestroyStartStop.constructor</p>
<ul>
<li>Defined in <a href="https://github.com/MatrixAI/js-polykey/blob/5633724/src/PolykeyClient.ts#L72">src/PolykeyClient.ts:72</a></li>
<li>Defined in <a href="https://github.com/MatrixAI/js-polykey/blob/master/src/PolykeyClient.ts#L72">src/PolykeyClient.ts:72</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down Expand Up @@ -177,7 +177,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> _grpc<wbr>Client</h
<div class="tsd-signature tsd-kind-icon">_grpc<wbr>Client<span class="tsd-signature-symbol">:</span> <a href="client_GRPCClientClient.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/MatrixAI/js-polykey/blob/5633724/src/PolykeyClient.ts#L32">src/PolykeyClient.ts:32</a></li>
<li>Defined in <a href="https://github.com/MatrixAI/js-polykey/blob/master/src/PolykeyClient.ts#L32">src/PolykeyClient.ts:32</a></li>
</ul>
</aside>
</section>
Expand All @@ -187,7 +187,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> client<wbr>Path</h3>
<div class="tsd-signature tsd-kind-icon">client<wbr>Path<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/MatrixAI/js-polykey/blob/5633724/src/PolykeyClient.ts#L40">src/PolykeyClient.ts:40</a></li>
<li>Defined in <a href="https://github.com/MatrixAI/js-polykey/blob/master/src/PolykeyClient.ts#L40">src/PolykeyClient.ts:40</a></li>
</ul>
</aside>
</section>
Expand All @@ -197,7 +197,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> fs</h3>
<div class="tsd-signature tsd-kind-icon">fs<span class="tsd-signature-symbol">:</span> <a href="../interfaces/types.FileSystem.html" class="tsd-signature-type" data-tsd-kind="Interface">FileSystem</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/MatrixAI/js-polykey/blob/5633724/src/PolykeyClient.ts#L36">src/PolykeyClient.ts:36</a></li>
<li>Defined in <a href="https://github.com/MatrixAI/js-polykey/blob/master/src/PolykeyClient.ts#L36">src/PolykeyClient.ts:36</a></li>
</ul>
</aside>
</section>
Expand All @@ -207,7 +207,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> grpc<wbr>Host</h3>
<div class="tsd-signature tsd-kind-icon">grpc<wbr>Host<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/MatrixAI/js-polykey/blob/5633724/src/PolykeyClient.ts#L37">src/PolykeyClient.ts:37</a></li>
<li>Defined in <a href="https://github.com/MatrixAI/js-polykey/blob/master/src/PolykeyClient.ts#L37">src/PolykeyClient.ts:37</a></li>
</ul>
</aside>
</section>
Expand All @@ -217,7 +217,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> grpc<wbr>Port</h3>
<div class="tsd-signature tsd-kind-icon">grpc<wbr>Port<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/MatrixAI/js-polykey/blob/5633724/src/PolykeyClient.ts#L38">src/PolykeyClient.ts:38</a></li>
<li>Defined in <a href="https://github.com/MatrixAI/js-polykey/blob/master/src/PolykeyClient.ts#L38">src/PolykeyClient.ts:38</a></li>
</ul>
</aside>
</section>
Expand All @@ -227,7 +227,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> lock<wbr>Path</h3>
<div class="tsd-signature tsd-kind-icon">lock<wbr>Path<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/MatrixAI/js-polykey/blob/5633724/src/PolykeyClient.ts#L39">src/PolykeyClient.ts:39</a></li>
<li>Defined in <a href="https://github.com/MatrixAI/js-polykey/blob/master/src/PolykeyClient.ts#L39">src/PolykeyClient.ts:39</a></li>
</ul>
</aside>
</section>
Expand All @@ -237,7 +237,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> logger</h3>
<div class="tsd-signature tsd-kind-icon">logger<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Logger</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/MatrixAI/js-polykey/blob/5633724/src/PolykeyClient.ts#L34">src/PolykeyClient.ts:34</a></li>
<li>Defined in <a href="https://github.com/MatrixAI/js-polykey/blob/master/src/PolykeyClient.ts#L34">src/PolykeyClient.ts:34</a></li>
</ul>
</aside>
</section>
Expand All @@ -247,7 +247,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> node<wbr>Path</h3>
<div class="tsd-signature tsd-kind-icon">node<wbr>Path<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/MatrixAI/js-polykey/blob/5633724/src/PolykeyClient.ts#L35">src/PolykeyClient.ts:35</a></li>
<li>Defined in <a href="https://github.com/MatrixAI/js-polykey/blob/master/src/PolykeyClient.ts#L35">src/PolykeyClient.ts:35</a></li>
</ul>
</aside>
</section>
Expand All @@ -257,7 +257,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> session</h3>
<div class="tsd-signature tsd-kind-icon">session<span class="tsd-signature-symbol">:</span> <a href="sessions_Session.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/MatrixAI/js-polykey/blob/5633724/src/PolykeyClient.ts#L43">src/PolykeyClient.ts:43</a></li>
<li>Defined in <a href="https://github.com/MatrixAI/js-polykey/blob/master/src/PolykeyClient.ts#L43">src/PolykeyClient.ts:43</a></li>
</ul>
</aside>
</section>
Expand Down Expand Up @@ -291,7 +291,7 @@ <h3>grpc<wbr>Client</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/MatrixAI/js-polykey/blob/5633724/src/PolykeyClient.ts#L160">src/PolykeyClient.ts:160</a></li>
<li>Defined in <a href="https://github.com/MatrixAI/js-polykey/blob/master/src/PolykeyClient.ts#L160">src/PolykeyClient.ts:160</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="client_GRPCClientClient.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a></h4>
Expand Down Expand Up @@ -329,7 +329,7 @@ <h3>destroy</h3>
<aside class="tsd-sources">
<p>Inherited from CreateDestroyStartStop.destroy</p>
<ul>
<li>Defined in <a href="https://github.com/MatrixAI/js-polykey/blob/5633724/src/PolykeyClient.ts#L156">src/PolykeyClient.ts:156</a></li>
<li>Defined in <a href="https://github.com/MatrixAI/js-polykey/blob/master/src/PolykeyClient.ts#L156">src/PolykeyClient.ts:156</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 @@ -347,7 +347,7 @@ <h3>start</h3>
<aside class="tsd-sources">
<p>Inherited from CreateDestroyStartStop.start</p>
<ul>
<li>Defined in <a href="https://github.com/MatrixAI/js-polykey/blob/5633724/src/PolykeyClient.ts#L93">src/PolykeyClient.ts:93</a></li>
<li>Defined in <a href="https://github.com/MatrixAI/js-polykey/blob/master/src/PolykeyClient.ts#L93">src/PolykeyClient.ts:93</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down Expand Up @@ -382,7 +382,7 @@ <h3>stop</h3>
<aside class="tsd-sources">
<p>Inherited from CreateDestroyStartStop.stop</p>
<ul>
<li>Defined in <a href="https://github.com/MatrixAI/js-polykey/blob/5633724/src/PolykeyClient.ts#L148">src/PolykeyClient.ts:148</a></li>
<li>Defined in <a href="https://github.com/MatrixAI/js-polykey/blob/master/src/PolykeyClient.ts#L148">src/PolykeyClient.ts:148</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 @@ -399,7 +399,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> create<wbr>Polykey<wbr>Cl
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/MatrixAI/js-polykey/blob/5633724/src/PolykeyClient.ts#L45">src/PolykeyClient.ts:45</a></li>
<li>Defined in <a href="https://github.com/MatrixAI/js-polykey/blob/master/src/PolykeyClient.ts#L45">src/PolykeyClient.ts:45</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down Expand Up @@ -528,6 +528,9 @@ <h2>Legend</h2>
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
</ul>
Expand Down
Loading

0 comments on commit 2732d79

Please sign in to comment.