Skip to content
This repository was archived by the owner on Jul 10, 2025. It is now read-only.

Commit 3ad6a41

Browse files
coder11coder11
authored
Docs: upate autogenerated gh page (#92)
1 parent 79ad433 commit 3ad6a41

File tree

9 files changed

+371
-33
lines changed

9 files changed

+371
-33
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/FluencePeer.html‎

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ <h3>constructor</h3>
121121
<li class="tsd-description">
122122
<aside class="tsd-sources">
123123
<ul>
124-
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/9f81458/src/internal/FluencePeer.ts#L132">internal/FluencePeer.ts:132</a></li>
124+
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/79ad433/src/internal/FluencePeer.ts#L140">internal/FluencePeer.ts:140</a></li>
125125
</ul>
126126
</aside>
127127
<div class="tsd-comment tsd-typography">
@@ -146,7 +146,7 @@ <h3>internals</h3>
146146
<li class="tsd-description">
147147
<aside class="tsd-sources">
148148
<ul>
149-
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/9f81458/src/internal/FluencePeer.ts#L225">internal/FluencePeer.ts:225</a></li>
149+
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/79ad433/src/internal/FluencePeer.ts#L235">internal/FluencePeer.ts:235</a></li>
150150
</ul>
151151
</aside>
152152
<div class="tsd-comment tsd-typography">
@@ -345,7 +345,7 @@ <h3>get<wbr>Status</h3>
345345
<li class="tsd-description">
346346
<aside class="tsd-sources">
347347
<ul>
348-
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/9f81458/src/internal/FluencePeer.ts#L150">internal/FluencePeer.ts:150</a></li>
348+
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/79ad433/src/internal/FluencePeer.ts#L158">internal/FluencePeer.ts:158</a></li>
349349
</ul>
350350
</aside>
351351
<div class="tsd-comment tsd-typography">
@@ -361,13 +361,13 @@ <h4 class="tsd-returns-title">Returns <a href="../interfaces/PeerStatus.html" cl
361361
<a name="start" class="tsd-anchor"></a>
362362
<h3>start</h3>
363363
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
364-
<li class="tsd-signature tsd-kind-icon">start<span class="tsd-signature-symbol">(</span>config<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">PeerConfig</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><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></li>
364+
<li class="tsd-signature tsd-kind-icon">start<span class="tsd-signature-symbol">(</span>config<span class="tsd-signature-symbol">?: </span><a href="../interfaces/PeerConfig.html" class="tsd-signature-type" data-tsd-kind="Interface">PeerConfig</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><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></li>
365365
</ul>
366366
<ul class="tsd-descriptions">
367367
<li class="tsd-description">
368368
<aside class="tsd-sources">
369369
<ul>
370-
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/9f81458/src/internal/FluencePeer.ts#L165">internal/FluencePeer.ts:165</a></li>
370+
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/79ad433/src/internal/FluencePeer.ts#L173">internal/FluencePeer.ts:173</a></li>
371371
</ul>
372372
</aside>
373373
<div class="tsd-comment tsd-typography">
@@ -379,7 +379,7 @@ <h3>start</h3>
379379
<h4 class="tsd-parameters-title">Parameters</h4>
380380
<ul class="tsd-parameters">
381381
<li>
382-
<h5><span class="tsd-flag ts-flagOptional">Optional</span> config: <span class="tsd-signature-type">PeerConfig</span></h5>
382+
<h5><span class="tsd-flag ts-flagOptional">Optional</span> config: <a href="../interfaces/PeerConfig.html" class="tsd-signature-type" data-tsd-kind="Interface">PeerConfig</a></h5>
383383
<div class="tsd-comment tsd-typography">
384384
<p>object specifying peer configuration</p>
385385
</div>
@@ -399,7 +399,7 @@ <h3>stop</h3>
399399
<li class="tsd-description">
400400
<aside class="tsd-sources">
401401
<ul>
402-
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/9f81458/src/internal/FluencePeer.ts#L209">internal/FluencePeer.ts:209</a></li>
402+
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/79ad433/src/internal/FluencePeer.ts#L219">internal/FluencePeer.ts:219</a></li>
403403
</ul>
404404
</aside>
405405
<div class="tsd-comment tsd-typography">
@@ -422,7 +422,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> is<wbr>Instance</h3>
422422
<li class="tsd-description">
423423
<aside class="tsd-sources">
424424
<ul>
425-
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/9f81458/src/internal/FluencePeer.ts#L139">internal/FluencePeer.ts:139</a></li>
425+
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/79ad433/src/internal/FluencePeer.ts#L147">internal/FluencePeer.ts:147</a></li>
426426
</ul>
427427
</aside>
428428
<div class="tsd-comment tsd-typography">
@@ -489,6 +489,9 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</
489489
<li class=" tsd-kind-interface tsd-has-type-parameter">
490490
<a href="../interfaces/CallParams.html" class="tsd-kind-icon">Call<wbr>Params</a>
491491
</li>
492+
<li class=" tsd-kind-interface">
493+
<a href="../interfaces/PeerConfig.html" class="tsd-kind-icon">Peer<wbr>Config</a>
494+
</li>
492495
<li class=" tsd-kind-interface">
493496
<a href="../interfaces/PeerStatus.html" class="tsd-kind-icon">Peer<wbr>Status</a>
494497
</li>

‎docs/classes/KeyPair.html‎

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ <h3>constructor</h3>
112112
<li class="tsd-description">
113113
<aside class="tsd-sources">
114114
<ul>
115-
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/9f81458/src/internal/KeyPair.ts#L26">internal/KeyPair.ts:26</a></li>
115+
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/79ad433/src/internal/KeyPair.ts#L26">internal/KeyPair.ts:26</a></li>
116116
</ul>
117117
</aside>
118118
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -134,7 +134,7 @@ <h3>Libp2p<wbr>Peer<wbr>Id</h3>
134134
<div class="tsd-signature tsd-kind-icon">Libp2p<wbr>Peer<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">PeerId</span></div>
135135
<aside class="tsd-sources">
136136
<ul>
137-
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/9f81458/src/internal/KeyPair.ts#L24">internal/KeyPair.ts:24</a></li>
137+
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/79ad433/src/internal/KeyPair.ts#L24">internal/KeyPair.ts:24</a></li>
138138
</ul>
139139
</aside>
140140
<div class="tsd-comment tsd-typography">
@@ -156,7 +156,7 @@ <h3>to<wbr>Ed25519<wbr>Private<wbr>Key</h3>
156156
<li class="tsd-description">
157157
<aside class="tsd-sources">
158158
<ul>
159-
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/9f81458/src/internal/KeyPair.ts#L54">internal/KeyPair.ts:54</a></li>
159+
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/79ad433/src/internal/KeyPair.ts#L54">internal/KeyPair.ts:54</a></li>
160160
</ul>
161161
</aside>
162162
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Uint8Array</span></h4>
@@ -174,7 +174,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> from<wbr>Ed25519SK</h3>
174174
<li class="tsd-description">
175175
<aside class="tsd-sources">
176176
<ul>
177-
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/9f81458/src/internal/KeyPair.ts#L35">internal/KeyPair.ts:35</a></li>
177+
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/79ad433/src/internal/KeyPair.ts#L35">internal/KeyPair.ts:35</a></li>
178178
</ul>
179179
</aside>
180180
<div class="tsd-comment tsd-typography">
@@ -205,7 +205,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> random<wbr>Ed25519</h3>
205205
<li class="tsd-description">
206206
<aside class="tsd-sources">
207207
<ul>
208-
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/9f81458/src/internal/KeyPair.ts#L46">internal/KeyPair.ts:46</a></li>
208+
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/79ad433/src/internal/KeyPair.ts#L46">internal/KeyPair.ts:46</a></li>
209209
</ul>
210210
</aside>
211211
<div class="tsd-comment tsd-typography">
@@ -262,6 +262,9 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
262262
<li class=" tsd-kind-interface tsd-has-type-parameter">
263263
<a href="../interfaces/CallParams.html" class="tsd-kind-icon">Call<wbr>Params</a>
264264
</li>
265+
<li class=" tsd-kind-interface">
266+
<a href="../interfaces/PeerConfig.html" class="tsd-kind-icon">Peer<wbr>Config</a>
267+
</li>
265268
<li class=" tsd-kind-interface">
266269
<a href="../interfaces/PeerStatus.html" class="tsd-kind-icon">Peer<wbr>Status</a>
267270
</li>

‎docs/index.html‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,9 @@ <h1>Fluence JS</h1>
9393
<li class=" tsd-kind-interface tsd-has-type-parameter">
9494
<a href="interfaces/CallParams.html" class="tsd-kind-icon">Call<wbr>Params</a>
9595
</li>
96+
<li class=" tsd-kind-interface">
97+
<a href="interfaces/PeerConfig.html" class="tsd-kind-icon">Peer<wbr>Config</a>
98+
</li>
9699
<li class=" tsd-kind-interface">
97100
<a href="interfaces/PeerStatus.html" class="tsd-kind-icon">Peer<wbr>Status</a>
98101
</li>

‎docs/interfaces/CallParams.html‎

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ <h3>init<wbr>Peer<wbr>Id</h3>
118118
<div class="tsd-signature tsd-kind-icon">init<wbr>Peer<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
119119
<aside class="tsd-sources">
120120
<ul>
121-
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/9f81458/src/internal/commonTypes.ts#L37">internal/commonTypes.ts:37</a></li>
121+
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/79ad433/src/internal/commonTypes.ts#L37">internal/commonTypes.ts:37</a></li>
122122
</ul>
123123
</aside>
124124
<div class="tsd-comment tsd-typography">
@@ -133,7 +133,7 @@ <h3>particle<wbr>Id</h3>
133133
<div class="tsd-signature tsd-kind-icon">particle<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
134134
<aside class="tsd-sources">
135135
<ul>
136-
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/9f81458/src/internal/commonTypes.ts#L32">internal/commonTypes.ts:32</a></li>
136+
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/79ad433/src/internal/commonTypes.ts#L32">internal/commonTypes.ts:32</a></li>
137137
</ul>
138138
</aside>
139139
<div class="tsd-comment tsd-typography">
@@ -148,7 +148,7 @@ <h3>signature</h3>
148148
<div class="tsd-signature tsd-kind-icon">signature<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
149149
<aside class="tsd-sources">
150150
<ul>
151-
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/9f81458/src/internal/commonTypes.ts#L52">internal/commonTypes.ts:52</a></li>
151+
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/79ad433/src/internal/commonTypes.ts#L52">internal/commonTypes.ts:52</a></li>
152152
</ul>
153153
</aside>
154154
<div class="tsd-comment tsd-typography">
@@ -163,7 +163,7 @@ <h3>tetraplets</h3>
163163
<div class="tsd-signature tsd-kind-icon">tetraplets<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><span class="tsd-signature-symbol">[ </span><span class="tsd-signature-type">key</span><span class="tsd-signature-symbol"> in </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">SecurityTetraplet</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> }</span></div>
164164
<aside class="tsd-sources">
165165
<ul>
166-
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/9f81458/src/internal/commonTypes.ts#L57">internal/commonTypes.ts:57</a></li>
166+
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/79ad433/src/internal/commonTypes.ts#L57">internal/commonTypes.ts:57</a></li>
167167
</ul>
168168
</aside>
169169
<div class="tsd-comment tsd-typography">
@@ -178,7 +178,7 @@ <h3>timestamp</h3>
178178
<div class="tsd-signature tsd-kind-icon">timestamp<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
179179
<aside class="tsd-sources">
180180
<ul>
181-
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/9f81458/src/internal/commonTypes.ts#L42">internal/commonTypes.ts:42</a></li>
181+
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/79ad433/src/internal/commonTypes.ts#L42">internal/commonTypes.ts:42</a></li>
182182
</ul>
183183
</aside>
184184
<div class="tsd-comment tsd-typography">
@@ -193,7 +193,7 @@ <h3>ttl</h3>
193193
<div class="tsd-signature tsd-kind-icon">ttl<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
194194
<aside class="tsd-sources">
195195
<ul>
196-
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/9f81458/src/internal/commonTypes.ts#L47">internal/commonTypes.ts:47</a></li>
196+
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/79ad433/src/internal/commonTypes.ts#L47">internal/commonTypes.ts:47</a></li>
197197
</ul>
198198
</aside>
199199
<div class="tsd-comment tsd-typography">
@@ -247,6 +247,9 @@ <h3>ttl</h3>
247247
</li>
248248
</ul>
249249
<ul class="after-current">
250+
<li class=" tsd-kind-interface">
251+
<a href="PeerConfig.html" class="tsd-kind-icon">Peer<wbr>Config</a>
252+
</li>
250253
<li class=" tsd-kind-interface">
251254
<a href="PeerStatus.html" class="tsd-kind-icon">Peer<wbr>Status</a>
252255
</li>

0 commit comments

Comments
 (0)