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

Commit 337a3f4

Browse files
authored
Compiler support: define and export FnConfig interface (#97)
1 parent 3ad6a41 commit 337a3f4

File tree

8 files changed

+49
-37
lines changed

8 files changed

+49
-37
lines changed

docs/classes/FluencePeer.html

Lines changed: 6 additions & 6 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/79ad433/src/internal/FluencePeer.ts#L140">internal/FluencePeer.ts:140</a></li>
124+
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/1fcd76a/src/internal/FluencePeer.ts#L139">internal/FluencePeer.ts:139</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/79ad433/src/internal/FluencePeer.ts#L235">internal/FluencePeer.ts:235</a></li>
149+
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/1fcd76a/src/internal/FluencePeer.ts#L237">internal/FluencePeer.ts:237</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/79ad433/src/internal/FluencePeer.ts#L158">internal/FluencePeer.ts:158</a></li>
348+
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/1fcd76a/src/internal/FluencePeer.ts#L157">internal/FluencePeer.ts:157</a></li>
349349
</ul>
350350
</aside>
351351
<div class="tsd-comment tsd-typography">
@@ -367,7 +367,7 @@ <h3>start</h3>
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/79ad433/src/internal/FluencePeer.ts#L173">internal/FluencePeer.ts:173</a></li>
370+
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/1fcd76a/src/internal/FluencePeer.ts#L172">internal/FluencePeer.ts:172</a></li>
371371
</ul>
372372
</aside>
373373
<div class="tsd-comment tsd-typography">
@@ -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/79ad433/src/internal/FluencePeer.ts#L219">internal/FluencePeer.ts:219</a></li>
402+
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/1fcd76a/src/internal/FluencePeer.ts#L221">internal/FluencePeer.ts:221</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/79ad433/src/internal/FluencePeer.ts#L147">internal/FluencePeer.ts:147</a></li>
425+
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/1fcd76a/src/internal/FluencePeer.ts#L146">internal/FluencePeer.ts:146</a></li>
426426
</ul>
427427
</aside>
428428
<div class="tsd-comment tsd-typography">

docs/classes/KeyPair.html

Lines changed: 5 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/79ad433/src/internal/KeyPair.ts#L26">internal/KeyPair.ts:26</a></li>
115+
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/1fcd76a/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/79ad433/src/internal/KeyPair.ts#L24">internal/KeyPair.ts:24</a></li>
137+
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/1fcd76a/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/79ad433/src/internal/KeyPair.ts#L54">internal/KeyPair.ts:54</a></li>
159+
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/1fcd76a/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/79ad433/src/internal/KeyPair.ts#L35">internal/KeyPair.ts:35</a></li>
177+
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/1fcd76a/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/79ad433/src/internal/KeyPair.ts#L46">internal/KeyPair.ts:46</a></li>
208+
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/1fcd76a/src/internal/KeyPair.ts#L46">internal/KeyPair.ts:46</a></li>
209209
</ul>
210210
</aside>
211211
<div class="tsd-comment tsd-typography">

docs/interfaces/CallParams.html

Lines changed: 6 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/79ad433/src/internal/commonTypes.ts#L37">internal/commonTypes.ts:37</a></li>
121+
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/1fcd76a/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/79ad433/src/internal/commonTypes.ts#L32">internal/commonTypes.ts:32</a></li>
136+
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/1fcd76a/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/79ad433/src/internal/commonTypes.ts#L52">internal/commonTypes.ts:52</a></li>
151+
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/1fcd76a/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/79ad433/src/internal/commonTypes.ts#L57">internal/commonTypes.ts:57</a></li>
166+
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/1fcd76a/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/79ad433/src/internal/commonTypes.ts#L42">internal/commonTypes.ts:42</a></li>
181+
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/1fcd76a/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/79ad433/src/internal/commonTypes.ts#L47">internal/commonTypes.ts:47</a></li>
196+
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/1fcd76a/src/internal/commonTypes.ts#L47">internal/commonTypes.ts:47</a></li>
197197
</ul>
198198
</aside>
199199
<div class="tsd-comment tsd-typography">

docs/interfaces/PeerConfig.html

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> Key<wbr>Pair</h3>
107107
<div class="tsd-signature tsd-kind-icon">Key<wbr>Pair<span class="tsd-signature-symbol">:</span> <a href="../classes/KeyPair.html" class="tsd-signature-type" data-tsd-kind="Class">KeyPair</a></div>
108108
<aside class="tsd-sources">
109109
<ul>
110-
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/79ad433/src/internal/FluencePeer.ts#L77">internal/FluencePeer.ts:77</a></li>
110+
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/1fcd76a/src/internal/FluencePeer.ts#L77">internal/FluencePeer.ts:77</a></li>
111111
</ul>
112112
</aside>
113113
<div class="tsd-comment tsd-typography">
@@ -123,7 +123,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> avm<wbr>Log<wbr>Level
123123
<div class="tsd-signature tsd-kind-icon">avm<wbr>Log<wbr>Level<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">LogLevel</span></div>
124124
<aside class="tsd-sources">
125125
<ul>
126-
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/79ad433/src/internal/FluencePeer.ts#L71">internal/FluencePeer.ts:71</a></li>
126+
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/1fcd76a/src/internal/FluencePeer.ts#L71">internal/FluencePeer.ts:71</a></li>
127127
</ul>
128128
</aside>
129129
<div class="tsd-comment tsd-typography">
@@ -138,7 +138,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> check<wbr>Connection<
138138
<div class="tsd-signature tsd-kind-icon">check<wbr>Connection<wbr>Timeout<wbr>Ms<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
139139
<aside class="tsd-sources">
140140
<ul>
141-
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/79ad433/src/internal/FluencePeer.ts#L84">internal/FluencePeer.ts:84</a></li>
141+
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/1fcd76a/src/internal/FluencePeer.ts#L84">internal/FluencePeer.ts:84</a></li>
142142
</ul>
143143
</aside>
144144
<div class="tsd-comment tsd-typography">
@@ -155,7 +155,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> connect<wbr>To</h3>
155155
<div class="tsd-signature tsd-kind-icon">connect<wbr>To<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Multiaddr</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Node</span></div>
156156
<aside class="tsd-sources">
157157
<ul>
158-
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/79ad433/src/internal/FluencePeer.ts#L66">internal/FluencePeer.ts:66</a></li>
158+
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/1fcd76a/src/internal/FluencePeer.ts#L66">internal/FluencePeer.ts:66</a></li>
159159
</ul>
160160
</aside>
161161
<div class="tsd-comment tsd-typography">
@@ -177,15 +177,14 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> default<wbr>Ttl<wbr>M
177177
<div class="tsd-signature tsd-kind-icon">default<wbr>Ttl<wbr>Ms<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
178178
<aside class="tsd-sources">
179179
<ul>
180-
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/79ad433/src/internal/FluencePeer.ts#L104">internal/FluencePeer.ts:104</a></li>
180+
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/1fcd76a/src/internal/FluencePeer.ts#L103">internal/FluencePeer.ts:103</a></li>
181181
</ul>
182182
</aside>
183183
<div class="tsd-comment tsd-typography">
184184
<div class="lead">
185185
<p>Sets the default TTL for all particles originating from the peer with no TTL specified.
186186
If the originating particle&#39;s TTL is defined then that value will be used
187-
If the option is not set default TTL will be 7000
188-
Value 0 (zero) is treated as if the option was not set</p>
187+
If the option is not set default TTL will be 7000</p>
189188
</div>
190189
</div>
191190
</section>
@@ -195,7 +194,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> dial<wbr>Timeout<wbr>
195194
<div class="tsd-signature tsd-kind-icon">dial<wbr>Timeout<wbr>Ms<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
196195
<aside class="tsd-sources">
197196
<ul>
198-
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/79ad433/src/internal/FluencePeer.ts#L96">internal/FluencePeer.ts:96</a></li>
197+
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/1fcd76a/src/internal/FluencePeer.ts#L96">internal/FluencePeer.ts:96</a></li>
199198
</ul>
200199
</aside>
201200
<div class="tsd-comment tsd-typography">
@@ -210,7 +209,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> skip<wbr>Check<wbr>Co
210209
<div class="tsd-signature tsd-kind-icon">skip<wbr>Check<wbr>Connection<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
211210
<aside class="tsd-sources">
212211
<ul>
213-
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/79ad433/src/internal/FluencePeer.ts#L91">internal/FluencePeer.ts:91</a></li>
212+
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/1fcd76a/src/internal/FluencePeer.ts#L91">internal/FluencePeer.ts:91</a></li>
214213
</ul>
215214
</aside>
216215
<div class="tsd-comment tsd-typography">

docs/interfaces/PeerStatus.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ <h3>is<wbr>Connected</h3>
104104
<div class="tsd-signature tsd-kind-icon">is<wbr>Connected<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Boolean</span></div>
105105
<aside class="tsd-sources">
106106
<ul>
107-
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/79ad433/src/internal/FluencePeer.ts#L119">internal/FluencePeer.ts:119</a></li>
107+
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/1fcd76a/src/internal/FluencePeer.ts#L118">internal/FluencePeer.ts:118</a></li>
108108
</ul>
109109
</aside>
110110
<div class="tsd-comment tsd-typography">
@@ -119,7 +119,7 @@ <h3>is<wbr>Initialized</h3>
119119
<div class="tsd-signature tsd-kind-icon">is<wbr>Initialized<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Boolean</span></div>
120120
<aside class="tsd-sources">
121121
<ul>
122-
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/79ad433/src/internal/FluencePeer.ts#L114">internal/FluencePeer.ts:114</a></li>
122+
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/1fcd76a/src/internal/FluencePeer.ts#L113">internal/FluencePeer.ts:113</a></li>
123123
</ul>
124124
</aside>
125125
<div class="tsd-comment tsd-typography">
@@ -134,7 +134,7 @@ <h3>peer<wbr>Id</h3>
134134
<div class="tsd-signature tsd-kind-icon">peer<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
135135
<aside class="tsd-sources">
136136
<ul>
137-
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/79ad433/src/internal/FluencePeer.ts#L124">internal/FluencePeer.ts:124</a></li>
137+
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/1fcd76a/src/internal/FluencePeer.ts#L123">internal/FluencePeer.ts:123</a></li>
138138
</ul>
139139
</aside>
140140
<div class="tsd-comment tsd-typography">
@@ -149,7 +149,7 @@ <h3>relay<wbr>Peer<wbr>Id</h3>
149149
<div class="tsd-signature tsd-kind-icon">relay<wbr>Peer<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
150150
<aside class="tsd-sources">
151151
<ul>
152-
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/79ad433/src/internal/FluencePeer.ts#L129">internal/FluencePeer.ts:129</a></li>
152+
<li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/1fcd76a/src/internal/FluencePeer.ts#L128">internal/FluencePeer.ts:128</a></li>
153153
</ul>
154154
</aside>
155155
<div class="tsd-comment tsd-typography">

0 commit comments

Comments
 (0)