Skip to content

Commit 2732d79

Browse files
CMCDragonkaiCMCDragonkai
committed
Generated docs now point to master, this reduces the noisyness of doc generation
1 parent 4be28e0 commit 2732d79

File tree

833 files changed

+174114
-73431
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

833 files changed

+174114
-73431
lines changed

‎docs/assets/js/search.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/classes/PolykeyAgent.default.html‎

Lines changed: 36 additions & 33 deletions
Large diffs are not rendered by default.

‎docs/classes/PolykeyClient.default.html‎

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ <h3>constructor</h3>
138138
<aside class="tsd-sources">
139139
<p>Inherited from CreateDestroyStartStop.constructor</p>
140140
<ul>
141-
<li>Defined in <a href="https://github.com/MatrixAI/js-polykey/blob/5633724/src/PolykeyClient.ts#L72">src/PolykeyClient.ts:72</a></li>
141+
<li>Defined in <a href="https://github.com/MatrixAI/js-polykey/blob/master/src/PolykeyClient.ts#L72">src/PolykeyClient.ts:72</a></li>
142142
</ul>
143143
</aside>
144144
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -177,7 +177,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> _grpc<wbr>Client</h
177177
<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>
178178
<aside class="tsd-sources">
179179
<ul>
180-
<li>Defined in <a href="https://github.com/MatrixAI/js-polykey/blob/5633724/src/PolykeyClient.ts#L32">src/PolykeyClient.ts:32</a></li>
180+
<li>Defined in <a href="https://github.com/MatrixAI/js-polykey/blob/master/src/PolykeyClient.ts#L32">src/PolykeyClient.ts:32</a></li>
181181
</ul>
182182
</aside>
183183
</section>
@@ -187,7 +187,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> client<wbr>Path</h3>
187187
<div class="tsd-signature tsd-kind-icon">client<wbr>Path<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
188188
<aside class="tsd-sources">
189189
<ul>
190-
<li>Defined in <a href="https://github.com/MatrixAI/js-polykey/blob/5633724/src/PolykeyClient.ts#L40">src/PolykeyClient.ts:40</a></li>
190+
<li>Defined in <a href="https://github.com/MatrixAI/js-polykey/blob/master/src/PolykeyClient.ts#L40">src/PolykeyClient.ts:40</a></li>
191191
</ul>
192192
</aside>
193193
</section>
@@ -197,7 +197,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> fs</h3>
197197
<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>
198198
<aside class="tsd-sources">
199199
<ul>
200-
<li>Defined in <a href="https://github.com/MatrixAI/js-polykey/blob/5633724/src/PolykeyClient.ts#L36">src/PolykeyClient.ts:36</a></li>
200+
<li>Defined in <a href="https://github.com/MatrixAI/js-polykey/blob/master/src/PolykeyClient.ts#L36">src/PolykeyClient.ts:36</a></li>
201201
</ul>
202202
</aside>
203203
</section>
@@ -207,7 +207,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> grpc<wbr>Host</h3>
207207
<div class="tsd-signature tsd-kind-icon">grpc<wbr>Host<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
208208
<aside class="tsd-sources">
209209
<ul>
210-
<li>Defined in <a href="https://github.com/MatrixAI/js-polykey/blob/5633724/src/PolykeyClient.ts#L37">src/PolykeyClient.ts:37</a></li>
210+
<li>Defined in <a href="https://github.com/MatrixAI/js-polykey/blob/master/src/PolykeyClient.ts#L37">src/PolykeyClient.ts:37</a></li>
211211
</ul>
212212
</aside>
213213
</section>
@@ -217,7 +217,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> grpc<wbr>Port</h3>
217217
<div class="tsd-signature tsd-kind-icon">grpc<wbr>Port<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
218218
<aside class="tsd-sources">
219219
<ul>
220-
<li>Defined in <a href="https://github.com/MatrixAI/js-polykey/blob/5633724/src/PolykeyClient.ts#L38">src/PolykeyClient.ts:38</a></li>
220+
<li>Defined in <a href="https://github.com/MatrixAI/js-polykey/blob/master/src/PolykeyClient.ts#L38">src/PolykeyClient.ts:38</a></li>
221221
</ul>
222222
</aside>
223223
</section>
@@ -227,7 +227,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> lock<wbr>Path</h3>
227227
<div class="tsd-signature tsd-kind-icon">lock<wbr>Path<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
228228
<aside class="tsd-sources">
229229
<ul>
230-
<li>Defined in <a href="https://github.com/MatrixAI/js-polykey/blob/5633724/src/PolykeyClient.ts#L39">src/PolykeyClient.ts:39</a></li>
230+
<li>Defined in <a href="https://github.com/MatrixAI/js-polykey/blob/master/src/PolykeyClient.ts#L39">src/PolykeyClient.ts:39</a></li>
231231
</ul>
232232
</aside>
233233
</section>
@@ -237,7 +237,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> logger</h3>
237237
<div class="tsd-signature tsd-kind-icon">logger<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Logger</span></div>
238238
<aside class="tsd-sources">
239239
<ul>
240-
<li>Defined in <a href="https://github.com/MatrixAI/js-polykey/blob/5633724/src/PolykeyClient.ts#L34">src/PolykeyClient.ts:34</a></li>
240+
<li>Defined in <a href="https://github.com/MatrixAI/js-polykey/blob/master/src/PolykeyClient.ts#L34">src/PolykeyClient.ts:34</a></li>
241241
</ul>
242242
</aside>
243243
</section>
@@ -247,7 +247,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> node<wbr>Path</h3>
247247
<div class="tsd-signature tsd-kind-icon">node<wbr>Path<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
248248
<aside class="tsd-sources">
249249
<ul>
250-
<li>Defined in <a href="https://github.com/MatrixAI/js-polykey/blob/5633724/src/PolykeyClient.ts#L35">src/PolykeyClient.ts:35</a></li>
250+
<li>Defined in <a href="https://github.com/MatrixAI/js-polykey/blob/master/src/PolykeyClient.ts#L35">src/PolykeyClient.ts:35</a></li>
251251
</ul>
252252
</aside>
253253
</section>
@@ -257,7 +257,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> session</h3>
257257
<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>
258258
<aside class="tsd-sources">
259259
<ul>
260-
<li>Defined in <a href="https://github.com/MatrixAI/js-polykey/blob/5633724/src/PolykeyClient.ts#L43">src/PolykeyClient.ts:43</a></li>
260+
<li>Defined in <a href="https://github.com/MatrixAI/js-polykey/blob/master/src/PolykeyClient.ts#L43">src/PolykeyClient.ts:43</a></li>
261261
</ul>
262262
</aside>
263263
</section>
@@ -291,7 +291,7 @@ <h3>grpc<wbr>Client</h3>
291291
<li class="tsd-description">
292292
<aside class="tsd-sources">
293293
<ul>
294-
<li>Defined in <a href="https://github.com/MatrixAI/js-polykey/blob/5633724/src/PolykeyClient.ts#L160">src/PolykeyClient.ts:160</a></li>
294+
<li>Defined in <a href="https://github.com/MatrixAI/js-polykey/blob/master/src/PolykeyClient.ts#L160">src/PolykeyClient.ts:160</a></li>
295295
</ul>
296296
</aside>
297297
<h4 class="tsd-returns-title">Returns <a href="client_GRPCClientClient.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a></h4>
@@ -329,7 +329,7 @@ <h3>destroy</h3>
329329
<aside class="tsd-sources">
330330
<p>Inherited from CreateDestroyStartStop.destroy</p>
331331
<ul>
332-
<li>Defined in <a href="https://github.com/MatrixAI/js-polykey/blob/5633724/src/PolykeyClient.ts#L156">src/PolykeyClient.ts:156</a></li>
332+
<li>Defined in <a href="https://github.com/MatrixAI/js-polykey/blob/master/src/PolykeyClient.ts#L156">src/PolykeyClient.ts:156</a></li>
333333
</ul>
334334
</aside>
335335
<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>
@@ -347,7 +347,7 @@ <h3>start</h3>
347347
<aside class="tsd-sources">
348348
<p>Inherited from CreateDestroyStartStop.start</p>
349349
<ul>
350-
<li>Defined in <a href="https://github.com/MatrixAI/js-polykey/blob/5633724/src/PolykeyClient.ts#L93">src/PolykeyClient.ts:93</a></li>
350+
<li>Defined in <a href="https://github.com/MatrixAI/js-polykey/blob/master/src/PolykeyClient.ts#L93">src/PolykeyClient.ts:93</a></li>
351351
</ul>
352352
</aside>
353353
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -382,7 +382,7 @@ <h3>stop</h3>
382382
<aside class="tsd-sources">
383383
<p>Inherited from CreateDestroyStartStop.stop</p>
384384
<ul>
385-
<li>Defined in <a href="https://github.com/MatrixAI/js-polykey/blob/5633724/src/PolykeyClient.ts#L148">src/PolykeyClient.ts:148</a></li>
385+
<li>Defined in <a href="https://github.com/MatrixAI/js-polykey/blob/master/src/PolykeyClient.ts#L148">src/PolykeyClient.ts:148</a></li>
386386
</ul>
387387
</aside>
388388
<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>
@@ -399,7 +399,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> create<wbr>Polykey<wbr>Cl
399399
<li class="tsd-description">
400400
<aside class="tsd-sources">
401401
<ul>
402-
<li>Defined in <a href="https://github.com/MatrixAI/js-polykey/blob/5633724/src/PolykeyClient.ts#L45">src/PolykeyClient.ts:45</a></li>
402+
<li>Defined in <a href="https://github.com/MatrixAI/js-polykey/blob/master/src/PolykeyClient.ts#L45">src/PolykeyClient.ts:45</a></li>
403403
</ul>
404404
</aside>
405405
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -528,6 +528,9 @@ <h2>Legend</h2>
528528
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
529529
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
530530
</ul>
531+
<ul class="tsd-legend">
532+
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
533+
</ul>
531534
<ul class="tsd-legend">
532535
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
533536
</ul>

0 commit comments

Comments
 (0)