Browse Source

test checkin docs

master
peter 4 years ago
parent
commit
2e311e4881

+ 13
- 0
docs/README.md View File

@@ -0,0 +1,13 @@
1
+[rpclibrary](README.md)
2
+
3
+# rpclibrary
4
+
5
+## Index
6
+
7
+### External modules
8
+
9
+* ["Backend"](modules/_backend_.md)
10
+* ["Frontend"](modules/_frontend_.md)
11
+* ["Interfaces"](modules/_interfaces_.md)
12
+* ["Types"](modules/_types_.md)
13
+* ["Utils"](modules/_utils_.md)

+ 0
- 2333
docs/assets/css/main.css
File diff suppressed because it is too large
View File


BIN
docs/assets/images/icons.png View File


BIN
docs/assets/images/icons@2x.png View File


BIN
docs/assets/images/widgets.png View File


BIN
docs/assets/images/widgets@2x.png View File


+ 0
- 447
docs/classes/_backend_.rpcserver.html View File

@@ -1,447 +0,0 @@
1
-<!doctype html>
2
-<html class="default no-js">
3
-<head>
4
-	<meta charset="utf-8">
5
-	<meta http-equiv="X-UA-Compatible" content="IE=edge">
6
-	<title>RPCServer | rpclibrary</title>
7
-	<meta name="description" content="">
8
-	<meta name="viewport" content="width=device-width, initial-scale=1">
9
-	<link rel="stylesheet" href="../assets/css/main.css">
10
-</head>
11
-<body>
12
-<header>
13
-	<div class="tsd-page-toolbar">
14
-		<div class="container">
15
-			<div class="table-wrap">
16
-				<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
17
-					<div class="field">
18
-						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
19
-						<input id="tsd-search-field" type="text" />
20
-					</div>
21
-					<ul class="results">
22
-						<li class="state loading">Preparing search index...</li>
23
-						<li class="state failure">The search index is not available</li>
24
-					</ul>
25
-					<a href="../index.html" class="title">rpclibrary</a>
26
-				</div>
27
-				<div class="table-cell" id="tsd-widgets">
28
-					<div id="tsd-filter">
29
-						<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
30
-						<div class="tsd-filter-group">
31
-							<div class="tsd-select" id="tsd-filter-visibility">
32
-								<span class="tsd-select-label">All</span>
33
-								<ul class="tsd-select-list">
34
-									<li data-value="public">Public</li>
35
-									<li data-value="protected">Public/Protected</li>
36
-									<li data-value="private" class="selected">All</li>
37
-								</ul>
38
-							</div>
39
-							<input type="checkbox" id="tsd-filter-inherited" checked />
40
-							<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
41
-							<input type="checkbox" id="tsd-filter-externals" checked />
42
-							<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
43
-							<input type="checkbox" id="tsd-filter-only-exported" />
44
-							<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
45
-						</div>
46
-					</div>
47
-					<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
48
-				</div>
49
-			</div>
50
-		</div>
51
-	</div>
52
-	<div class="tsd-page-title">
53
-		<div class="container">
54
-			<ul class="tsd-breadcrumb">
55
-				<li>
56
-					<a href="../index.html">Globals</a>
57
-				</li>
58
-				<li>
59
-					<a href="../modules/_backend_.html">&quot;Backend&quot;</a>
60
-				</li>
61
-				<li>
62
-					<a href="_backend_.rpcserver.html">RPCServer</a>
63
-				</li>
64
-			</ul>
65
-			<h1>Class RPCServer&lt;SubResType&gt;</h1>
66
-		</div>
67
-	</div>
68
-</header>
69
-<div class="container container-main">
70
-	<div class="row">
71
-		<div class="col-8 col-content">
72
-			<section class="tsd-panel tsd-type-parameters">
73
-				<h3>Type parameters</h3>
74
-				<ul class="tsd-type-parameters">
75
-					<li>
76
-						<h4>SubResType</h4>
77
-					</li>
78
-				</ul>
79
-			</section>
80
-			<section class="tsd-panel tsd-hierarchy">
81
-				<h3>Hierarchy</h3>
82
-				<ul class="tsd-hierarchy">
83
-					<li>
84
-						<span class="target">RPCServer</span>
85
-					</li>
86
-				</ul>
87
-			</section>
88
-			<section class="tsd-panel">
89
-				<h3>Implements</h3>
90
-				<ul class="tsd-hierarchy">
91
-					<li><a href="../interfaces/_interfaces_.destroyable.html" class="tsd-signature-type">Destroyable</a></li>
92
-				</ul>
93
-			</section>
94
-			<section class="tsd-panel-group tsd-index-group">
95
-				<h2>Index</h2>
96
-				<section class="tsd-panel tsd-index-panel">
97
-					<div class="tsd-index-content">
98
-						<section class="tsd-index-section ">
99
-							<h3>Constructors</h3>
100
-							<ul class="tsd-index-list">
101
-								<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="_backend_.rpcserver.html#constructor" class="tsd-kind-icon">constructor</a></li>
102
-							</ul>
103
-						</section>
104
-						<section class="tsd-index-section tsd-is-private tsd-is-private-protected">
105
-							<h3>Properties</h3>
106
-							<ul class="tsd-index-list">
107
-								<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_backend_.rpcserver.html#closehandler" class="tsd-kind-icon">close<wbr>Handler</a></li>
108
-								<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_backend_.rpcserver.html#connectionhandler" class="tsd-kind-icon">connection<wbr>Handler</a></li>
109
-								<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_backend_.rpcserver.html#errorhandler" class="tsd-kind-icon">error<wbr>Handler</a></li>
110
-								<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_backend_.rpcserver.html#exporters" class="tsd-kind-icon">exporters</a></li>
111
-								<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_backend_.rpcserver.html#io" class="tsd-kind-icon">io</a></li>
112
-								<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_backend_.rpcserver.html#port" class="tsd-kind-icon">port</a></li>
113
-								<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_backend_.rpcserver.html#visibility" class="tsd-kind-icon">visibility</a></li>
114
-								<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_backend_.rpcserver.html#ws" class="tsd-kind-icon">ws</a></li>
115
-							</ul>
116
-						</section>
117
-						<section class="tsd-index-section ">
118
-							<h3>Methods</h3>
119
-							<ul class="tsd-index-list">
120
-								<li class="tsd-kind-method tsd-parent-kind-class"><a href="_backend_.rpcserver.html#destroy" class="tsd-kind-icon">destroy</a></li>
121
-								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="_backend_.rpcserver.html#initrpcs" class="tsd-kind-icon">initRPCs</a></li>
122
-								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_backend_.rpcserver.html#startwebsocket" class="tsd-kind-icon">start<wbr>Websocket</a></li>
123
-							</ul>
124
-						</section>
125
-					</div>
126
-				</section>
127
-			</section>
128
-			<section class="tsd-panel-group tsd-member-group ">
129
-				<h2>Constructors</h2>
130
-				<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
131
-					<a name="constructor" class="tsd-anchor"></a>
132
-					<h3>constructor</h3>
133
-					<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
134
-						<li class="tsd-signature tsd-kind-icon">new RPCServer<span class="tsd-signature-symbol">(</span>port<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, exporters<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_interfaces_.exporter.html" class="tsd-signature-type">Exporter</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">SubResType</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span>, conf<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">T.SocketConf</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_backend_.rpcserver.html" class="tsd-signature-type">RPCServer</a></li>
135
-					</ul>
136
-					<ul class="tsd-descriptions">
137
-						<li class="tsd-description">
138
-							<aside class="tsd-sources">
139
-								<ul>
140
-									<li>Defined in Backend.ts:19</li>
141
-								</ul>
142
-							</aside>
143
-							<h4 class="tsd-parameters-title">Parameters</h4>
144
-							<ul class="tsd-parameters">
145
-								<li>
146
-									<h5>port: <span class="tsd-signature-type">number</span></h5>
147
-								</li>
148
-								<li>
149
-									<h5><span class="tsd-flag ts-flagDefault value">Default value</span> exporters: <a href="../interfaces/_interfaces_.exporter.html" class="tsd-signature-type">Exporter</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">SubResType</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> =&nbsp;[]</span></h5>
150
-								</li>
151
-								<li>
152
-									<h5><span class="tsd-flag ts-flagDefault value">Default value</span> conf: <span class="tsd-signature-type">T.SocketConf</span><span class="tsd-signature-symbol"> =&nbsp;{}</span></h5>
153
-								</li>
154
-							</ul>
155
-							<h4 class="tsd-returns-title">Returns <a href="_backend_.rpcserver.html" class="tsd-signature-type">RPCServer</a></h4>
156
-						</li>
157
-					</ul>
158
-				</section>
159
-			</section>
160
-			<section class="tsd-panel-group tsd-member-group tsd-is-private tsd-is-private-protected">
161
-				<h2>Properties</h2>
162
-				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
163
-					<a name="closehandler" class="tsd-anchor"></a>
164
-					<h3><span class="tsd-flag ts-flagPrivate">Private</span> close<wbr>Handler</h3>
165
-					<div class="tsd-signature tsd-kind-icon">close<wbr>Handler<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">T.CloseHandler</span></div>
166
-					<aside class="tsd-sources">
167
-						<ul>
168
-							<li>Defined in Backend.ts:17</li>
169
-						</ul>
170
-					</aside>
171
-				</section>
172
-				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
173
-					<a name="connectionhandler" class="tsd-anchor"></a>
174
-					<h3><span class="tsd-flag ts-flagPrivate">Private</span> connection<wbr>Handler</h3>
175
-					<div class="tsd-signature tsd-kind-icon">connection<wbr>Handler<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">T.ConnectionHandler</span></div>
176
-					<aside class="tsd-sources">
177
-						<ul>
178
-							<li>Defined in Backend.ts:19</li>
179
-						</ul>
180
-					</aside>
181
-				</section>
182
-				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
183
-					<a name="errorhandler" class="tsd-anchor"></a>
184
-					<h3><span class="tsd-flag ts-flagPrivate">Private</span> error<wbr>Handler</h3>
185
-					<div class="tsd-signature tsd-kind-icon">error<wbr>Handler<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">T.ErrorHandler</span></div>
186
-					<aside class="tsd-sources">
187
-						<ul>
188
-							<li>Defined in Backend.ts:18</li>
189
-						</ul>
190
-					</aside>
191
-				</section>
192
-				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
193
-					<a name="exporters" class="tsd-anchor"></a>
194
-					<h3><span class="tsd-flag ts-flagPrivate">Private</span> exporters</h3>
195
-					<div class="tsd-signature tsd-kind-icon">exporters<span class="tsd-signature-symbol">:</span> <a href="../interfaces/_interfaces_.exporter.html" class="tsd-signature-type">Exporter</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">SubResType</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span></div>
196
-					<aside class="tsd-sources">
197
-						<ul>
198
-							<li>Defined in Backend.ts:23</li>
199
-						</ul>
200
-					</aside>
201
-				</section>
202
-				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
203
-					<a name="io" class="tsd-anchor"></a>
204
-					<h3><span class="tsd-flag ts-flagPrivate">Private</span> io</h3>
205
-					<div class="tsd-signature tsd-kind-icon">io<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> =&nbsp;bsock.createServer()</span></div>
206
-					<aside class="tsd-sources">
207
-						<ul>
208
-							<li>Defined in Backend.ts:15</li>
209
-						</ul>
210
-					</aside>
211
-				</section>
212
-				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
213
-					<a name="port" class="tsd-anchor"></a>
214
-					<h3><span class="tsd-flag ts-flagPrivate">Private</span> port</h3>
215
-					<div class="tsd-signature tsd-kind-icon">port<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
216
-					<aside class="tsd-sources">
217
-						<ul>
218
-							<li>Defined in Backend.ts:22</li>
219
-						</ul>
220
-					</aside>
221
-				</section>
222
-				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
223
-					<a name="visibility" class="tsd-anchor"></a>
224
-					<h3><span class="tsd-flag ts-flagPrivate">Private</span> visibility</h3>
225
-					<div class="tsd-signature tsd-kind-icon">visibility<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">T.Visibility</span></div>
226
-					<aside class="tsd-sources">
227
-						<ul>
228
-							<li>Defined in Backend.ts:16</li>
229
-						</ul>
230
-					</aside>
231
-				</section>
232
-				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
233
-					<a name="ws" class="tsd-anchor"></a>
234
-					<h3><span class="tsd-flag ts-flagPrivate">Private</span> ws</h3>
235
-					<div class="tsd-signature tsd-kind-icon">ws<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Server</span><span class="tsd-signature-symbol"> =&nbsp;http.createServer()</span></div>
236
-					<aside class="tsd-sources">
237
-						<ul>
238
-							<li>Defined in Backend.ts:14</li>
239
-						</ul>
240
-					</aside>
241
-				</section>
242
-			</section>
243
-			<section class="tsd-panel-group tsd-member-group ">
244
-				<h2>Methods</h2>
245
-				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
246
-					<a name="destroy" class="tsd-anchor"></a>
247
-					<h3>destroy</h3>
248
-					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
249
-						<li class="tsd-signature tsd-kind-icon">destroy<span class="tsd-signature-symbol">(</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>
250
-					</ul>
251
-					<ul class="tsd-descriptions">
252
-						<li class="tsd-description">
253
-							<aside class="tsd-sources">
254
-								<p>Implementation of <a href="../interfaces/_interfaces_.destroyable.html">Destroyable</a>.<a href="../interfaces/_interfaces_.destroyable.html#destroy">destroy</a></p>
255
-								<ul>
256
-									<li>Defined in Backend.ts:80</li>
257
-								</ul>
258
-							</aside>
259
-							<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>
260
-						</li>
261
-					</ul>
262
-				</section>
263
-				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected">
264
-					<a name="initrpcs" class="tsd-anchor"></a>
265
-					<h3><span class="tsd-flag ts-flagProtected">Protected</span> initRPCs</h3>
266
-					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
267
-						<li class="tsd-signature tsd-kind-icon">initRPCs<span class="tsd-signature-symbol">(</span>socket<span class="tsd-signature-symbol">: </span><a href="../interfaces/_interfaces_.socket.html" class="tsd-signature-type">Socket</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
268
-					</ul>
269
-					<ul class="tsd-descriptions">
270
-						<li class="tsd-description">
271
-							<aside class="tsd-sources">
272
-								<ul>
273
-									<li>Defined in Backend.ts:73</li>
274
-								</ul>
275
-							</aside>
276
-							<h4 class="tsd-parameters-title">Parameters</h4>
277
-							<ul class="tsd-parameters">
278
-								<li>
279
-									<h5>socket: <a href="../interfaces/_interfaces_.socket.html" class="tsd-signature-type">Socket</a></h5>
280
-								</li>
281
-							</ul>
282
-							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
283
-						</li>
284
-					</ul>
285
-				</section>
286
-				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">
287
-					<a name="startwebsocket" class="tsd-anchor"></a>
288
-					<h3><span class="tsd-flag ts-flagPrivate">Private</span> start<wbr>Websocket</h3>
289
-					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
290
-						<li class="tsd-signature tsd-kind-icon">start<wbr>Websocket<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
291
-					</ul>
292
-					<ul class="tsd-descriptions">
293
-						<li class="tsd-description">
294
-							<aside class="tsd-sources">
295
-								<ul>
296
-									<li>Defined in Backend.ts:57</li>
297
-								</ul>
298
-							</aside>
299
-							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
300
-						</li>
301
-					</ul>
302
-				</section>
303
-			</section>
304
-		</div>
305
-		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
306
-			<nav class="tsd-navigation primary">
307
-				<ul>
308
-					<li class="globals  ">
309
-						<a href="../index.html"><em>Globals</em></a>
310
-					</li>
311
-					<li class="current tsd-kind-external-module">
312
-						<a href="../modules/_backend_.html">"<wbr>Backend"</a>
313
-					</li>
314
-					<li class=" tsd-kind-external-module">
315
-						<a href="../modules/_frontend_.html">"<wbr>Frontend"</a>
316
-					</li>
317
-					<li class=" tsd-kind-external-module">
318
-						<a href="../modules/_interfaces_.html">"<wbr>Interfaces"</a>
319
-					</li>
320
-					<li class=" tsd-kind-external-module">
321
-						<a href="../modules/_types_.html">"<wbr>Types"</a>
322
-					</li>
323
-					<li class=" tsd-kind-external-module">
324
-						<a href="../modules/_utils_.html">"<wbr>Utils"</a>
325
-					</li>
326
-				</ul>
327
-			</nav>
328
-			<nav class="tsd-navigation secondary menu-sticky">
329
-				<ul class="before-current">
330
-				</ul>
331
-				<ul class="current">
332
-					<li class="current tsd-kind-class tsd-parent-kind-external-module tsd-has-type-parameter">
333
-						<a href="_backend_.rpcserver.html" class="tsd-kind-icon">RPCServer</a>
334
-						<ul>
335
-							<li class=" tsd-kind-constructor tsd-parent-kind-class">
336
-								<a href="_backend_.rpcserver.html#constructor" class="tsd-kind-icon">constructor</a>
337
-							</li>
338
-							<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
339
-								<a href="_backend_.rpcserver.html#closehandler" class="tsd-kind-icon">close<wbr>Handler</a>
340
-							</li>
341
-							<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
342
-								<a href="_backend_.rpcserver.html#connectionhandler" class="tsd-kind-icon">connection<wbr>Handler</a>
343
-							</li>
344
-							<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
345
-								<a href="_backend_.rpcserver.html#errorhandler" class="tsd-kind-icon">error<wbr>Handler</a>
346
-							</li>
347
-							<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
348
-								<a href="_backend_.rpcserver.html#exporters" class="tsd-kind-icon">exporters</a>
349
-							</li>
350
-							<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
351
-								<a href="_backend_.rpcserver.html#io" class="tsd-kind-icon">io</a>
352
-							</li>
353
-							<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
354
-								<a href="_backend_.rpcserver.html#port" class="tsd-kind-icon">port</a>
355
-							</li>
356
-							<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
357
-								<a href="_backend_.rpcserver.html#visibility" class="tsd-kind-icon">visibility</a>
358
-							</li>
359
-							<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
360
-								<a href="_backend_.rpcserver.html#ws" class="tsd-kind-icon">ws</a>
361
-							</li>
362
-							<li class=" tsd-kind-method tsd-parent-kind-class">
363
-								<a href="_backend_.rpcserver.html#destroy" class="tsd-kind-icon">destroy</a>
364
-							</li>
365
-							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
366
-								<a href="_backend_.rpcserver.html#initrpcs" class="tsd-kind-icon">initRPCs</a>
367
-							</li>
368
-							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
369
-								<a href="_backend_.rpcserver.html#startwebsocket" class="tsd-kind-icon">start<wbr>Websocket</a>
370
-							</li>
371
-						</ul>
372
-					</li>
373
-				</ul>
374
-				<ul class="after-current">
375
-				</ul>
376
-			</nav>
377
-		</div>
378
-	</div>
379
-</div>
380
-<footer class="with-border-bottom">
381
-	<div class="container">
382
-		<h2>Legend</h2>
383
-		<div class="tsd-legend-group">
384
-			<ul class="tsd-legend">
385
-				<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
386
-				<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
387
-				<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
388
-				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
389
-				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
390
-				<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
391
-				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
392
-				<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
393
-			</ul>
394
-			<ul class="tsd-legend">
395
-				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
396
-				<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
397
-				<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
398
-				<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
399
-			</ul>
400
-			<ul class="tsd-legend">
401
-				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
402
-				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
403
-				<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
404
-				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
405
-				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
406
-				<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
407
-			</ul>
408
-			<ul class="tsd-legend">
409
-				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
410
-				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
411
-				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
412
-				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
413
-				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
414
-				<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
415
-				<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
416
-			</ul>
417
-			<ul class="tsd-legend">
418
-				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
419
-				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
420
-				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
421
-				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
422
-			</ul>
423
-			<ul class="tsd-legend">
424
-				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
425
-				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
426
-				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
427
-			</ul>
428
-			<ul class="tsd-legend">
429
-				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
430
-				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
431
-				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
432
-			</ul>
433
-			<ul class="tsd-legend">
434
-				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
435
-				<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
436
-			</ul>
437
-		</div>
438
-	</div>
439
-</footer>
440
-<div class="container tsd-generator">
441
-	<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
442
-</div>
443
-<div class="overlay"></div>
444
-<script src="../assets/js/main.js"></script>
445
-<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
446
-</body>
447
-</html>

+ 158
- 0
docs/classes/_backend_.rpcserver.md View File

@@ -0,0 +1,158 @@
1
+[rpclibrary](../README.md) › ["Backend"](../modules/_backend_.md) › [RPCServer](_backend_.rpcserver.md)
2
+
3
+# Class: RPCServer <**SubResType**>
4
+
5
+## Type parameters
6
+
7
+▪ **SubResType**
8
+
9
+## Hierarchy
10
+
11
+* **RPCServer**
12
+
13
+## Implements
14
+
15
+* [Destroyable](../interfaces/_interfaces_.destroyable.md)
16
+
17
+## Index
18
+
19
+### Constructors
20
+
21
+* [constructor](_backend_.rpcserver.md#constructor)
22
+
23
+### Properties
24
+
25
+* [closeHandler](_backend_.rpcserver.md#private-closehandler)
26
+* [connectionHandler](_backend_.rpcserver.md#private-connectionhandler)
27
+* [errorHandler](_backend_.rpcserver.md#private-errorhandler)
28
+* [exporters](_backend_.rpcserver.md#private-exporters)
29
+* [io](_backend_.rpcserver.md#private-io)
30
+* [port](_backend_.rpcserver.md#private-port)
31
+* [visibility](_backend_.rpcserver.md#private-visibility)
32
+* [ws](_backend_.rpcserver.md#private-ws)
33
+
34
+### Methods
35
+
36
+* [destroy](_backend_.rpcserver.md#destroy)
37
+* [initRPCs](_backend_.rpcserver.md#protected-initrpcs)
38
+* [startWebsocket](_backend_.rpcserver.md#private-startwebsocket)
39
+
40
+## Constructors
41
+
42
+###  constructor
43
+
44
+\+ **new RPCServer**(`port`: number, `exporters`: [Exporter](../interfaces/_interfaces_.exporter.md)‹SubResType›[], `conf`: T.SocketConf): *[RPCServer](_backend_.rpcserver.md)*
45
+
46
+Defined in Backend.ts:19
47
+
48
+**Parameters:**
49
+
50
+Name | Type | Default |
51
+------ | ------ | ------ |
52
+`port` | number | - |
53
+`exporters` | [Exporter](../interfaces/_interfaces_.exporter.md)‹SubResType›[] |  [] |
54
+`conf` | T.SocketConf |   {} |
55
+
56
+**Returns:** *[RPCServer](_backend_.rpcserver.md)*
57
+
58
+## Properties
59
+
60
+### `Private` closeHandler
61
+
62
+• **closeHandler**: *T.CloseHandler*
63
+
64
+Defined in Backend.ts:17
65
+
66
+___
67
+
68
+### `Private` connectionHandler
69
+
70
+• **connectionHandler**: *T.ConnectionHandler*
71
+
72
+Defined in Backend.ts:19
73
+
74
+___
75
+
76
+### `Private` errorHandler
77
+
78
+• **errorHandler**: *T.ErrorHandler*
79
+
80
+Defined in Backend.ts:18
81
+
82
+___
83
+
84
+### `Private` exporters
85
+
86
+• **exporters**: *[Exporter](../interfaces/_interfaces_.exporter.md)‹SubResType›[]*
87
+
88
+Defined in Backend.ts:23
89
+
90
+___
91
+
92
+### `Private` io
93
+
94
+• **io**: *any* =  bsock.createServer()
95
+
96
+Defined in Backend.ts:15
97
+
98
+___
99
+
100
+### `Private` port
101
+
102
+• **port**: *number*
103
+
104
+Defined in Backend.ts:22
105
+
106
+___
107
+
108
+### `Private` visibility
109
+
110
+• **visibility**: *T.Visibility*
111
+
112
+Defined in Backend.ts:16
113
+
114
+___
115
+
116
+### `Private` ws
117
+
118
+• **ws**: *Server* =  http.createServer()
119
+
120
+Defined in Backend.ts:14
121
+
122
+## Methods
123
+
124
+###  destroy
125
+
126
+▸ **destroy**(): *Promise‹void›*
127
+
128
+*Implementation of [Destroyable](../interfaces/_interfaces_.destroyable.md)*
129
+
130
+Defined in Backend.ts:80
131
+
132
+**Returns:** *Promise‹void›*
133
+
134
+___
135
+
136
+### `Protected` initRPCs
137
+
138
+▸ **initRPCs**(`socket`: [Socket](../interfaces/_interfaces_.socket.md)): *void*
139
+
140
+Defined in Backend.ts:73
141
+
142
+**Parameters:**
143
+
144
+Name | Type |
145
+------ | ------ |
146
+`socket` | [Socket](../interfaces/_interfaces_.socket.md) |
147
+
148
+**Returns:** *void*
149
+
150
+___
151
+
152
+### `Private` startWebsocket
153
+
154
+▸ **startWebsocket**(): *void*
155
+
156
+Defined in Backend.ts:57
157
+
158
+**Returns:** *void*

+ 0
- 649
docs/classes/_frontend_.rpcsocket.html View File

@@ -1,649 +0,0 @@
1
-<!doctype html>
2
-<html class="default no-js">
3
-<head>
4
-	<meta charset="utf-8">
5
-	<meta http-equiv="X-UA-Compatible" content="IE=edge">
6
-	<title>RPCSocket | rpclibrary</title>
7
-	<meta name="description" content="">
8
-	<meta name="viewport" content="width=device-width, initial-scale=1">
9
-	<link rel="stylesheet" href="../assets/css/main.css">
10
-</head>
11
-<body>
12
-<header>
13
-	<div class="tsd-page-toolbar">
14
-		<div class="container">
15
-			<div class="table-wrap">
16
-				<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
17
-					<div class="field">
18
-						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
19
-						<input id="tsd-search-field" type="text" />
20
-					</div>
21
-					<ul class="results">
22
-						<li class="state loading">Preparing search index...</li>
23
-						<li class="state failure">The search index is not available</li>
24
-					</ul>
25
-					<a href="../index.html" class="title">rpclibrary</a>
26
-				</div>
27
-				<div class="table-cell" id="tsd-widgets">
28
-					<div id="tsd-filter">
29
-						<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
30
-						<div class="tsd-filter-group">
31
-							<div class="tsd-select" id="tsd-filter-visibility">
32
-								<span class="tsd-select-label">All</span>
33
-								<ul class="tsd-select-list">
34
-									<li data-value="public">Public</li>
35
-									<li data-value="protected">Public/Protected</li>
36
-									<li data-value="private" class="selected">All</li>
37
-								</ul>
38
-							</div>
39
-							<input type="checkbox" id="tsd-filter-inherited" checked />
40
-							<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
41
-							<input type="checkbox" id="tsd-filter-externals" checked />
42
-							<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
43
-							<input type="checkbox" id="tsd-filter-only-exported" />
44
-							<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
45
-						</div>
46
-					</div>
47
-					<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
48
-				</div>
49
-			</div>
50
-		</div>
51
-	</div>
52
-	<div class="tsd-page-title">
53
-		<div class="container">
54
-			<ul class="tsd-breadcrumb">
55
-				<li>
56
-					<a href="../index.html">Globals</a>
57
-				</li>
58
-				<li>
59
-					<a href="../modules/_frontend_.html">&quot;Frontend&quot;</a>
60
-				</li>
61
-				<li>
62
-					<a href="_frontend_.rpcsocket.html">RPCSocket</a>
63
-				</li>
64
-			</ul>
65
-			<h1>Class RPCSocket</h1>
66
-		</div>
67
-	</div>
68
-</header>
69
-<div class="container container-main">
70
-	<div class="row">
71
-		<div class="col-8 col-content">
72
-			<section class="tsd-panel tsd-hierarchy">
73
-				<h3>Hierarchy</h3>
74
-				<ul class="tsd-hierarchy">
75
-					<li>
76
-						<span class="target">RPCSocket</span>
77
-					</li>
78
-				</ul>
79
-			</section>
80
-			<section class="tsd-panel">
81
-				<h3>Implements</h3>
82
-				<ul class="tsd-hierarchy">
83
-					<li><a href="../interfaces/_interfaces_.socket.html" class="tsd-signature-type">Socket</a></li>
84
-				</ul>
85
-			</section>
86
-			<section class="tsd-panel-group tsd-index-group">
87
-				<h2>Index</h2>
88
-				<section class="tsd-panel tsd-index-panel">
89
-					<div class="tsd-index-content">
90
-						<section class="tsd-index-section ">
91
-							<h3>Constructors</h3>
92
-							<ul class="tsd-index-list">
93
-								<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="_frontend_.rpcsocket.html#constructor" class="tsd-kind-icon">constructor</a></li>
94
-							</ul>
95
-						</section>
96
-						<section class="tsd-index-section ">
97
-							<h3>Properties</h3>
98
-							<ul class="tsd-index-list">
99
-								<li class="tsd-kind-property tsd-parent-kind-class"><a href="_frontend_.rpcsocket.html#port" class="tsd-kind-icon">port</a></li>
100
-								<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_frontend_.rpcsocket.html#server" class="tsd-kind-icon">server</a></li>
101
-								<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_frontend_.rpcsocket.html#socket" class="tsd-kind-icon">socket</a></li>
102
-								<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_frontend_.rpcsocket.html#tls" class="tsd-kind-icon">tls</a></li>
103
-							</ul>
104
-						</section>
105
-						<section class="tsd-index-section ">
106
-							<h3>Methods</h3>
107
-							<ul class="tsd-index-list">
108
-								<li class="tsd-kind-method tsd-parent-kind-class"><a href="_frontend_.rpcsocket.html#call" class="tsd-kind-icon">call</a></li>
109
-								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_frontend_.rpcsocket.html#callgenerator" class="tsd-kind-icon">call<wbr>Generator</a></li>
110
-								<li class="tsd-kind-method tsd-parent-kind-class"><a href="_frontend_.rpcsocket.html#close" class="tsd-kind-icon">close</a></li>
111
-								<li class="tsd-kind-method tsd-parent-kind-class"><a href="_frontend_.rpcsocket.html#connect" class="tsd-kind-icon">connect</a></li>
112
-								<li class="tsd-kind-method tsd-parent-kind-class"><a href="_frontend_.rpcsocket.html#destroy" class="tsd-kind-icon">destroy</a></li>
113
-								<li class="tsd-kind-method tsd-parent-kind-class"><a href="_frontend_.rpcsocket.html#fire" class="tsd-kind-icon">fire</a></li>
114
-								<li class="tsd-kind-method tsd-parent-kind-class"><a href="_frontend_.rpcsocket.html#hook" class="tsd-kind-icon">hook</a></li>
115
-								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_frontend_.rpcsocket.html#hookgenerator" class="tsd-kind-icon">hook<wbr>Generator</a></li>
116
-								<li class="tsd-kind-method tsd-parent-kind-class"><a href="_frontend_.rpcsocket.html#info" class="tsd-kind-icon">info</a></li>
117
-								<li class="tsd-kind-method tsd-parent-kind-class"><a href="_frontend_.rpcsocket.html#on" class="tsd-kind-icon">on</a></li>
118
-								<li class="tsd-kind-method tsd-parent-kind-class"><a href="_frontend_.rpcsocket.html#unhook" class="tsd-kind-icon">unhook</a></li>
119
-							</ul>
120
-						</section>
121
-					</div>
122
-				</section>
123
-			</section>
124
-			<section class="tsd-panel-group tsd-member-group ">
125
-				<h2>Constructors</h2>
126
-				<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
127
-					<a name="constructor" class="tsd-anchor"></a>
128
-					<h3>constructor</h3>
129
-					<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
130
-						<li class="tsd-signature tsd-kind-icon">new RPCSocket<span class="tsd-signature-symbol">(</span>port<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, server<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, tls<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_frontend_.rpcsocket.html" class="tsd-signature-type">RPCSocket</a></li>
131
-					</ul>
132
-					<ul class="tsd-descriptions">
133
-						<li class="tsd-description">
134
-							<aside class="tsd-sources">
135
-								<ul>
136
-									<li>Defined in Frontend.ts:15</li>
137
-								</ul>
138
-							</aside>
139
-							<h4 class="tsd-parameters-title">Parameters</h4>
140
-							<ul class="tsd-parameters">
141
-								<li>
142
-									<h5>port: <span class="tsd-signature-type">number</span></h5>
143
-								</li>
144
-								<li>
145
-									<h5>server: <span class="tsd-signature-type">string</span></h5>
146
-								</li>
147
-								<li>
148
-									<h5><span class="tsd-flag ts-flagDefault value">Default value</span> tls: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> =&nbsp;false</span></h5>
149
-								</li>
150
-							</ul>
151
-							<h4 class="tsd-returns-title">Returns <a href="_frontend_.rpcsocket.html" class="tsd-signature-type">RPCSocket</a></h4>
152
-						</li>
153
-					</ul>
154
-				</section>
155
-			</section>
156
-			<section class="tsd-panel-group tsd-member-group ">
157
-				<h2>Properties</h2>
158
-				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
159
-					<a name="port" class="tsd-anchor"></a>
160
-					<h3>port</h3>
161
-					<div class="tsd-signature tsd-kind-icon">port<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
162
-					<aside class="tsd-sources">
163
-						<p>Implementation of <a href="../interfaces/_interfaces_.socket.html">Socket</a>.<a href="../interfaces/_interfaces_.socket.html#port">port</a></p>
164
-						<ul>
165
-							<li>Defined in Frontend.ts:16</li>
166
-						</ul>
167
-					</aside>
168
-				</section>
169
-				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
170
-					<a name="server" class="tsd-anchor"></a>
171
-					<h3><span class="tsd-flag ts-flagPrivate">Private</span> server</h3>
172
-					<div class="tsd-signature tsd-kind-icon">server<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
173
-					<aside class="tsd-sources">
174
-						<ul>
175
-							<li>Defined in Frontend.ts:16</li>
176
-						</ul>
177
-					</aside>
178
-				</section>
179
-				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
180
-					<a name="socket" class="tsd-anchor"></a>
181
-					<h3><span class="tsd-flag ts-flagPrivate">Private</span> socket</h3>
182
-					<div class="tsd-signature tsd-kind-icon">socket<span class="tsd-signature-symbol">:</span> <a href="../interfaces/_interfaces_.socket.html" class="tsd-signature-type">Socket</a></div>
183
-					<aside class="tsd-sources">
184
-						<ul>
185
-							<li>Defined in Frontend.ts:15</li>
186
-						</ul>
187
-					</aside>
188
-				</section>
189
-				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
190
-					<a name="tls" class="tsd-anchor"></a>
191
-					<h3><span class="tsd-flag ts-flagPrivate">Private</span> tls</h3>
192
-					<div class="tsd-signature tsd-kind-icon">tls<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
193
-					<aside class="tsd-sources">
194
-						<ul>
195
-							<li>Defined in Frontend.ts:16</li>
196
-						</ul>
197
-					</aside>
198
-				</section>
199
-			</section>
200
-			<section class="tsd-panel-group tsd-member-group ">
201
-				<h2>Methods</h2>
202
-				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
203
-					<a name="call" class="tsd-anchor"></a>
204
-					<h3>call</h3>
205
-					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
206
-						<li class="tsd-signature tsd-kind-icon">call<span class="tsd-signature-symbol">(</span>rpcname<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T.Name</span>, <span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T.Any</span><span class="tsd-signature-symbol">[]</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">T.Any</span><span class="tsd-signature-symbol">&gt;</span></li>
207
-					</ul>
208
-					<ul class="tsd-descriptions">
209
-						<li class="tsd-description">
210
-							<aside class="tsd-sources">
211
-								<ul>
212
-									<li>Defined in Frontend.ts:40</li>
213
-								</ul>
214
-							</aside>
215
-							<h4 class="tsd-parameters-title">Parameters</h4>
216
-							<ul class="tsd-parameters">
217
-								<li>
218
-									<h5>rpcname: <span class="tsd-signature-type">T.Name</span></h5>
219
-								</li>
220
-								<li>
221
-									<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">T.Any</span><span class="tsd-signature-symbol">[]</span></h5>
222
-								</li>
223
-							</ul>
224
-							<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">T.Any</span><span class="tsd-signature-symbol">&gt;</span></h4>
225
-						</li>
226
-					</ul>
227
-				</section>
228
-				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">
229
-					<a name="callgenerator" class="tsd-anchor"></a>
230
-					<h3><span class="tsd-flag ts-flagPrivate">Private</span> call<wbr>Generator</h3>
231
-					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
232
-						<li class="tsd-signature tsd-kind-icon">call<wbr>Generator<span class="tsd-signature-symbol">(</span>fnName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T.Name</span>, fnArgs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T.Arg</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T.AsyncFunction</span></li>
233
-					</ul>
234
-					<ul class="tsd-descriptions">
235
-						<li class="tsd-description">
236
-							<aside class="tsd-sources">
237
-								<ul>
238
-									<li>Defined in Frontend.ts:73</li>
239
-								</ul>
240
-							</aside>
241
-							<h4 class="tsd-parameters-title">Parameters</h4>
242
-							<ul class="tsd-parameters">
243
-								<li>
244
-									<h5>fnName: <span class="tsd-signature-type">T.Name</span></h5>
245
-								</li>
246
-								<li>
247
-									<h5>fnArgs: <span class="tsd-signature-type">T.Arg</span><span class="tsd-signature-symbol">[]</span></h5>
248
-								</li>
249
-							</ul>
250
-							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T.AsyncFunction</span></h4>
251
-						</li>
252
-					</ul>
253
-				</section>
254
-				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
255
-					<a name="close" class="tsd-anchor"></a>
256
-					<h3>close</h3>
257
-					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
258
-						<li class="tsd-signature tsd-kind-icon">close<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
259
-					</ul>
260
-					<ul class="tsd-descriptions">
261
-						<li class="tsd-description">
262
-							<aside class="tsd-sources">
263
-								<p>Implementation of <a href="../interfaces/_interfaces_.socket.html">Socket</a>.<a href="../interfaces/_interfaces_.socket.html#close">close</a></p>
264
-								<ul>
265
-									<li>Defined in Frontend.ts:36</li>
266
-								</ul>
267
-							</aside>
268
-							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
269
-						</li>
270
-					</ul>
271
-				</section>
272
-				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
273
-					<a name="connect" class="tsd-anchor"></a>
274
-					<h3>connect</h3>
275
-					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
276
-						<li class="tsd-signature tsd-kind-icon">connect<span class="tsd-signature-symbol">(</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>
277
-					</ul>
278
-					<ul class="tsd-descriptions">
279
-						<li class="tsd-description">
280
-							<aside class="tsd-sources">
281
-								<ul>
282
-									<li>Defined in Frontend.ts:48</li>
283
-								</ul>
284
-							</aside>
285
-							<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>
286
-						</li>
287
-					</ul>
288
-				</section>
289
-				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
290
-					<a name="destroy" class="tsd-anchor"></a>
291
-					<h3>destroy</h3>
292
-					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
293
-						<li class="tsd-signature tsd-kind-icon">destroy<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
294
-					</ul>
295
-					<ul class="tsd-descriptions">
296
-						<li class="tsd-description">
297
-							<aside class="tsd-sources">
298
-								<p>Implementation of <a href="../interfaces/_interfaces_.socket.html">Socket</a>.<a href="../interfaces/_interfaces_.socket.html#destroy">destroy</a></p>
299
-								<ul>
300
-									<li>Defined in Frontend.ts:32</li>
301
-								</ul>
302
-							</aside>
303
-							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
304
-						</li>
305
-					</ul>
306
-				</section>
307
-				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
308
-					<a name="fire" class="tsd-anchor"></a>
309
-					<h3>fire</h3>
310
-					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
311
-						<li class="tsd-signature tsd-kind-icon">fire<span class="tsd-signature-symbol">(</span>rpcname<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T.Name</span>, <span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T.Any</span><span class="tsd-signature-symbol">[]</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">T.Any</span><span class="tsd-signature-symbol">&gt;</span></li>
312
-					</ul>
313
-					<ul class="tsd-descriptions">
314
-						<li class="tsd-description">
315
-							<aside class="tsd-sources">
316
-								<ul>
317
-									<li>Defined in Frontend.ts:44</li>
318
-								</ul>
319
-							</aside>
320
-							<h4 class="tsd-parameters-title">Parameters</h4>
321
-							<ul class="tsd-parameters">
322
-								<li>
323
-									<h5>rpcname: <span class="tsd-signature-type">T.Name</span></h5>
324
-								</li>
325
-								<li>
326
-									<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">T.Any</span><span class="tsd-signature-symbol">[]</span></h5>
327
-								</li>
328
-							</ul>
329
-							<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">T.Any</span><span class="tsd-signature-symbol">&gt;</span></h4>
330
-						</li>
331
-					</ul>
332
-				</section>
333
-				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
334
-					<a name="hook" class="tsd-anchor"></a>
335
-					<h3>hook</h3>
336
-					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
337
-						<li class="tsd-signature tsd-kind-icon">hook<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T.Name</span>, handler<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_interfaces_.socket.html" class="tsd-signature-type">Socket</a></li>
338
-					</ul>
339
-					<ul class="tsd-descriptions">
340
-						<li class="tsd-description">
341
-							<aside class="tsd-sources">
342
-								<ul>
343
-									<li>Defined in Frontend.ts:20</li>
344
-								</ul>
345
-							</aside>
346
-							<h4 class="tsd-parameters-title">Parameters</h4>
347
-							<ul class="tsd-parameters">
348
-								<li>
349
-									<h5>name: <span class="tsd-signature-type">T.Name</span></h5>
350
-								</li>
351
-								<li>
352
-									<h5>handler: <span class="tsd-signature-type">function</span></h5>
353
-									<ul class="tsd-parameters">
354
-										<li class="tsd-parameter-siganture">
355
-											<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
356
-												<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</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">any</span><span class="tsd-signature-symbol">&gt;</span></li>
357
-											</ul>
358
-											<ul class="tsd-descriptions">
359
-												<li class="tsd-description">
360
-													<h4 class="tsd-parameters-title">Parameters</h4>
361
-													<ul class="tsd-parameters">
362
-														<li>
363
-															<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
364
-														</li>
365
-													</ul>
366
-													<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span>
367
-														<span class="tsd-signature-symbol"> | </span>
368
-														<span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span>
369
-													</h4>
370
-												</li>
371
-											</ul>
372
-										</li>
373
-									</ul>
374
-								</li>
375
-							</ul>
376
-							<h4 class="tsd-returns-title">Returns <a href="../interfaces/_interfaces_.socket.html" class="tsd-signature-type">Socket</a></h4>
377
-						</li>
378
-					</ul>
379
-				</section>
380
-				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">
381
-					<a name="hookgenerator" class="tsd-anchor"></a>
382
-					<h3><span class="tsd-flag ts-flagPrivate">Private</span> hook<wbr>Generator</h3>
383
-					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
384
-						<li class="tsd-signature tsd-kind-icon">hook<wbr>Generator<span class="tsd-signature-symbol">(</span>fnName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T.Name</span>, fnArgs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T.Arg</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T.HookFunction</span></li>
385
-					</ul>
386
-					<ul class="tsd-descriptions">
387
-						<li class="tsd-description">
388
-							<aside class="tsd-sources">
389
-								<ul>
390
-									<li>Defined in Frontend.ts:79</li>
391
-								</ul>
392
-							</aside>
393
-							<h4 class="tsd-parameters-title">Parameters</h4>
394
-							<ul class="tsd-parameters">
395
-								<li>
396
-									<h5>fnName: <span class="tsd-signature-type">T.Name</span></h5>
397
-								</li>
398
-								<li>
399
-									<h5>fnArgs: <span class="tsd-signature-type">T.Arg</span><span class="tsd-signature-symbol">[]</span></h5>
400
-								</li>
401
-							</ul>
402
-							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T.HookFunction</span></h4>
403
-						</li>
404
-					</ul>
405
-				</section>
406
-				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
407
-					<a name="info" class="tsd-anchor"></a>
408
-					<h3>info</h3>
409
-					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
410
-						<li class="tsd-signature tsd-kind-icon">info<span class="tsd-signature-symbol">(</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">any</span><span class="tsd-signature-symbol">&gt;</span></li>
411
-					</ul>
412
-					<ul class="tsd-descriptions">
413
-						<li class="tsd-description">
414
-							<aside class="tsd-sources">
415
-								<ul>
416
-									<li>Defined in Frontend.ts:69</li>
417
-								</ul>
418
-							</aside>
419
-							<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">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
420
-						</li>
421
-					</ul>
422
-				</section>
423
-				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
424
-					<a name="on" class="tsd-anchor"></a>
425
-					<h3>on</h3>
426
-					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
427
-						<li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"error"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"close"</span>, f<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_interfaces_.socket.html" class="tsd-signature-type">Socket</a></li>
428
-					</ul>
429
-					<ul class="tsd-descriptions">
430
-						<li class="tsd-description">
431
-							<aside class="tsd-sources">
432
-								<ul>
433
-									<li>Defined in Frontend.ts:28</li>
434
-								</ul>
435
-							</aside>
436
-							<h4 class="tsd-parameters-title">Parameters</h4>
437
-							<ul class="tsd-parameters">
438
-								<li>
439
-									<h5>type: <span class="tsd-signature-type">"error"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"close"</span></h5>
440
-								</li>
441
-								<li>
442
-									<h5>f: <span class="tsd-signature-type">function</span></h5>
443
-									<ul class="tsd-parameters">
444
-										<li class="tsd-parameter-siganture">
445
-											<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
446
-												<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
447
-											</ul>
448
-											<ul class="tsd-descriptions">
449
-												<li class="tsd-description">
450
-													<h4 class="tsd-parameters-title">Parameters</h4>
451
-													<ul class="tsd-parameters">
452
-														<li>
453
-															<h5><span class="tsd-flag ts-flagOptional">Optional</span> e: <span class="tsd-signature-type">any</span></h5>
454
-														</li>
455
-													</ul>
456
-													<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
457
-												</li>
458
-											</ul>
459
-										</li>
460
-									</ul>
461
-								</li>
462
-							</ul>
463
-							<h4 class="tsd-returns-title">Returns <a href="../interfaces/_interfaces_.socket.html" class="tsd-signature-type">Socket</a></h4>
464
-						</li>
465
-					</ul>
466
-				</section>
467
-				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
468
-					<a name="unhook" class="tsd-anchor"></a>
469
-					<h3>unhook</h3>
470
-					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
471
-						<li class="tsd-signature tsd-kind-icon">unhook<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T.Name</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_interfaces_.socket.html" class="tsd-signature-type">Socket</a></li>
472
-					</ul>
473
-					<ul class="tsd-descriptions">
474
-						<li class="tsd-description">
475
-							<aside class="tsd-sources">
476
-								<ul>
477
-									<li>Defined in Frontend.ts:24</li>
478
-								</ul>
479
-							</aside>
480
-							<h4 class="tsd-parameters-title">Parameters</h4>
481
-							<ul class="tsd-parameters">
482
-								<li>
483
-									<h5>name: <span class="tsd-signature-type">T.Name</span></h5>
484
-								</li>
485
-							</ul>
486
-							<h4 class="tsd-returns-title">Returns <a href="../interfaces/_interfaces_.socket.html" class="tsd-signature-type">Socket</a></h4>
487
-						</li>
488
-					</ul>
489
-				</section>
490
-			</section>
491
-		</div>
492
-		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
493
-			<nav class="tsd-navigation primary">
494
-				<ul>
495
-					<li class="globals  ">
496
-						<a href="../index.html"><em>Globals</em></a>
497
-					</li>
498
-					<li class=" tsd-kind-external-module">
499
-						<a href="../modules/_backend_.html">"<wbr>Backend"</a>
500
-					</li>
501
-					<li class="current tsd-kind-external-module">
502
-						<a href="../modules/_frontend_.html">"<wbr>Frontend"</a>
503
-					</li>
504
-					<li class=" tsd-kind-external-module">
505
-						<a href="../modules/_interfaces_.html">"<wbr>Interfaces"</a>
506
-					</li>
507
-					<li class=" tsd-kind-external-module">
508
-						<a href="../modules/_types_.html">"<wbr>Types"</a>
509
-					</li>
510
-					<li class=" tsd-kind-external-module">
511
-						<a href="../modules/_utils_.html">"<wbr>Utils"</a>
512
-					</li>
513
-				</ul>
514
-			</nav>
515
-			<nav class="tsd-navigation secondary menu-sticky">
516
-				<ul class="before-current">
517
-				</ul>
518
-				<ul class="current">
519
-					<li class="current tsd-kind-class tsd-parent-kind-external-module">
520
-						<a href="_frontend_.rpcsocket.html" class="tsd-kind-icon">RPCSocket</a>
521
-						<ul>
522
-							<li class=" tsd-kind-constructor tsd-parent-kind-class">
523
-								<a href="_frontend_.rpcsocket.html#constructor" class="tsd-kind-icon">constructor</a>
524
-							</li>
525
-							<li class=" tsd-kind-property tsd-parent-kind-class">
526
-								<a href="_frontend_.rpcsocket.html#port" class="tsd-kind-icon">port</a>
527
-							</li>
528
-							<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
529
-								<a href="_frontend_.rpcsocket.html#server" class="tsd-kind-icon">server</a>
530
-							</li>
531
-							<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
532
-								<a href="_frontend_.rpcsocket.html#socket" class="tsd-kind-icon">socket</a>
533
-							</li>
534
-							<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
535
-								<a href="_frontend_.rpcsocket.html#tls" class="tsd-kind-icon">tls</a>
536
-							</li>
537
-							<li class=" tsd-kind-method tsd-parent-kind-class">
538
-								<a href="_frontend_.rpcsocket.html#call" class="tsd-kind-icon">call</a>
539
-							</li>
540
-							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
541
-								<a href="_frontend_.rpcsocket.html#callgenerator" class="tsd-kind-icon">call<wbr>Generator</a>
542
-							</li>
543
-							<li class=" tsd-kind-method tsd-parent-kind-class">
544
-								<a href="_frontend_.rpcsocket.html#close" class="tsd-kind-icon">close</a>
545
-							</li>
546
-							<li class=" tsd-kind-method tsd-parent-kind-class">
547
-								<a href="_frontend_.rpcsocket.html#connect" class="tsd-kind-icon">connect</a>
548
-							</li>
549
-							<li class=" tsd-kind-method tsd-parent-kind-class">
550
-								<a href="_frontend_.rpcsocket.html#destroy" class="tsd-kind-icon">destroy</a>
551
-							</li>
552
-							<li class=" tsd-kind-method tsd-parent-kind-class">
553
-								<a href="_frontend_.rpcsocket.html#fire" class="tsd-kind-icon">fire</a>
554
-							</li>
555
-							<li class=" tsd-kind-method tsd-parent-kind-class">
556
-								<a href="_frontend_.rpcsocket.html#hook" class="tsd-kind-icon">hook</a>
557
-							</li>
558
-							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
559
-								<a href="_frontend_.rpcsocket.html#hookgenerator" class="tsd-kind-icon">hook<wbr>Generator</a>
560
-							</li>
561
-							<li class=" tsd-kind-method tsd-parent-kind-class">
562
-								<a href="_frontend_.rpcsocket.html#info" class="tsd-kind-icon">info</a>
563
-							</li>
564
-							<li class=" tsd-kind-method tsd-parent-kind-class">
565
-								<a href="_frontend_.rpcsocket.html#on" class="tsd-kind-icon">on</a>
566
-							</li>
567
-							<li class=" tsd-kind-method tsd-parent-kind-class">
568
-								<a href="_frontend_.rpcsocket.html#unhook" class="tsd-kind-icon">unhook</a>
569
-							</li>
570
-						</ul>
571
-					</li>
572
-				</ul>
573
-				<ul class="after-current">
574
-					<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
575
-						<a href="../modules/_frontend_.html#stripafterequals" class="tsd-kind-icon">strip<wbr>After<wbr>Equals</a>
576
-					</li>
577
-				</ul>
578
-			</nav>
579
-		</div>
580
-	</div>
581
-</div>
582
-<footer class="with-border-bottom">
583
-	<div class="container">
584
-		<h2>Legend</h2>
585
-		<div class="tsd-legend-group">
586
-			<ul class="tsd-legend">
587
-				<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
588
-				<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
589
-				<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
590
-				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
591
-				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
592
-				<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
593
-				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
594
-				<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
595
-			</ul>
596
-			<ul class="tsd-legend">
597
-				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
598
-				<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
599
-				<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
600
-				<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
601
-			</ul>
602
-			<ul class="tsd-legend">
603
-				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
604
-				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
605
-				<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
606
-				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
607
-				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
608
-				<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
609
-			</ul>
610
-			<ul class="tsd-legend">
611
-				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
612
-				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
613
-				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
614
-				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
615
-				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
616
-				<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
617
-				<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
618
-			</ul>
619
-			<ul class="tsd-legend">
620
-				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
621
-				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
622
-				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
623
-				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
624
-			</ul>
625
-			<ul class="tsd-legend">
626
-				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
627
-				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
628
-				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
629
-			</ul>
630
-			<ul class="tsd-legend">
631
-				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
632
-				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
633
-				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
634
-			</ul>
635
-			<ul class="tsd-legend">
636
-				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
637
-				<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
638
-			</ul>
639
-		</div>
640
-	</div>
641
-</footer>
642
-<div class="container tsd-generator">
643
-	<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
644
-</div>
645
-<div class="overlay"></div>
646
-<script src="../assets/js/main.js"></script>
647
-<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
648
-</body>
649
-</html>

+ 266
- 0
docs/classes/_frontend_.rpcsocket.md View File

@@ -0,0 +1,266 @@
1
+[rpclibrary](../README.md) › ["Frontend"](../modules/_frontend_.md) › [RPCSocket](_frontend_.rpcsocket.md)
2
+
3
+# Class: RPCSocket
4
+
5
+## Hierarchy
6
+
7
+* **RPCSocket**
8
+
9
+## Implements
10
+
11
+* [Socket](../interfaces/_interfaces_.socket.md)
12
+
13
+## Index
14
+
15
+### Constructors
16
+
17
+* [constructor](_frontend_.rpcsocket.md#constructor)
18
+
19
+### Properties
20
+
21
+* [port](_frontend_.rpcsocket.md#port)
22
+* [server](_frontend_.rpcsocket.md#private-server)
23
+* [socket](_frontend_.rpcsocket.md#private-socket)
24
+* [tls](_frontend_.rpcsocket.md#private-tls)
25
+
26
+### Methods
27
+
28
+* [call](_frontend_.rpcsocket.md#call)
29
+* [callGenerator](_frontend_.rpcsocket.md#private-callgenerator)
30
+* [close](_frontend_.rpcsocket.md#close)
31
+* [connect](_frontend_.rpcsocket.md#connect)
32
+* [destroy](_frontend_.rpcsocket.md#destroy)
33
+* [fire](_frontend_.rpcsocket.md#fire)
34
+* [hook](_frontend_.rpcsocket.md#hook)
35
+* [hookGenerator](_frontend_.rpcsocket.md#private-hookgenerator)
36
+* [info](_frontend_.rpcsocket.md#info)
37
+* [on](_frontend_.rpcsocket.md#on)
38
+* [unhook](_frontend_.rpcsocket.md#unhook)
39
+
40
+## Constructors
41
+
42
+###  constructor
43
+
44
+\+ **new RPCSocket**(`port`: number, `server`: string, `tls`: boolean): *[RPCSocket](_frontend_.rpcsocket.md)*
45
+
46
+Defined in Frontend.ts:15
47
+
48
+**Parameters:**
49
+
50
+Name | Type | Default |
51
+------ | ------ | ------ |
52
+`port` | number | - |
53
+`server` | string | - |
54
+`tls` | boolean | false |
55
+
56
+**Returns:** *[RPCSocket](_frontend_.rpcsocket.md)*
57
+
58
+## Properties
59
+
60
+###  port
61
+
62
+• **port**: *number*
63
+
64
+*Implementation of [Socket](../interfaces/_interfaces_.socket.md).[port](../interfaces/_interfaces_.socket.md#port)*
65
+
66
+Defined in Frontend.ts:16
67
+
68
+___
69
+
70
+### `Private` server
71
+
72
+• **server**: *string*
73
+
74
+Defined in Frontend.ts:16
75
+
76
+___
77
+
78
+### `Private` socket
79
+
80
+• **socket**: *[Socket](../interfaces/_interfaces_.socket.md)*
81
+
82
+Defined in Frontend.ts:15
83
+
84
+___
85
+
86
+### `Private` tls
87
+
88
+• **tls**: *boolean*
89
+
90
+Defined in Frontend.ts:16
91
+
92
+## Methods
93
+
94
+###  call
95
+
96
+▸ **call**(`rpcname`: T.Name, ...`args`: T.Any[]): *Promise‹T.Any›*
97
+
98
+Defined in Frontend.ts:40
99
+
100
+**Parameters:**
101
+
102
+Name | Type |
103
+------ | ------ |
104
+`rpcname` | T.Name |
105
+`...args` | T.Any[] |
106
+
107
+**Returns:** *Promise‹T.Any›*
108
+
109
+___
110
+
111
+### `Private` callGenerator
112
+
113
+▸ **callGenerator**(`fnName`: T.Name, `fnArgs`: T.Arg[]): *T.AsyncFunction*
114
+
115
+Defined in Frontend.ts:73
116
+
117
+**Parameters:**
118
+
119
+Name | Type |
120
+------ | ------ |
121
+`fnName` | T.Name |
122
+`fnArgs` | T.Arg[] |
123
+
124
+**Returns:** *T.AsyncFunction*
125
+
126
+___
127
+
128
+###  close
129
+
130
+▸ **close**(): *void*
131
+
132
+*Implementation of [Socket](../interfaces/_interfaces_.socket.md)*
133
+
134
+Defined in Frontend.ts:36
135
+
136
+**Returns:** *void*
137
+
138
+___
139
+
140
+###  connect
141
+
142
+▸ **connect**(): *Promise‹void›*
143
+
144
+Defined in Frontend.ts:48
145
+
146
+**Returns:** *Promise‹void›*
147
+
148
+___
149
+
150
+###  destroy
151
+
152
+▸ **destroy**(): *void*
153
+
154
+*Implementation of [Socket](../interfaces/_interfaces_.socket.md)*
155
+
156
+Defined in Frontend.ts:32
157
+
158
+**Returns:** *void*
159
+
160
+___
161
+
162
+###  fire
163
+
164
+▸ **fire**(`rpcname`: T.Name, ...`args`: T.Any[]): *Promise‹T.Any›*
165
+
166
+Defined in Frontend.ts:44
167
+
168
+**Parameters:**
169
+
170
+Name | Type |
171
+------ | ------ |
172
+`rpcname` | T.Name |
173
+`...args` | T.Any[] |
174
+
175
+**Returns:** *Promise‹T.Any›*
176
+
177
+___
178
+
179
+###  hook
180
+
181
+▸ **hook**(`name`: T.Name, `handler`: function): *[Socket](../interfaces/_interfaces_.socket.md)*
182
+
183
+Defined in Frontend.ts:20
184
+
185
+**Parameters:**
186
+
187
+▪ **name**: *T.Name*
188
+
189
+▪ **handler**: *function*
190
+
191
+▸ (...`args`: any[]): *any | Promise‹any›*
192
+
193
+**Parameters:**
194
+
195
+Name | Type |
196
+------ | ------ |
197
+`...args` | any[] |
198
+
199
+**Returns:** *[Socket](../interfaces/_interfaces_.socket.md)*
200
+
201
+___
202
+
203
+### `Private` hookGenerator
204
+
205
+▸ **hookGenerator**(`fnName`: T.Name, `fnArgs`: T.Arg[]): *T.HookFunction*
206
+
207
+Defined in Frontend.ts:79
208
+
209
+**Parameters:**
210
+
211
+Name | Type |
212
+------ | ------ |
213
+`fnName` | T.Name |
214
+`fnArgs` | T.Arg[] |
215
+
216
+**Returns:** *T.HookFunction*
217
+
218
+___
219
+
220
+###  info
221
+
222
+▸ **info**(): *Promise‹any›*
223
+
224
+Defined in Frontend.ts:69
225
+
226
+**Returns:** *Promise‹any›*
227
+
228
+___
229
+
230
+###  on
231
+
232
+▸ **on**(`type`: "error" | "close", `f`: function): *[Socket](../interfaces/_interfaces_.socket.md)*
233
+
234
+Defined in Frontend.ts:28
235
+
236
+**Parameters:**
237
+
238
+▪ **type**: *"error" | "close"*
239
+
240
+▪ **f**: *function*
241
+
242
+▸ (`e?`: any): *void*
243
+
244
+**Parameters:**
245
+
246
+Name | Type |
247
+------ | ------ |
248
+`e?` | any |
249
+
250
+**Returns:** *[Socket](../interfaces/_interfaces_.socket.md)*
251
+
252
+___
253
+
254
+###  unhook
255
+
256
+▸ **unhook**(`name`: T.Name): *[Socket](../interfaces/_interfaces_.socket.md)*
257
+
258
+Defined in Frontend.ts:24
259
+
260
+**Parameters:**
261
+
262
+Name | Type |
263
+------ | ------ |
264
+`name` | T.Name |
265
+
266
+**Returns:** *[Socket](../interfaces/_interfaces_.socket.md)*

+ 0
- 181
docs/index.html View File

@@ -1,181 +0,0 @@
1
-<!doctype html>
2
-<html class="default no-js">
3
-<head>
4
-	<meta charset="utf-8">
5
-	<meta http-equiv="X-UA-Compatible" content="IE=edge">
6
-	<title>rpclibrary</title>
7
-	<meta name="description" content="">
8
-	<meta name="viewport" content="width=device-width, initial-scale=1">
9
-	<link rel="stylesheet" href="assets/css/main.css">
10
-</head>
11
-<body>
12
-<header>
13
-	<div class="tsd-page-toolbar">
14
-		<div class="container">
15
-			<div class="table-wrap">
16
-				<div class="table-cell" id="tsd-search" data-index="assets/js/search.js" data-base=".">
17
-					<div class="field">
18
-						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
19
-						<input id="tsd-search-field" type="text" />
20
-					</div>
21
-					<ul class="results">
22
-						<li class="state loading">Preparing search index...</li>
23
-						<li class="state failure">The search index is not available</li>
24
-					</ul>
25
-					<a href="index.html" class="title">rpclibrary</a>
26
-				</div>
27
-				<div class="table-cell" id="tsd-widgets">
28
-					<div id="tsd-filter">
29
-						<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
30
-						<div class="tsd-filter-group">
31
-							<div class="tsd-select" id="tsd-filter-visibility">
32
-								<span class="tsd-select-label">All</span>
33
-								<ul class="tsd-select-list">
34
-									<li data-value="public">Public</li>
35
-									<li data-value="protected">Public/Protected</li>
36
-									<li data-value="private" class="selected">All</li>
37
-								</ul>
38
-							</div>
39
-							<input type="checkbox" id="tsd-filter-inherited" checked />
40
-							<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
41
-							<input type="checkbox" id="tsd-filter-externals" checked />
42
-							<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
43
-							<input type="checkbox" id="tsd-filter-only-exported" />
44
-							<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
45
-						</div>
46
-					</div>
47
-					<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
48
-				</div>
49
-			</div>
50
-		</div>
51
-	</div>
52
-	<div class="tsd-page-title">
53
-		<div class="container">
54
-			<ul class="tsd-breadcrumb">
55
-				<li>
56
-					<a href="index.html">Globals</a>
57
-				</li>
58
-			</ul>
59
-			<h1> rpclibrary</h1>
60
-		</div>
61
-	</div>
62
-</header>
63
-<div class="container container-main">
64
-	<div class="row">
65
-		<div class="col-8 col-content">
66
-			<section class="tsd-panel-group tsd-index-group">
67
-				<h2>Index</h2>
68
-				<section class="tsd-panel tsd-index-panel">
69
-					<div class="tsd-index-content">
70
-						<section class="tsd-index-section ">
71
-							<h3>External modules</h3>
72
-							<ul class="tsd-index-list">
73
-								<li class="tsd-kind-external-module"><a href="modules/_backend_.html" class="tsd-kind-icon">"<wbr>Backend"</a></li>
74
-								<li class="tsd-kind-external-module"><a href="modules/_frontend_.html" class="tsd-kind-icon">"<wbr>Frontend"</a></li>
75
-								<li class="tsd-kind-external-module"><a href="modules/_interfaces_.html" class="tsd-kind-icon">"<wbr>Interfaces"</a></li>
76
-								<li class="tsd-kind-external-module"><a href="modules/_types_.html" class="tsd-kind-icon">"<wbr>Types"</a></li>
77
-								<li class="tsd-kind-external-module"><a href="modules/_utils_.html" class="tsd-kind-icon">"<wbr>Utils"</a></li>
78
-							</ul>
79
-						</section>
80
-					</div>
81
-				</section>
82
-			</section>
83
-		</div>
84
-		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
85
-			<nav class="tsd-navigation primary">
86
-				<ul>
87
-					<li class="globals current ">
88
-						<a href="index.html"><em>Globals</em></a>
89
-					</li>
90
-					<li class=" tsd-kind-external-module">
91
-						<a href="modules/_backend_.html">"<wbr>Backend"</a>
92
-					</li>
93
-					<li class=" tsd-kind-external-module">
94
-						<a href="modules/_frontend_.html">"<wbr>Frontend"</a>
95
-					</li>
96
-					<li class=" tsd-kind-external-module">
97
-						<a href="modules/_interfaces_.html">"<wbr>Interfaces"</a>
98
-					</li>
99
-					<li class=" tsd-kind-external-module">
100
-						<a href="modules/_types_.html">"<wbr>Types"</a>
101
-					</li>
102
-					<li class=" tsd-kind-external-module">
103
-						<a href="modules/_utils_.html">"<wbr>Utils"</a>
104
-					</li>
105
-				</ul>
106
-			</nav>
107
-			<nav class="tsd-navigation secondary menu-sticky">
108
-				<ul class="before-current">
109
-				</ul>
110
-			</nav>
111
-		</div>
112
-	</div>
113
-</div>
114
-<footer class="with-border-bottom">
115
-	<div class="container">
116
-		<h2>Legend</h2>
117
-		<div class="tsd-legend-group">
118
-			<ul class="tsd-legend">
119
-				<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
120
-				<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
121
-				<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
122
-				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
123
-				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
124
-				<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
125
-				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
126
-				<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
127
-			</ul>
128
-			<ul class="tsd-legend">
129
-				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
130
-				<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
131
-				<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
132
-				<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
133
-			</ul>
134
-			<ul class="tsd-legend">
135
-				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
136
-				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
137
-				<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
138
-				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
139
-				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
140
-				<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
141
-			</ul>
142
-			<ul class="tsd-legend">
143
-				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
144
-				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
145
-				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
146
-				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
147
-				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
148
-				<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
149
-				<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
150
-			</ul>
151
-			<ul class="tsd-legend">
152
-				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
153
-				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
154
-				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
155
-				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
156
-			</ul>
157
-			<ul class="tsd-legend">
158
-				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
159
-				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
160
-				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
161
-			</ul>
162
-			<ul class="tsd-legend">
163
-				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
164
-				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
165
-				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
166
-			</ul>
167
-			<ul class="tsd-legend">
168
-				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
169
-				<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
170
-			</ul>
171
-		</div>
172
-	</div>
173
-</footer>
174
-<div class="container tsd-generator">
175
-	<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
176
-</div>
177
-<div class="overlay"></div>
178
-<script src="assets/js/main.js"></script>
179
-<script>if (location.protocol == 'file:') document.write('<script src="assets/js/search.js"><' + '/script>');</script>
180
-</body>
181
-</html>

+ 0
- 240
docs/interfaces/_interfaces_.destroyable.html View File

@@ -1,240 +0,0 @@
1
-<!doctype html>
2
-<html class="default no-js">
3
-<head>
4
-	<meta charset="utf-8">
5
-	<meta http-equiv="X-UA-Compatible" content="IE=edge">
6
-	<title>Destroyable | rpclibrary</title>
7
-	<meta name="description" content="">
8
-	<meta name="viewport" content="width=device-width, initial-scale=1">
9
-	<link rel="stylesheet" href="../assets/css/main.css">
10
-</head>
11
-<body>
12
-<header>
13
-	<div class="tsd-page-toolbar">
14
-		<div class="container">
15
-			<div class="table-wrap">
16
-				<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
17
-					<div class="field">
18
-						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
19
-						<input id="tsd-search-field" type="text" />
20
-					</div>
21
-					<ul class="results">
22
-						<li class="state loading">Preparing search index...</li>
23
-						<li class="state failure">The search index is not available</li>
24
-					</ul>
25
-					<a href="../index.html" class="title">rpclibrary</a>
26
-				</div>
27
-				<div class="table-cell" id="tsd-widgets">
28
-					<div id="tsd-filter">
29
-						<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
30
-						<div class="tsd-filter-group">
31
-							<div class="tsd-select" id="tsd-filter-visibility">
32
-								<span class="tsd-select-label">All</span>
33
-								<ul class="tsd-select-list">
34
-									<li data-value="public">Public</li>
35
-									<li data-value="protected">Public/Protected</li>
36
-									<li data-value="private" class="selected">All</li>
37
-								</ul>
38
-							</div>
39
-							<input type="checkbox" id="tsd-filter-inherited" checked />
40
-							<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
41
-							<input type="checkbox" id="tsd-filter-externals" checked />
42
-							<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
43
-							<input type="checkbox" id="tsd-filter-only-exported" />
44
-							<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
45
-						</div>
46
-					</div>
47
-					<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
48
-				</div>
49
-			</div>
50
-		</div>
51
-	</div>
52
-	<div class="tsd-page-title">
53
-		<div class="container">
54
-			<ul class="tsd-breadcrumb">
55
-				<li>
56
-					<a href="../index.html">Globals</a>
57
-				</li>
58
-				<li>
59
-					<a href="../modules/_interfaces_.html">&quot;Interfaces&quot;</a>
60
-				</li>
61
-				<li>
62
-					<a href="_interfaces_.destroyable.html">Destroyable</a>
63
-				</li>
64
-			</ul>
65
-			<h1>Interface Destroyable</h1>
66
-		</div>
67
-	</div>
68
-</header>
69
-<div class="container container-main">
70
-	<div class="row">
71
-		<div class="col-8 col-content">
72
-			<section class="tsd-panel tsd-hierarchy">
73
-				<h3>Hierarchy</h3>
74
-				<ul class="tsd-hierarchy">
75
-					<li>
76
-						<span class="target">Destroyable</span>
77
-						<ul class="tsd-hierarchy">
78
-							<li>
79
-								<a href="_interfaces_.socket.html" class="tsd-signature-type">Socket</a>
80
-							</li>
81
-						</ul>
82
-					</li>
83
-				</ul>
84
-			</section>
85
-			<section class="tsd-panel">
86
-				<h3>Implemented by</h3>
87
-				<ul class="tsd-hierarchy">
88
-					<li><a href="../classes/_backend_.rpcserver.html" class="tsd-signature-type">RPCServer</a></li>
89
-				</ul>
90
-			</section>
91
-			<section class="tsd-panel-group tsd-index-group">
92
-				<h2>Index</h2>
93
-				<section class="tsd-panel tsd-index-panel">
94
-					<div class="tsd-index-content">
95
-						<section class="tsd-index-section ">
96
-							<h3>Methods</h3>
97
-							<ul class="tsd-index-list">
98
-								<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_interfaces_.destroyable.html#destroy" class="tsd-kind-icon">destroy</a></li>
99
-							</ul>
100
-						</section>
101
-					</div>
102
-				</section>
103
-			</section>
104
-			<section class="tsd-panel-group tsd-member-group ">
105
-				<h2>Methods</h2>
106
-				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
107
-					<a name="destroy" class="tsd-anchor"></a>
108
-					<h3>destroy</h3>
109
-					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
110
-						<li class="tsd-signature tsd-kind-icon">destroy<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
111
-					</ul>
112
-					<ul class="tsd-descriptions">
113
-						<li class="tsd-description">
114
-							<aside class="tsd-sources">
115
-								<ul>
116
-									<li>Defined in Interfaces.ts:20</li>
117
-								</ul>
118
-							</aside>
119
-							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
120
-						</li>
121
-					</ul>
122
-				</section>
123
-			</section>
124
-		</div>
125
-		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
126
-			<nav class="tsd-navigation primary">
127
-				<ul>
128
-					<li class="globals  ">
129
-						<a href="../index.html"><em>Globals</em></a>
130
-					</li>
131
-					<li class=" tsd-kind-external-module">
132
-						<a href="../modules/_backend_.html">"<wbr>Backend"</a>
133
-					</li>
134
-					<li class=" tsd-kind-external-module">
135
-						<a href="../modules/_frontend_.html">"<wbr>Frontend"</a>
136
-					</li>
137
-					<li class="current tsd-kind-external-module">
138
-						<a href="../modules/_interfaces_.html">"<wbr>Interfaces"</a>
139
-					</li>
140
-					<li class=" tsd-kind-external-module">
141
-						<a href="../modules/_types_.html">"<wbr>Types"</a>
142
-					</li>
143
-					<li class=" tsd-kind-external-module">
144
-						<a href="../modules/_utils_.html">"<wbr>Utils"</a>
145
-					</li>
146
-				</ul>
147
-			</nav>
148
-			<nav class="tsd-navigation secondary menu-sticky">
149
-				<ul class="before-current">
150
-				</ul>
151
-				<ul class="current">
152
-					<li class="current tsd-kind-interface tsd-parent-kind-external-module">
153
-						<a href="_interfaces_.destroyable.html" class="tsd-kind-icon">Destroyable</a>
154
-						<ul>
155
-							<li class=" tsd-kind-method tsd-parent-kind-interface">
156
-								<a href="_interfaces_.destroyable.html#destroy" class="tsd-kind-icon">destroy</a>
157
-							</li>
158
-						</ul>
159
-					</li>
160
-				</ul>
161
-				<ul class="after-current">
162
-					<li class=" tsd-kind-interface tsd-parent-kind-external-module tsd-has-type-parameter">
163
-						<a href="_interfaces_.exporter.html" class="tsd-kind-icon">Exporter</a>
164
-					</li>
165
-					<li class=" tsd-kind-interface tsd-parent-kind-external-module">
166
-						<a href="_interfaces_.socket.html" class="tsd-kind-icon">Socket</a>
167
-					</li>
168
-				</ul>
169
-			</nav>
170
-		</div>
171
-	</div>
172
-</div>
173
-<footer class="with-border-bottom">
174
-	<div class="container">
175
-		<h2>Legend</h2>
176
-		<div class="tsd-legend-group">
177
-			<ul class="tsd-legend">
178
-				<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
179
-				<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
180
-				<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
181
-				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
182
-				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
183
-				<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
184
-				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
185
-				<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
186
-			</ul>
187
-			<ul class="tsd-legend">
188
-				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
189
-				<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
190
-				<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
191
-				<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
192
-			</ul>
193
-			<ul class="tsd-legend">
194
-				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
195
-				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
196
-				<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
197
-				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
198
-				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
199
-				<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
200
-			</ul>
201
-			<ul class="tsd-legend">
202
-				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
203
-				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
204
-				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
205
-				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
206
-				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
207
-				<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
208
-				<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
209
-			</ul>
210
-			<ul class="tsd-legend">
211
-				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
212
-				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
213
-				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
214
-				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
215
-			</ul>
216
-			<ul class="tsd-legend">
217
-				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
218
-				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
219
-				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
220
-			</ul>
221
-			<ul class="tsd-legend">
222
-				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
223
-				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
224
-				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
225
-			</ul>
226
-			<ul class="tsd-legend">
227
-				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
228
-				<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
229
-			</ul>
230
-		</div>
231
-	</div>
232
-</footer>
233
-<div class="container tsd-generator">
234
-	<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
235
-</div>
236
-<div class="overlay"></div>
237
-<script src="../assets/js/main.js"></script>
238
-<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
239
-</body>
240
-</html>

+ 29
- 0
docs/interfaces/_interfaces_.destroyable.md View File

@@ -0,0 +1,29 @@
1
+[rpclibrary](../README.md) › ["Interfaces"](../modules/_interfaces_.md) › [Destroyable](_interfaces_.destroyable.md)
2
+
3
+# Interface: Destroyable
4
+
5
+## Hierarchy
6
+
7
+* **Destroyable**
8
+
9
+  ↳ [Socket](_interfaces_.socket.md)
10
+
11
+## Implemented by
12
+
13
+* [RPCServer](../classes/_backend_.rpcserver.md)
14
+
15
+## Index
16
+
17
+### Methods
18
+
19
+* [destroy](_interfaces_.destroyable.md#destroy)
20
+
21
+## Methods
22
+
23
+###  destroy
24
+
25
+▸ **destroy**(): *void*
26
+
27
+Defined in Interfaces.ts:20
28
+
29
+**Returns:** *void*

+ 0
- 259
docs/interfaces/_interfaces_.exporter.html View File

@@ -1,259 +0,0 @@
1
-<!doctype html>
2
-<html class="default no-js">
3
-<head>
4
-	<meta charset="utf-8">
5
-	<meta http-equiv="X-UA-Compatible" content="IE=edge">
6
-	<title>Exporter | rpclibrary</title>
7
-	<meta name="description" content="">
8
-	<meta name="viewport" content="width=device-width, initial-scale=1">
9
-	<link rel="stylesheet" href="../assets/css/main.css">
10
-</head>
11
-<body>
12
-<header>
13
-	<div class="tsd-page-toolbar">
14
-		<div class="container">
15
-			<div class="table-wrap">
16
-				<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
17
-					<div class="field">
18
-						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
19
-						<input id="tsd-search-field" type="text" />
20
-					</div>
21
-					<ul class="results">
22
-						<li class="state loading">Preparing search index...</li>
23
-						<li class="state failure">The search index is not available</li>
24
-					</ul>
25
-					<a href="../index.html" class="title">rpclibrary</a>
26
-				</div>
27
-				<div class="table-cell" id="tsd-widgets">
28
-					<div id="tsd-filter">
29
-						<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
30
-						<div class="tsd-filter-group">
31
-							<div class="tsd-select" id="tsd-filter-visibility">
32
-								<span class="tsd-select-label">All</span>
33
-								<ul class="tsd-select-list">
34
-									<li data-value="public">Public</li>
35
-									<li data-value="protected">Public/Protected</li>
36
-									<li data-value="private" class="selected">All</li>
37
-								</ul>
38
-							</div>
39
-							<input type="checkbox" id="tsd-filter-inherited" checked />
40
-							<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
41
-							<input type="checkbox" id="tsd-filter-externals" checked />
42
-							<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
43
-							<input type="checkbox" id="tsd-filter-only-exported" />
44
-							<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
45
-						</div>
46
-					</div>
47
-					<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
48
-				</div>
49
-			</div>
50
-		</div>
51
-	</div>
52
-	<div class="tsd-page-title">
53
-		<div class="container">
54
-			<ul class="tsd-breadcrumb">
55
-				<li>
56
-					<a href="../index.html">Globals</a>
57
-				</li>
58
-				<li>
59
-					<a href="../modules/_interfaces_.html">&quot;Interfaces&quot;</a>
60
-				</li>
61
-				<li>
62
-					<a href="_interfaces_.exporter.html">Exporter</a>
63
-				</li>
64
-			</ul>
65
-			<h1>Interface Exporter&lt;T&gt;</h1>
66
-		</div>
67
-	</div>
68
-</header>
69
-<div class="container container-main">
70
-	<div class="row">
71
-		<div class="col-8 col-content">
72
-			<section class="tsd-panel tsd-type-parameters">
73
-				<h3>Type parameters</h3>
74
-				<ul class="tsd-type-parameters">
75
-					<li>
76
-						<h4>T</h4>
77
-					</li>
78
-				</ul>
79
-			</section>
80
-			<section class="tsd-panel tsd-hierarchy">
81
-				<h3>Hierarchy</h3>
82
-				<ul class="tsd-hierarchy">
83
-					<li>
84
-						<span class="target">Exporter</span>
85
-					</li>
86
-				</ul>
87
-			</section>
88
-			<section class="tsd-panel-group tsd-index-group">
89
-				<h2>Index</h2>
90
-				<section class="tsd-panel tsd-index-panel">
91
-					<div class="tsd-index-content">
92
-						<section class="tsd-index-section ">
93
-							<h3>Properties</h3>
94
-							<ul class="tsd-index-list">
95
-								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_interfaces_.exporter.html#name" class="tsd-kind-icon">name</a></li>
96
-							</ul>
97
-						</section>
98
-						<section class="tsd-index-section ">
99
-							<h3>Methods</h3>
100
-							<ul class="tsd-index-list">
101
-								<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_interfaces_.exporter.html#exportrpcs" class="tsd-kind-icon">exportRPCs</a></li>
102
-							</ul>
103
-						</section>
104
-					</div>
105
-				</section>
106
-			</section>
107
-			<section class="tsd-panel-group tsd-member-group ">
108
-				<h2>Properties</h2>
109
-				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
110
-					<a name="name" class="tsd-anchor"></a>
111
-					<h3>name</h3>
112
-					<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">T.Name</span></div>
113
-					<aside class="tsd-sources">
114
-						<ul>
115
-							<li>Defined in Interfaces.ts:5</li>
116
-						</ul>
117
-					</aside>
118
-				</section>
119
-			</section>
120
-			<section class="tsd-panel-group tsd-member-group ">
121
-				<h2>Methods</h2>
122
-				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
123
-					<a name="exportrpcs" class="tsd-anchor"></a>
124
-					<h3>exportRPCs</h3>
125
-					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
126
-						<li class="tsd-signature tsd-kind-icon">exportRPCs<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T.RPC</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span></li>
127
-					</ul>
128
-					<ul class="tsd-descriptions">
129
-						<li class="tsd-description">
130
-							<aside class="tsd-sources">
131
-								<ul>
132
-									<li>Defined in Interfaces.ts:6</li>
133
-								</ul>
134
-							</aside>
135
-							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T.RPC</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span></h4>
136
-						</li>
137
-					</ul>
138
-				</section>
139
-			</section>
140
-		</div>
141
-		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
142
-			<nav class="tsd-navigation primary">
143
-				<ul>
144
-					<li class="globals  ">
145
-						<a href="../index.html"><em>Globals</em></a>
146
-					</li>
147
-					<li class=" tsd-kind-external-module">
148
-						<a href="../modules/_backend_.html">"<wbr>Backend"</a>
149
-					</li>
150
-					<li class=" tsd-kind-external-module">
151
-						<a href="../modules/_frontend_.html">"<wbr>Frontend"</a>
152
-					</li>
153
-					<li class="current tsd-kind-external-module">
154
-						<a href="../modules/_interfaces_.html">"<wbr>Interfaces"</a>
155
-					</li>
156
-					<li class=" tsd-kind-external-module">
157
-						<a href="../modules/_types_.html">"<wbr>Types"</a>
158
-					</li>
159
-					<li class=" tsd-kind-external-module">
160
-						<a href="../modules/_utils_.html">"<wbr>Utils"</a>
161
-					</li>
162
-				</ul>
163
-			</nav>
164
-			<nav class="tsd-navigation secondary menu-sticky">
165
-				<ul class="before-current">
166
-					<li class=" tsd-kind-interface tsd-parent-kind-external-module">
167
-						<a href="_interfaces_.destroyable.html" class="tsd-kind-icon">Destroyable</a>
168
-					</li>
169
-				</ul>
170
-				<ul class="current">
171
-					<li class="current tsd-kind-interface tsd-parent-kind-external-module tsd-has-type-parameter">
172
-						<a href="_interfaces_.exporter.html" class="tsd-kind-icon">Exporter</a>
173
-						<ul>
174
-							<li class=" tsd-kind-property tsd-parent-kind-interface">
175
-								<a href="_interfaces_.exporter.html#name" class="tsd-kind-icon">name</a>
176
-							</li>
177
-							<li class=" tsd-kind-method tsd-parent-kind-interface">
178
-								<a href="_interfaces_.exporter.html#exportrpcs" class="tsd-kind-icon">exportRPCs</a>
179
-							</li>
180
-						</ul>
181
-					</li>
182
-				</ul>
183
-				<ul class="after-current">
184
-					<li class=" tsd-kind-interface tsd-parent-kind-external-module">
185
-						<a href="_interfaces_.socket.html" class="tsd-kind-icon">Socket</a>
186
-					</li>
187
-				</ul>
188
-			</nav>
189
-		</div>
190
-	</div>
191
-</div>
192
-<footer class="with-border-bottom">
193
-	<div class="container">
194
-		<h2>Legend</h2>
195
-		<div class="tsd-legend-group">
196
-			<ul class="tsd-legend">
197
-				<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
198
-				<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
199
-				<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
200
-				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
201
-				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
202
-				<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
203
-				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
204
-				<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
205
-			</ul>
206
-			<ul class="tsd-legend">
207
-				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
208
-				<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
209
-				<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
210
-				<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
211
-			</ul>
212
-			<ul class="tsd-legend">
213
-				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
214
-				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
215
-				<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
216
-				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
217
-				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
218
-				<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
219
-			</ul>
220
-			<ul class="tsd-legend">
221
-				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
222
-				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
223
-				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
224
-				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
225
-				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
226
-				<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
227
-				<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
228
-			</ul>
229
-			<ul class="tsd-legend">
230
-				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
231
-				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
232
-				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
233
-				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
234
-			</ul>
235
-			<ul class="tsd-legend">
236
-				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
237
-				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
238
-				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
239
-			</ul>
240
-			<ul class="tsd-legend">
241
-				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
242
-				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
243
-				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
244
-			</ul>
245
-			<ul class="tsd-legend">
246
-				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
247
-				<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
248
-			</ul>
249
-		</div>
250
-	</div>
251
-</footer>
252
-<div class="container tsd-generator">
253
-	<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
254
-</div>
255
-<div class="overlay"></div>
256
-<script src="../assets/js/main.js"></script>
257
-<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
258
-</body>
259
-</html>

+ 39
- 0
docs/interfaces/_interfaces_.exporter.md View File

@@ -0,0 +1,39 @@
1
+[rpclibrary](../README.md) › ["Interfaces"](../modules/_interfaces_.md) › [Exporter](_interfaces_.exporter.md)
2
+
3
+# Interface: Exporter <**T**>
4
+
5
+## Type parameters
6
+
7
+▪ **T**
8
+
9
+## Hierarchy
10
+
11
+* **Exporter**
12
+
13
+## Index
14
+
15
+### Properties
16
+
17
+* [name](_interfaces_.exporter.md#name)
18
+
19
+### Methods
20
+
21
+* [exportRPCs](_interfaces_.exporter.md#exportrpcs)
22
+
23
+## Properties
24
+
25
+###  name
26
+
27
+• **name**: *T.Name*
28
+
29
+Defined in Interfaces.ts:5
30
+
31
+## Methods
32
+
33
+###  exportRPCs
34
+
35
+▸ **exportRPCs**(): *T.RPC‹T›[]*
36
+
37
+Defined in Interfaces.ts:6
38
+
39
+**Returns:** *T.RPC‹T›[]*

+ 0
- 468
docs/interfaces/_interfaces_.socket.html View File

@@ -1,468 +0,0 @@
1
-<!doctype html>
2
-<html class="default no-js">
3
-<head>
4
-	<meta charset="utf-8">
5
-	<meta http-equiv="X-UA-Compatible" content="IE=edge">
6
-	<title>Socket | rpclibrary</title>
7
-	<meta name="description" content="">
8
-	<meta name="viewport" content="width=device-width, initial-scale=1">
9
-	<link rel="stylesheet" href="../assets/css/main.css">
10
-</head>
11
-<body>
12
-<header>
13
-	<div class="tsd-page-toolbar">
14
-		<div class="container">
15
-			<div class="table-wrap">
16
-				<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
17
-					<div class="field">
18
-						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
19
-						<input id="tsd-search-field" type="text" />
20
-					</div>
21
-					<ul class="results">
22
-						<li class="state loading">Preparing search index...</li>
23
-						<li class="state failure">The search index is not available</li>
24
-					</ul>
25
-					<a href="../index.html" class="title">rpclibrary</a>
26
-				</div>
27
-				<div class="table-cell" id="tsd-widgets">
28
-					<div id="tsd-filter">
29
-						<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
30
-						<div class="tsd-filter-group">
31
-							<div class="tsd-select" id="tsd-filter-visibility">
32
-								<span class="tsd-select-label">All</span>
33
-								<ul class="tsd-select-list">
34
-									<li data-value="public">Public</li>
35
-									<li data-value="protected">Public/Protected</li>
36
-									<li data-value="private" class="selected">All</li>
37
-								</ul>
38
-							</div>
39
-							<input type="checkbox" id="tsd-filter-inherited" checked />
40
-							<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
41
-							<input type="checkbox" id="tsd-filter-externals" checked />
42
-							<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
43
-							<input type="checkbox" id="tsd-filter-only-exported" />
44
-							<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
45
-						</div>
46
-					</div>
47
-					<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
48
-				</div>
49
-			</div>
50
-		</div>
51
-	</div>
52
-	<div class="tsd-page-title">
53
-		<div class="container">
54
-			<ul class="tsd-breadcrumb">
55
-				<li>
56
-					<a href="../index.html">Globals</a>
57
-				</li>
58
-				<li>
59
-					<a href="../modules/_interfaces_.html">&quot;Interfaces&quot;</a>
60
-				</li>
61
-				<li>
62
-					<a href="_interfaces_.socket.html">Socket</a>
63
-				</li>
64
-			</ul>
65
-			<h1>Interface Socket</h1>
66
-		</div>
67
-	</div>
68
-</header>
69
-<div class="container container-main">
70
-	<div class="row">
71
-		<div class="col-8 col-content">
72
-			<section class="tsd-panel tsd-hierarchy">
73
-				<h3>Hierarchy</h3>
74
-				<ul class="tsd-hierarchy">
75
-					<li>
76
-						<a href="_interfaces_.destroyable.html" class="tsd-signature-type">Destroyable</a>
77
-						<ul class="tsd-hierarchy">
78
-							<li>
79
-								<span class="target">Socket</span>
80
-							</li>
81
-						</ul>
82
-					</li>
83
-				</ul>
84
-			</section>
85
-			<section class="tsd-panel">
86
-				<h3>Implemented by</h3>
87
-				<ul class="tsd-hierarchy">
88
-					<li><a href="../classes/_frontend_.rpcsocket.html" class="tsd-signature-type">RPCSocket</a></li>
89
-				</ul>
90
-			</section>
91
-			<section class="tsd-panel-group tsd-index-group">
92
-				<h2>Index</h2>
93
-				<section class="tsd-panel tsd-index-panel">
94
-					<div class="tsd-index-content">
95
-						<section class="tsd-index-section ">
96
-							<h3>Properties</h3>
97
-							<ul class="tsd-index-list">
98
-								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_interfaces_.socket.html#call" class="tsd-kind-icon">call</a></li>
99
-								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_interfaces_.socket.html#fire" class="tsd-kind-icon">fire</a></li>
100
-								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_interfaces_.socket.html#hook" class="tsd-kind-icon">hook</a></li>
101
-								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_interfaces_.socket.html#on" class="tsd-kind-icon">on</a></li>
102
-								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_interfaces_.socket.html#port" class="tsd-kind-icon">port</a></li>
103
-								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_interfaces_.socket.html#unhook" class="tsd-kind-icon">unhook</a></li>
104
-							</ul>
105
-						</section>
106
-						<section class="tsd-index-section ">
107
-							<h3>Methods</h3>
108
-							<ul class="tsd-index-list">
109
-								<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_interfaces_.socket.html#close" class="tsd-kind-icon">close</a></li>
110
-								<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="_interfaces_.socket.html#destroy" class="tsd-kind-icon">destroy</a></li>
111
-							</ul>
112
-						</section>
113
-					</div>
114
-				</section>
115
-			</section>
116
-			<section class="tsd-panel-group tsd-member-group ">
117
-				<h2>Properties</h2>
118
-				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
119
-					<a name="call" class="tsd-anchor"></a>
120
-					<h3>call</h3>
121
-					<div class="tsd-signature tsd-kind-icon">call<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
122
-					<aside class="tsd-sources">
123
-						<ul>
124
-							<li>Defined in Interfaces.ts:13</li>
125
-						</ul>
126
-					</aside>
127
-					<div class="tsd-type-declaration">
128
-						<h4>Type declaration</h4>
129
-						<ul class="tsd-parameters">
130
-							<li class="tsd-parameter-siganture">
131
-								<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported">
132
-									<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>rpcname<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T.Name</span>, <span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T.Any</span><span class="tsd-signature-symbol">[]</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">T.Any</span><span class="tsd-signature-symbol">&gt;</span></li>
133
-								</ul>
134
-								<ul class="tsd-descriptions">
135
-									<li class="tsd-description">
136
-										<h4 class="tsd-parameters-title">Parameters</h4>
137
-										<ul class="tsd-parameters">
138
-											<li>
139
-												<h5>rpcname: <span class="tsd-signature-type">T.Name</span></h5>
140
-											</li>
141
-											<li>
142
-												<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">T.Any</span><span class="tsd-signature-symbol">[]</span></h5>
143
-											</li>
144
-										</ul>
145
-										<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">T.Any</span><span class="tsd-signature-symbol">&gt;</span></h4>
146
-									</li>
147
-								</ul>
148
-							</li>
149
-						</ul>
150
-					</div>
151
-				</section>
152
-				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
153
-					<a name="fire" class="tsd-anchor"></a>
154
-					<h3>fire</h3>
155
-					<div class="tsd-signature tsd-kind-icon">fire<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
156
-					<aside class="tsd-sources">
157
-						<ul>
158
-							<li>Defined in Interfaces.ts:14</li>
159
-						</ul>
160
-					</aside>
161
-					<div class="tsd-type-declaration">
162
-						<h4>Type declaration</h4>
163
-						<ul class="tsd-parameters">
164
-							<li class="tsd-parameter-siganture">
165
-								<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported">
166
-									<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>rpcname<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T.Name</span>, <span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T.Any</span><span class="tsd-signature-symbol">[]</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">T.Any</span><span class="tsd-signature-symbol">&gt;</span></li>
167
-								</ul>
168
-								<ul class="tsd-descriptions">
169
-									<li class="tsd-description">
170
-										<h4 class="tsd-parameters-title">Parameters</h4>
171
-										<ul class="tsd-parameters">
172
-											<li>
173
-												<h5>rpcname: <span class="tsd-signature-type">T.Name</span></h5>
174
-											</li>
175
-											<li>
176
-												<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">T.Any</span><span class="tsd-signature-symbol">[]</span></h5>
177
-											</li>
178
-										</ul>
179
-										<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">T.Any</span><span class="tsd-signature-symbol">&gt;</span></h4>
180
-									</li>
181
-								</ul>
182
-							</li>
183
-						</ul>
184
-					</div>
185
-				</section>
186
-				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
187
-					<a name="hook" class="tsd-anchor"></a>
188
-					<h3>hook</h3>
189
-					<div class="tsd-signature tsd-kind-icon">hook<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
190
-					<aside class="tsd-sources">
191
-						<ul>
192
-							<li>Defined in Interfaces.ts:11</li>
193
-						</ul>
194
-					</aside>
195
-					<div class="tsd-type-declaration">
196
-						<h4>Type declaration</h4>
197
-						<ul class="tsd-parameters">
198
-							<li class="tsd-parameter-siganture">
199
-								<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported">
200
-									<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>rpcname<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T.Name</span>, handler<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_interfaces_.socket.html" class="tsd-signature-type">Socket</a></li>
201
-								</ul>
202
-								<ul class="tsd-descriptions">
203
-									<li class="tsd-description">
204
-										<h4 class="tsd-parameters-title">Parameters</h4>
205
-										<ul class="tsd-parameters">
206
-											<li>
207
-												<h5>rpcname: <span class="tsd-signature-type">T.Name</span></h5>
208
-											</li>
209
-											<li>
210
-												<h5>handler: <span class="tsd-signature-type">function</span></h5>
211
-												<ul class="tsd-parameters">
212
-													<li class="tsd-parameter-siganture">
213
-														<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
214
-															<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</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">any</span><span class="tsd-signature-symbol">&gt;</span></li>
215
-														</ul>
216
-														<ul class="tsd-descriptions">
217
-															<li class="tsd-description">
218
-																<h4 class="tsd-parameters-title">Parameters</h4>
219
-																<ul class="tsd-parameters">
220
-																	<li>
221
-																		<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
222
-																	</li>
223
-																</ul>
224
-																<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span>
225
-																	<span class="tsd-signature-symbol"> | </span>
226
-																	<span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span>
227
-																</h4>
228
-															</li>
229
-														</ul>
230
-													</li>
231
-												</ul>
232
-											</li>
233
-										</ul>
234
-										<h4 class="tsd-returns-title">Returns <a href="_interfaces_.socket.html" class="tsd-signature-type">Socket</a></h4>
235
-									</li>
236
-								</ul>
237
-							</li>
238
-						</ul>
239
-					</div>
240
-				</section>
241
-				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
242
-					<a name="on" class="tsd-anchor"></a>
243
-					<h3>on</h3>
244
-					<div class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">T.OnFunction</span></div>
245
-					<aside class="tsd-sources">
246
-						<ul>
247
-							<li>Defined in Interfaces.ts:15</li>
248
-						</ul>
249
-					</aside>
250
-				</section>
251
-				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
252
-					<a name="port" class="tsd-anchor"></a>
253
-					<h3>port</h3>
254
-					<div class="tsd-signature tsd-kind-icon">port<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
255
-					<aside class="tsd-sources">
256
-						<ul>
257
-							<li>Defined in Interfaces.ts:10</li>
258
-						</ul>
259
-					</aside>
260
-				</section>
261
-				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
262
-					<a name="unhook" class="tsd-anchor"></a>
263
-					<h3>unhook</h3>
264
-					<div class="tsd-signature tsd-kind-icon">unhook<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
265
-					<aside class="tsd-sources">
266
-						<ul>
267
-							<li>Defined in Interfaces.ts:12</li>
268
-						</ul>
269
-					</aside>
270
-					<div class="tsd-type-declaration">
271
-						<h4>Type declaration</h4>
272
-						<ul class="tsd-parameters">
273
-							<li class="tsd-parameter-siganture">
274
-								<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported">
275
-									<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>rpcname<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T.Name</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_interfaces_.socket.html" class="tsd-signature-type">Socket</a></li>
276
-								</ul>
277
-								<ul class="tsd-descriptions">
278
-									<li class="tsd-description">
279
-										<h4 class="tsd-parameters-title">Parameters</h4>
280
-										<ul class="tsd-parameters">
281
-											<li>
282
-												<h5>rpcname: <span class="tsd-signature-type">T.Name</span></h5>
283
-											</li>
284
-										</ul>
285
-										<h4 class="tsd-returns-title">Returns <a href="_interfaces_.socket.html" class="tsd-signature-type">Socket</a></h4>
286
-									</li>
287
-								</ul>
288
-							</li>
289
-						</ul>
290
-					</div>
291
-				</section>
292
-			</section>
293
-			<section class="tsd-panel-group tsd-member-group ">
294
-				<h2>Methods</h2>
295
-				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
296
-					<a name="close" class="tsd-anchor"></a>
297
-					<h3>close</h3>
298
-					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
299
-						<li class="tsd-signature tsd-kind-icon">close<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
300
-					</ul>
301
-					<ul class="tsd-descriptions">
302
-						<li class="tsd-description">
303
-							<aside class="tsd-sources">
304
-								<ul>
305
-									<li>Defined in Interfaces.ts:16</li>
306
-								</ul>
307
-							</aside>
308
-							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
309
-						</li>
310
-					</ul>
311
-				</section>
312
-				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
313
-					<a name="destroy" class="tsd-anchor"></a>
314
-					<h3>destroy</h3>
315
-					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
316
-						<li class="tsd-signature tsd-kind-icon">destroy<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
317
-					</ul>
318
-					<ul class="tsd-descriptions">
319
-						<li class="tsd-description">
320
-							<aside class="tsd-sources">
321
-								<p>Inherited from <a href="_interfaces_.destroyable.html">Destroyable</a>.<a href="_interfaces_.destroyable.html#destroy">destroy</a></p>
322
-								<ul>
323
-									<li>Defined in Interfaces.ts:20</li>
324
-								</ul>
325
-							</aside>
326
-							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
327
-						</li>
328
-					</ul>
329
-				</section>
330
-			</section>
331
-		</div>
332
-		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
333
-			<nav class="tsd-navigation primary">
334
-				<ul>
335
-					<li class="globals  ">
336
-						<a href="../index.html"><em>Globals</em></a>
337
-					</li>
338
-					<li class=" tsd-kind-external-module">
339
-						<a href="../modules/_backend_.html">"<wbr>Backend"</a>
340
-					</li>
341
-					<li class=" tsd-kind-external-module">
342
-						<a href="../modules/_frontend_.html">"<wbr>Frontend"</a>
343
-					</li>
344
-					<li class="current tsd-kind-external-module">
345
-						<a href="../modules/_interfaces_.html">"<wbr>Interfaces"</a>
346
-					</li>
347
-					<li class=" tsd-kind-external-module">
348
-						<a href="../modules/_types_.html">"<wbr>Types"</a>
349
-					</li>
350
-					<li class=" tsd-kind-external-module">
351
-						<a href="../modules/_utils_.html">"<wbr>Utils"</a>
352
-					</li>
353
-				</ul>
354
-			</nav>
355
-			<nav class="tsd-navigation secondary menu-sticky">
356
-				<ul class="before-current">
357
-					<li class=" tsd-kind-interface tsd-parent-kind-external-module">
358
-						<a href="_interfaces_.destroyable.html" class="tsd-kind-icon">Destroyable</a>
359
-					</li>
360
-					<li class=" tsd-kind-interface tsd-parent-kind-external-module tsd-has-type-parameter">
361
-						<a href="_interfaces_.exporter.html" class="tsd-kind-icon">Exporter</a>
362
-					</li>
363
-				</ul>
364
-				<ul class="current">
365
-					<li class="current tsd-kind-interface tsd-parent-kind-external-module">
366
-						<a href="_interfaces_.socket.html" class="tsd-kind-icon">Socket</a>
367
-						<ul>
368
-							<li class=" tsd-kind-property tsd-parent-kind-interface">
369
-								<a href="_interfaces_.socket.html#call" class="tsd-kind-icon">call</a>
370
-							</li>
371
-							<li class=" tsd-kind-property tsd-parent-kind-interface">
372
-								<a href="_interfaces_.socket.html#fire" class="tsd-kind-icon">fire</a>
373
-							</li>
374
-							<li class=" tsd-kind-property tsd-parent-kind-interface">
375
-								<a href="_interfaces_.socket.html#hook" class="tsd-kind-icon">hook</a>
376
-							</li>
377
-							<li class=" tsd-kind-property tsd-parent-kind-interface">
378
-								<a href="_interfaces_.socket.html#on" class="tsd-kind-icon">on</a>
379
-							</li>
380
-							<li class=" tsd-kind-property tsd-parent-kind-interface">
381
-								<a href="_interfaces_.socket.html#port" class="tsd-kind-icon">port</a>
382
-							</li>
383
-							<li class=" tsd-kind-property tsd-parent-kind-interface">
384
-								<a href="_interfaces_.socket.html#unhook" class="tsd-kind-icon">unhook</a>
385
-							</li>
386
-							<li class=" tsd-kind-method tsd-parent-kind-interface">
387
-								<a href="_interfaces_.socket.html#close" class="tsd-kind-icon">close</a>
388
-							</li>
389
-							<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
390
-								<a href="_interfaces_.socket.html#destroy" class="tsd-kind-icon">destroy</a>
391
-							</li>
392
-						</ul>
393
-					</li>
394
-				</ul>
395
-				<ul class="after-current">
396
-				</ul>
397
-			</nav>
398
-		</div>
399
-	</div>
400
-</div>
401
-<footer class="with-border-bottom">
402
-	<div class="container">
403
-		<h2>Legend</h2>
404
-		<div class="tsd-legend-group">
405
-			<ul class="tsd-legend">
406
-				<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
407
-				<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
408
-				<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
409
-				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
410
-				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
411
-				<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
412
-				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
413
-				<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
414
-			</ul>
415
-			<ul class="tsd-legend">
416
-				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
417
-				<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
418
-				<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
419
-				<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
420
-			</ul>
421
-			<ul class="tsd-legend">
422
-				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
423
-				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
424
-				<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
425
-				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
426
-				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
427
-				<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
428
-			</ul>
429
-			<ul class="tsd-legend">
430
-				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
431
-				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
432
-				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
433
-				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
434
-				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
435
-				<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
436
-				<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
437
-			</ul>
438
-			<ul class="tsd-legend">
439
-				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
440
-				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
441
-				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
442
-				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
443
-			</ul>
444
-			<ul class="tsd-legend">
445
-				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
446
-				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
447
-				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
448
-			</ul>
449
-			<ul class="tsd-legend">
450
-				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
451
-				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
452
-				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
453
-			</ul>
454
-			<ul class="tsd-legend">
455
-				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
456
-				<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
457
-			</ul>
458
-		</div>
459
-	</div>
460
-</footer>
461
-<div class="container tsd-generator">
462
-	<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
463
-</div>
464
-<div class="overlay"></div>
465
-<script src="../assets/js/main.js"></script>
466
-<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
467
-</body>
468
-</html>

+ 149
- 0
docs/interfaces/_interfaces_.socket.md View File

@@ -0,0 +1,149 @@
1
+[rpclibrary](../README.md) › ["Interfaces"](../modules/_interfaces_.md) › [Socket](_interfaces_.socket.md)
2
+
3
+# Interface: Socket
4
+
5
+## Hierarchy
6
+
7
+* [Destroyable](_interfaces_.destroyable.md)
8
+
9
+  ↳ **Socket**
10
+
11
+## Implemented by
12
+
13
+* [RPCSocket](../classes/_frontend_.rpcsocket.md)
14
+
15
+## Index
16
+
17
+### Properties
18
+
19
+* [call](_interfaces_.socket.md#call)
20
+* [fire](_interfaces_.socket.md#fire)
21
+* [hook](_interfaces_.socket.md#hook)
22
+* [on](_interfaces_.socket.md#on)
23
+* [port](_interfaces_.socket.md#port)
24
+* [unhook](_interfaces_.socket.md#unhook)
25
+
26
+### Methods
27
+
28
+* [close](_interfaces_.socket.md#close)
29
+* [destroy](_interfaces_.socket.md#destroy)
30
+
31
+## Properties
32
+
33
+###  call
34
+
35
+• **call**: *function*
36
+
37
+Defined in Interfaces.ts:13
38
+
39
+#### Type declaration:
40
+
41
+▸ (`rpcname`: T.Name, ...`args`: T.Any[]): *Promise‹T.Any›*
42
+
43
+**Parameters:**
44
+
45
+Name | Type |
46
+------ | ------ |
47
+`rpcname` | T.Name |
48
+`...args` | T.Any[] |
49
+
50
+___
51
+
52
+###  fire
53
+
54
+• **fire**: *function*
55
+
56
+Defined in Interfaces.ts:14
57
+
58
+#### Type declaration:
59
+
60
+▸ (`rpcname`: T.Name, ...`args`: T.Any[]): *Promise‹T.Any›*
61
+
62
+**Parameters:**
63
+
64
+Name | Type |
65
+------ | ------ |
66
+`rpcname` | T.Name |
67
+`...args` | T.Any[] |
68
+
69
+___
70
+
71
+###  hook
72
+
73
+• **hook**: *function*
74
+
75
+Defined in Interfaces.ts:11
76
+
77
+#### Type declaration:
78
+
79
+▸ (`rpcname`: T.Name, `handler`: function): *[Socket](_interfaces_.socket.md)*
80
+
81
+**Parameters:**
82
+
83
+▪ **rpcname**: *T.Name*
84
+
85
+▪ **handler**: *function*
86
+
87
+▸ (...`args`: any[]): *any | Promise‹any›*
88
+
89
+**Parameters:**
90
+
91
+Name | Type |
92
+------ | ------ |
93
+`...args` | any[] |
94
+
95
+___
96
+
97
+###  on
98
+
99
+• **on**: *T.OnFunction*
100
+
101
+Defined in Interfaces.ts:15
102
+
103
+___
104
+
105
+###  port
106
+
107
+• **port**: *number*
108
+
109
+Defined in Interfaces.ts:10
110
+
111
+___
112
+
113
+###  unhook
114
+
115
+• **unhook**: *function*
116
+
117
+Defined in Interfaces.ts:12
118
+
119
+#### Type declaration:
120
+
121
+▸ (`rpcname`: T.Name): *[Socket](_interfaces_.socket.md)*
122
+
123
+**Parameters:**
124
+
125
+Name | Type |
126
+------ | ------ |
127
+`rpcname` | T.Name |
128
+
129
+## Methods
130
+
131
+###  close
132
+
133
+▸ **close**(): *void*
134
+
135
+Defined in Interfaces.ts:16
136
+
137
+**Returns:** *void*
138
+
139
+___
140
+
141
+###  destroy
142
+
143
+▸ **destroy**(): *void*
144
+
145
+*Inherited from [Destroyable](_interfaces_.destroyable.md).[destroy](_interfaces_.destroyable.md#destroy)*
146
+
147
+Defined in Interfaces.ts:20
148
+
149
+**Returns:** *void*

+ 0
- 183
docs/modules/_backend_.html View File

@@ -1,183 +0,0 @@
1
-<!doctype html>
2
-<html class="default no-js">
3
-<head>
4
-	<meta charset="utf-8">
5
-	<meta http-equiv="X-UA-Compatible" content="IE=edge">
6
-	<title>&quot;Backend&quot; | rpclibrary</title>
7
-	<meta name="description" content="">
8
-	<meta name="viewport" content="width=device-width, initial-scale=1">
9
-	<link rel="stylesheet" href="../assets/css/main.css">
10
-</head>
11
-<body>
12
-<header>
13
-	<div class="tsd-page-toolbar">
14
-		<div class="container">
15
-			<div class="table-wrap">
16
-				<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
17
-					<div class="field">
18
-						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
19
-						<input id="tsd-search-field" type="text" />
20
-					</div>
21
-					<ul class="results">
22
-						<li class="state loading">Preparing search index...</li>
23
-						<li class="state failure">The search index is not available</li>
24
-					</ul>
25
-					<a href="../index.html" class="title">rpclibrary</a>
26
-				</div>
27
-				<div class="table-cell" id="tsd-widgets">
28
-					<div id="tsd-filter">
29
-						<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
30
-						<div class="tsd-filter-group">
31
-							<div class="tsd-select" id="tsd-filter-visibility">
32
-								<span class="tsd-select-label">All</span>
33
-								<ul class="tsd-select-list">
34
-									<li data-value="public">Public</li>
35
-									<li data-value="protected">Public/Protected</li>
36
-									<li data-value="private" class="selected">All</li>
37
-								</ul>
38
-							</div>
39
-							<input type="checkbox" id="tsd-filter-inherited" checked />
40
-							<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
41
-							<input type="checkbox" id="tsd-filter-externals" checked />
42
-							<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
43
-							<input type="checkbox" id="tsd-filter-only-exported" />
44
-							<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
45
-						</div>
46
-					</div>
47
-					<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
48
-				</div>
49
-			</div>
50
-		</div>
51
-	</div>
52
-	<div class="tsd-page-title">
53
-		<div class="container">
54
-			<ul class="tsd-breadcrumb">
55
-				<li>
56
-					<a href="../index.html">Globals</a>
57
-				</li>
58
-				<li>
59
-					<a href="_backend_.html">&quot;Backend&quot;</a>
60
-				</li>
61
-			</ul>
62
-			<h1>External module &quot;Backend&quot;</h1>
63
-		</div>
64
-	</div>
65
-</header>
66
-<div class="container container-main">
67
-	<div class="row">
68
-		<div class="col-8 col-content">
69
-			<section class="tsd-panel-group tsd-index-group">
70
-				<h2>Index</h2>
71
-				<section class="tsd-panel tsd-index-panel">
72
-					<div class="tsd-index-content">
73
-						<section class="tsd-index-section ">
74
-							<h3>Classes</h3>
75
-							<ul class="tsd-index-list">
76
-								<li class="tsd-kind-class tsd-parent-kind-external-module tsd-has-type-parameter"><a href="../classes/_backend_.rpcserver.html" class="tsd-kind-icon">RPCServer</a></li>
77
-							</ul>
78
-						</section>
79
-					</div>
80
-				</section>
81
-			</section>
82
-		</div>
83
-		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
84
-			<nav class="tsd-navigation primary">
85
-				<ul>
86
-					<li class="globals  ">
87
-						<a href="../index.html"><em>Globals</em></a>
88
-					</li>
89
-					<li class="current tsd-kind-external-module">
90
-						<a href="_backend_.html">"<wbr>Backend"</a>
91
-					</li>
92
-					<li class=" tsd-kind-external-module">
93
-						<a href="_frontend_.html">"<wbr>Frontend"</a>
94
-					</li>
95
-					<li class=" tsd-kind-external-module">
96
-						<a href="_interfaces_.html">"<wbr>Interfaces"</a>
97
-					</li>
98
-					<li class=" tsd-kind-external-module">
99
-						<a href="_types_.html">"<wbr>Types"</a>
100
-					</li>
101
-					<li class=" tsd-kind-external-module">
102
-						<a href="_utils_.html">"<wbr>Utils"</a>
103
-					</li>
104
-				</ul>
105
-			</nav>
106
-			<nav class="tsd-navigation secondary menu-sticky">
107
-				<ul class="before-current">
108
-					<li class=" tsd-kind-class tsd-parent-kind-external-module tsd-has-type-parameter">
109
-						<a href="../classes/_backend_.rpcserver.html" class="tsd-kind-icon">RPCServer</a>
110
-					</li>
111
-				</ul>
112
-			</nav>
113
-		</div>
114
-	</div>
115
-</div>
116
-<footer class="with-border-bottom">
117
-	<div class="container">
118
-		<h2>Legend</h2>
119
-		<div class="tsd-legend-group">
120
-			<ul class="tsd-legend">
121
-				<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
122
-				<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
123
-				<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
124
-				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
125
-				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
126
-				<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
127
-				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
128
-				<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
129
-			</ul>
130
-			<ul class="tsd-legend">
131
-				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
132
-				<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
133
-				<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
134
-				<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
135
-			</ul>
136
-			<ul class="tsd-legend">
137
-				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
138
-				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
139
-				<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
140
-				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
141
-				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
142
-				<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
143
-			</ul>
144
-			<ul class="tsd-legend">
145
-				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
146
-				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
147
-				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
148
-				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
149
-				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
150
-				<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
151
-				<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
152
-			</ul>
153
-			<ul class="tsd-legend">
154
-				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
155
-				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
156
-				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
157
-				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
158
-			</ul>
159
-			<ul class="tsd-legend">
160
-				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
161
-				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
162
-				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
163
-			</ul>
164
-			<ul class="tsd-legend">
165
-				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
166
-				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
167
-				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
168
-			</ul>
169
-			<ul class="tsd-legend">
170
-				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
171
-				<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
172
-			</ul>
173
-		</div>
174
-	</div>
175
-</footer>
176
-<div class="container tsd-generator">
177
-	<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
178
-</div>
179
-<div class="overlay"></div>
180
-<script src="../assets/js/main.js"></script>
181
-<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
182
-</body>
183
-</html>

+ 9
- 0
docs/modules/_backend_.md View File

@@ -0,0 +1,9 @@
1
+[rpclibrary](../README.md) › ["Backend"](_backend_.md)
2
+
3
+# External module: "Backend"
4
+
5
+## Index
6
+
7
+### Classes
8
+
9
+* [RPCServer](../classes/_backend_.rpcserver.md)

+ 0
- 218
docs/modules/_frontend_.html View File

@@ -1,218 +0,0 @@
1
-<!doctype html>
2
-<html class="default no-js">
3
-<head>
4
-	<meta charset="utf-8">
5
-	<meta http-equiv="X-UA-Compatible" content="IE=edge">
6
-	<title>&quot;Frontend&quot; | rpclibrary</title>
7
-	<meta name="description" content="">
8
-	<meta name="viewport" content="width=device-width, initial-scale=1">
9
-	<link rel="stylesheet" href="../assets/css/main.css">
10
-</head>
11
-<body>
12
-<header>
13
-	<div class="tsd-page-toolbar">
14
-		<div class="container">
15
-			<div class="table-wrap">
16
-				<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
17
-					<div class="field">
18
-						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
19
-						<input id="tsd-search-field" type="text" />
20
-					</div>
21
-					<ul class="results">
22
-						<li class="state loading">Preparing search index...</li>
23
-						<li class="state failure">The search index is not available</li>
24
-					</ul>
25
-					<a href="../index.html" class="title">rpclibrary</a>
26
-				</div>
27
-				<div class="table-cell" id="tsd-widgets">
28
-					<div id="tsd-filter">
29
-						<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
30
-						<div class="tsd-filter-group">
31
-							<div class="tsd-select" id="tsd-filter-visibility">
32
-								<span class="tsd-select-label">All</span>
33
-								<ul class="tsd-select-list">
34
-									<li data-value="public">Public</li>
35
-									<li data-value="protected">Public/Protected</li>
36
-									<li data-value="private" class="selected">All</li>
37
-								</ul>
38
-							</div>
39
-							<input type="checkbox" id="tsd-filter-inherited" checked />
40
-							<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
41
-							<input type="checkbox" id="tsd-filter-externals" checked />
42
-							<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
43
-							<input type="checkbox" id="tsd-filter-only-exported" />
44
-							<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
45
-						</div>
46
-					</div>
47
-					<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
48
-				</div>
49
-			</div>
50
-		</div>
51
-	</div>
52
-	<div class="tsd-page-title">
53
-		<div class="container">
54
-			<ul class="tsd-breadcrumb">
55
-				<li>
56
-					<a href="../index.html">Globals</a>
57
-				</li>
58
-				<li>
59
-					<a href="_frontend_.html">&quot;Frontend&quot;</a>
60
-				</li>
61
-			</ul>
62
-			<h1>External module &quot;Frontend&quot;</h1>
63
-		</div>
64
-	</div>
65
-</header>
66
-<div class="container container-main">
67
-	<div class="row">
68
-		<div class="col-8 col-content">
69
-			<section class="tsd-panel-group tsd-index-group">
70
-				<h2>Index</h2>
71
-				<section class="tsd-panel tsd-index-panel">
72
-					<div class="tsd-index-content">
73
-						<section class="tsd-index-section ">
74
-							<h3>Classes</h3>
75
-							<ul class="tsd-index-list">
76
-								<li class="tsd-kind-class tsd-parent-kind-external-module"><a href="../classes/_frontend_.rpcsocket.html" class="tsd-kind-icon">RPCSocket</a></li>
77
-							</ul>
78
-						</section>
79
-						<section class="tsd-index-section tsd-is-not-exported">
80
-							<h3>Functions</h3>
81
-							<ul class="tsd-index-list">
82
-								<li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"><a href="_frontend_.html#stripafterequals" class="tsd-kind-icon">strip<wbr>After<wbr>Equals</a></li>
83
-							</ul>
84
-						</section>
85
-					</div>
86
-				</section>
87
-			</section>
88
-			<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
89
-				<h2>Functions</h2>
90
-				<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
91
-					<a name="stripafterequals" class="tsd-anchor"></a>
92
-					<h3>strip<wbr>After<wbr>Equals</h3>
93
-					<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
94
-						<li class="tsd-signature tsd-kind-icon">strip<wbr>After<wbr>Equals<span class="tsd-signature-symbol">(</span>str<span class="tsd-signature-symbol">: </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">string</span></li>
95
-					</ul>
96
-					<ul class="tsd-descriptions">
97
-						<li class="tsd-description">
98
-							<aside class="tsd-sources">
99
-								<ul>
100
-									<li>Defined in Frontend.ts:9</li>
101
-								</ul>
102
-							</aside>
103
-							<h4 class="tsd-parameters-title">Parameters</h4>
104
-							<ul class="tsd-parameters">
105
-								<li>
106
-									<h5>str: <span class="tsd-signature-type">string</span></h5>
107
-								</li>
108
-							</ul>
109
-							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
110
-						</li>
111
-					</ul>
112
-				</section>
113
-			</section>
114
-		</div>
115
-		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
116
-			<nav class="tsd-navigation primary">
117
-				<ul>
118
-					<li class="globals  ">
119
-						<a href="../index.html"><em>Globals</em></a>
120
-					</li>
121
-					<li class=" tsd-kind-external-module">
122
-						<a href="_backend_.html">"<wbr>Backend"</a>
123
-					</li>
124
-					<li class="current tsd-kind-external-module">
125
-						<a href="_frontend_.html">"<wbr>Frontend"</a>
126
-					</li>
127
-					<li class=" tsd-kind-external-module">
128
-						<a href="_interfaces_.html">"<wbr>Interfaces"</a>
129
-					</li>
130
-					<li class=" tsd-kind-external-module">
131
-						<a href="_types_.html">"<wbr>Types"</a>
132
-					</li>
133
-					<li class=" tsd-kind-external-module">
134
-						<a href="_utils_.html">"<wbr>Utils"</a>
135
-					</li>
136
-				</ul>
137
-			</nav>
138
-			<nav class="tsd-navigation secondary menu-sticky">
139
-				<ul class="before-current">
140
-					<li class=" tsd-kind-class tsd-parent-kind-external-module">
141
-						<a href="../classes/_frontend_.rpcsocket.html" class="tsd-kind-icon">RPCSocket</a>
142
-					</li>
143
-					<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
144
-						<a href="_frontend_.html#stripafterequals" class="tsd-kind-icon">strip<wbr>After<wbr>Equals</a>
145
-					</li>
146
-				</ul>
147
-			</nav>
148
-		</div>
149
-	</div>
150
-</div>
151
-<footer class="with-border-bottom">
152
-	<div class="container">
153
-		<h2>Legend</h2>
154
-		<div class="tsd-legend-group">
155
-			<ul class="tsd-legend">
156
-				<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
157
-				<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
158
-				<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
159
-				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
160
-				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
161
-				<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
162
-				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
163
-				<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
164
-			</ul>
165
-			<ul class="tsd-legend">
166
-				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
167
-				<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
168
-				<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
169
-				<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
170
-			</ul>
171
-			<ul class="tsd-legend">
172
-				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
173
-				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
174
-				<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
175
-				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
176
-				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
177
-				<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
178
-			</ul>
179
-			<ul class="tsd-legend">
180
-				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
181
-				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
182
-				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
183
-				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
184
-				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
185
-				<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
186
-				<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
187
-			</ul>
188
-			<ul class="tsd-legend">
189
-				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
190
-				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
191
-				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
192
-				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
193
-			</ul>
194
-			<ul class="tsd-legend">
195
-				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
196
-				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
197
-				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
198
-			</ul>
199
-			<ul class="tsd-legend">
200
-				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
201
-				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
202
-				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
203
-			</ul>
204
-			<ul class="tsd-legend">
205
-				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
206
-				<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
207
-			</ul>
208
-		</div>
209
-	</div>
210
-</footer>
211
-<div class="container tsd-generator">
212
-	<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
213
-</div>
214
-<div class="overlay"></div>
215
-<script src="../assets/js/main.js"></script>
216
-<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
217
-</body>
218
-</html>

+ 29
- 0
docs/modules/_frontend_.md View File

@@ -0,0 +1,29 @@
1
+[rpclibrary](../README.md) › ["Frontend"](_frontend_.md)
2
+
3
+# External module: "Frontend"
4
+
5
+## Index
6
+
7
+### Classes
8
+
9
+* [RPCSocket](../classes/_frontend_.rpcsocket.md)
10
+
11
+### Functions
12
+
13
+* [stripAfterEquals](_frontend_.md#stripafterequals)
14
+
15
+## Functions
16
+
17
+###  stripAfterEquals
18
+
19
+▸ **stripAfterEquals**(`str`: string): *string*
20
+
21
+Defined in Frontend.ts:9
22
+
23
+**Parameters:**
24
+
25
+Name | Type |
26
+------ | ------ |
27
+`str` | string |
28
+
29
+**Returns:** *string*

+ 0
- 191
docs/modules/_interfaces_.html View File

@@ -1,191 +0,0 @@
1
-<!doctype html>
2
-<html class="default no-js">
3
-<head>
4
-	<meta charset="utf-8">
5
-	<meta http-equiv="X-UA-Compatible" content="IE=edge">
6
-	<title>&quot;Interfaces&quot; | rpclibrary</title>
7
-	<meta name="description" content="">
8
-	<meta name="viewport" content="width=device-width, initial-scale=1">
9
-	<link rel="stylesheet" href="../assets/css/main.css">
10
-</head>
11
-<body>
12
-<header>
13
-	<div class="tsd-page-toolbar">
14
-		<div class="container">
15
-			<div class="table-wrap">
16
-				<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
17
-					<div class="field">
18
-						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
19
-						<input id="tsd-search-field" type="text" />
20
-					</div>
21
-					<ul class="results">
22
-						<li class="state loading">Preparing search index...</li>
23
-						<li class="state failure">The search index is not available</li>
24
-					</ul>
25
-					<a href="../index.html" class="title">rpclibrary</a>
26
-				</div>
27
-				<div class="table-cell" id="tsd-widgets">
28
-					<div id="tsd-filter">
29
-						<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
30
-						<div class="tsd-filter-group">
31
-							<div class="tsd-select" id="tsd-filter-visibility">
32
-								<span class="tsd-select-label">All</span>
33
-								<ul class="tsd-select-list">
34
-									<li data-value="public">Public</li>
35
-									<li data-value="protected">Public/Protected</li>
36
-									<li data-value="private" class="selected">All</li>
37
-								</ul>
38
-							</div>
39
-							<input type="checkbox" id="tsd-filter-inherited" checked />
40
-							<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
41
-							<input type="checkbox" id="tsd-filter-externals" checked />
42
-							<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
43
-							<input type="checkbox" id="tsd-filter-only-exported" />
44
-							<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
45
-						</div>
46
-					</div>
47
-					<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
48
-				</div>
49
-			</div>
50
-		</div>
51
-	</div>
52
-	<div class="tsd-page-title">
53
-		<div class="container">
54
-			<ul class="tsd-breadcrumb">
55
-				<li>
56
-					<a href="../index.html">Globals</a>
57
-				</li>
58
-				<li>
59
-					<a href="_interfaces_.html">&quot;Interfaces&quot;</a>
60
-				</li>
61
-			</ul>
62
-			<h1>External module &quot;Interfaces&quot;</h1>
63
-		</div>
64
-	</div>
65
-</header>
66
-<div class="container container-main">
67
-	<div class="row">
68
-		<div class="col-8 col-content">
69
-			<section class="tsd-panel-group tsd-index-group">
70
-				<h2>Index</h2>
71
-				<section class="tsd-panel tsd-index-panel">
72
-					<div class="tsd-index-content">
73
-						<section class="tsd-index-section ">
74
-							<h3>Interfaces</h3>
75
-							<ul class="tsd-index-list">
76
-								<li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/_interfaces_.destroyable.html" class="tsd-kind-icon">Destroyable</a></li>
77
-								<li class="tsd-kind-interface tsd-parent-kind-external-module tsd-has-type-parameter"><a href="../interfaces/_interfaces_.exporter.html" class="tsd-kind-icon">Exporter</a></li>
78
-								<li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/_interfaces_.socket.html" class="tsd-kind-icon">Socket</a></li>
79
-							</ul>
80
-						</section>
81
-					</div>
82
-				</section>
83
-			</section>
84
-		</div>
85
-		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
86
-			<nav class="tsd-navigation primary">
87
-				<ul>
88
-					<li class="globals  ">
89
-						<a href="../index.html"><em>Globals</em></a>
90
-					</li>
91
-					<li class=" tsd-kind-external-module">
92
-						<a href="_backend_.html">"<wbr>Backend"</a>
93
-					</li>
94
-					<li class=" tsd-kind-external-module">
95
-						<a href="_frontend_.html">"<wbr>Frontend"</a>
96
-					</li>
97
-					<li class="current tsd-kind-external-module">
98
-						<a href="_interfaces_.html">"<wbr>Interfaces"</a>
99
-					</li>
100
-					<li class=" tsd-kind-external-module">
101
-						<a href="_types_.html">"<wbr>Types"</a>
102
-					</li>
103
-					<li class=" tsd-kind-external-module">
104
-						<a href="_utils_.html">"<wbr>Utils"</a>
105
-					</li>
106
-				</ul>
107
-			</nav>
108
-			<nav class="tsd-navigation secondary menu-sticky">
109
-				<ul class="before-current">
110
-					<li class=" tsd-kind-interface tsd-parent-kind-external-module">
111
-						<a href="../interfaces/_interfaces_.destroyable.html" class="tsd-kind-icon">Destroyable</a>
112
-					</li>
113
-					<li class=" tsd-kind-interface tsd-parent-kind-external-module tsd-has-type-parameter">
114
-						<a href="../interfaces/_interfaces_.exporter.html" class="tsd-kind-icon">Exporter</a>
115
-					</li>
116
-					<li class=" tsd-kind-interface tsd-parent-kind-external-module">
117
-						<a href="../interfaces/_interfaces_.socket.html" class="tsd-kind-icon">Socket</a>
118
-					</li>
119
-				</ul>
120
-			</nav>
121
-		</div>
122
-	</div>
123
-</div>
124
-<footer class="with-border-bottom">
125
-	<div class="container">
126
-		<h2>Legend</h2>
127
-		<div class="tsd-legend-group">
128
-			<ul class="tsd-legend">
129
-				<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
130
-				<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
131
-				<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
132
-				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
133
-				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
134
-				<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
135
-				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
136
-				<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
137
-			</ul>
138
-			<ul class="tsd-legend">
139
-				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
140
-				<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
141
-				<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
142
-				<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
143
-			</ul>
144
-			<ul class="tsd-legend">
145
-				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
146
-				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
147
-				<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
148
-				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
149
-				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
150
-				<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
151
-			</ul>
152
-			<ul class="tsd-legend">
153
-				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
154
-				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
155
-				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
156
-				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
157
-				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
158
-				<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
159
-				<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
160
-			</ul>
161
-			<ul class="tsd-legend">
162
-				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
163
-				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
164
-				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
165
-				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
166
-			</ul>
167
-			<ul class="tsd-legend">
168
-				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
169
-				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
170
-				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
171
-			</ul>
172
-			<ul class="tsd-legend">
173
-				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
174
-				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
175
-				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
176
-			</ul>
177
-			<ul class="tsd-legend">
178
-				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
179
-				<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
180
-			</ul>
181
-		</div>
182
-	</div>
183
-</footer>
184
-<div class="container tsd-generator">
185
-	<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
186
-</div>
187
-<div class="overlay"></div>
188
-<script src="../assets/js/main.js"></script>
189
-<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
190
-</body>
191
-</html>

+ 11
- 0
docs/modules/_interfaces_.md View File

@@ -0,0 +1,11 @@
1
+[rpclibrary](../README.md) › ["Interfaces"](_interfaces_.md)
2
+
3
+# External module: "Interfaces"
4
+
5
+## Index
6
+
7
+### Interfaces
8
+
9
+* [Destroyable](../interfaces/_interfaces_.destroyable.md)
10
+* [Exporter](../interfaces/_interfaces_.exporter.md)
11
+* [Socket](../interfaces/_interfaces_.socket.md)

+ 0
- 885
docs/modules/_types_.html View File

@@ -1,885 +0,0 @@
1
-<!doctype html>
2
-<html class="default no-js">
3
-<head>
4
-	<meta charset="utf-8">
5
-	<meta http-equiv="X-UA-Compatible" content="IE=edge">
6
-	<title>&quot;Types&quot; | rpclibrary</title>
7
-	<meta name="description" content="">
8
-	<meta name="viewport" content="width=device-width, initial-scale=1">
9
-	<link rel="stylesheet" href="../assets/css/main.css">
10
-</head>
11
-<body>
12
-<header>
13
-	<div class="tsd-page-toolbar">
14
-		<div class="container">
15
-			<div class="table-wrap">
16
-				<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
17
-					<div class="field">
18
-						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
19
-						<input id="tsd-search-field" type="text" />
20
-					</div>
21
-					<ul class="results">
22
-						<li class="state loading">Preparing search index...</li>
23
-						<li class="state failure">The search index is not available</li>
24
-					</ul>
25
-					<a href="../index.html" class="title">rpclibrary</a>
26
-				</div>
27
-				<div class="table-cell" id="tsd-widgets">
28
-					<div id="tsd-filter">
29
-						<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
30
-						<div class="tsd-filter-group">
31
-							<div class="tsd-select" id="tsd-filter-visibility">
32
-								<span class="tsd-select-label">All</span>
33
-								<ul class="tsd-select-list">
34
-									<li data-value="public">Public</li>
35
-									<li data-value="protected">Public/Protected</li>
36
-									<li data-value="private" class="selected">All</li>
37
-								</ul>
38
-							</div>
39
-							<input type="checkbox" id="tsd-filter-inherited" checked />
40
-							<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
41
-							<input type="checkbox" id="tsd-filter-externals" checked />
42
-							<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
43
-							<input type="checkbox" id="tsd-filter-only-exported" />
44
-							<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
45
-						</div>
46
-					</div>
47
-					<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
48
-				</div>
49
-			</div>
50
-		</div>
51
-	</div>
52
-	<div class="tsd-page-title">
53
-		<div class="container">
54
-			<ul class="tsd-breadcrumb">
55
-				<li>
56
-					<a href="../index.html">Globals</a>
57
-				</li>
58
-				<li>
59
-					<a href="_types_.html">&quot;Types&quot;</a>
60
-				</li>
61
-			</ul>
62
-			<h1>External module &quot;Types&quot;</h1>
63
-		</div>
64
-	</div>
65
-</header>
66
-<div class="container container-main">
67
-	<div class="row">
68
-		<div class="col-8 col-content">
69
-			<section class="tsd-panel-group tsd-index-group">
70
-				<h2>Index</h2>
71
-				<section class="tsd-panel tsd-index-panel">
72
-					<div class="tsd-index-content">
73
-						<section class="tsd-index-section ">
74
-							<h3>Type aliases</h3>
75
-							<ul class="tsd-index-list">
76
-								<li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_types_.html#any" class="tsd-kind-icon">Any</a></li>
77
-								<li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_types_.html#arg" class="tsd-kind-icon">Arg</a></li>
78
-								<li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_types_.html#asyncfunction" class="tsd-kind-icon">Async<wbr>Function</a></li>
79
-								<li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_types_.html#baseinfo" class="tsd-kind-icon">Base<wbr>Info</a></li>
80
-								<li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_types_.html#callinfo" class="tsd-kind-icon">Call<wbr>Info</a></li>
81
-								<li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_types_.html#callrpc" class="tsd-kind-icon">CallRPC</a></li>
82
-								<li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_types_.html#callbackfunction" class="tsd-kind-icon">Callback<wbr>Function</a></li>
83
-								<li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_types_.html#closehandler" class="tsd-kind-icon">Close<wbr>Handler</a></li>
84
-								<li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_types_.html#connectionhandler" class="tsd-kind-icon">Connection<wbr>Handler</a></li>
85
-								<li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_types_.html#errorhandler" class="tsd-kind-icon">Error<wbr>Handler</a></li>
86
-								<li class="tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter"><a href="_types_.html#errorresponse" class="tsd-kind-icon">Error<wbr>Response</a></li>
87
-								<li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_types_.html#extendedrpcinfo" class="tsd-kind-icon">Extended<wbr>Rpc<wbr>Info</a></li>
88
-								<li class="tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter"><a href="_types_.html#hookclosefunction" class="tsd-kind-icon">Hook<wbr>Close<wbr>Function</a></li>
89
-								<li class="tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter"><a href="_types_.html#hookfunction" class="tsd-kind-icon">Hook<wbr>Function</a></li>
90
-								<li class="tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter"><a href="_types_.html#hookinfo" class="tsd-kind-icon">Hook<wbr>Info</a></li>
91
-								<li class="tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter"><a href="_types_.html#hookrpc" class="tsd-kind-icon">HookRPC</a></li>
92
-								<li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_types_.html#name-2" class="tsd-kind-icon">Name</a></li>
93
-								<li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_types_.html#onfunction" class="tsd-kind-icon">On<wbr>Function</a></li>
94
-								<li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_types_.html#outcome" class="tsd-kind-icon">Outcome</a></li>
95
-								<li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_types_.html#owner-1" class="tsd-kind-icon">Owner</a></li>
96
-								<li class="tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter"><a href="_types_.html#rpc" class="tsd-kind-icon">RPC</a></li>
97
-								<li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_types_.html#rpctype" class="tsd-kind-icon">RPCType</a></li>
98
-								<li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_types_.html#responsetype" class="tsd-kind-icon">Response<wbr>Type</a></li>
99
-								<li class="tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter"><a href="_types_.html#respose" class="tsd-kind-icon">Respose</a></li>
100
-								<li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_types_.html#rpcinfo" class="tsd-kind-icon">Rpc<wbr>Info</a></li>
101
-								<li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_types_.html#socketconf" class="tsd-kind-icon">Socket<wbr>Conf</a></li>
102
-								<li class="tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter"><a href="_types_.html#subscriptionresponse" class="tsd-kind-icon">Subscription<wbr>Response</a></li>
103
-								<li class="tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter"><a href="_types_.html#successresponse" class="tsd-kind-icon">Success<wbr>Response</a></li>
104
-								<li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_types_.html#visibility-1" class="tsd-kind-icon">Visibility</a></li>
105
-							</ul>
106
-						</section>
107
-					</div>
108
-				</section>
109
-			</section>
110
-			<section class="tsd-panel-group tsd-member-group ">
111
-				<h2>Type aliases</h2>
112
-				<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module">
113
-					<a name="any" class="tsd-anchor"></a>
114
-					<h3>Any</h3>
115
-					<div class="tsd-signature tsd-kind-icon">Any<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
116
-					<aside class="tsd-sources">
117
-						<ul>
118
-							<li>Defined in Types.ts:4</li>
119
-						</ul>
120
-					</aside>
121
-				</section>
122
-				<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module">
123
-					<a name="arg" class="tsd-anchor"></a>
124
-					<h3>Arg</h3>
125
-					<div class="tsd-signature tsd-kind-icon">Arg<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
126
-					<aside class="tsd-sources">
127
-						<ul>
128
-							<li>Defined in Types.ts:5</li>
129
-						</ul>
130
-					</aside>
131
-				</section>
132
-				<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module">
133
-					<a name="asyncfunction" class="tsd-anchor"></a>
134
-					<h3>Async<wbr>Function</h3>
135
-					<div class="tsd-signature tsd-kind-icon">Async<wbr>Function<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
136
-					<aside class="tsd-sources">
137
-						<ul>
138
-							<li>Defined in Types.ts:65</li>
139
-						</ul>
140
-					</aside>
141
-					<div class="tsd-type-declaration">
142
-						<h4>Type declaration</h4>
143
-						<ul class="tsd-parameters">
144
-							<li class="tsd-parameter-siganture">
145
-								<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias tsd-is-not-exported">
146
-									<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</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">any</span><span class="tsd-signature-symbol">&gt;</span></li>
147
-								</ul>
148
-								<ul class="tsd-descriptions">
149
-									<li class="tsd-description">
150
-										<h4 class="tsd-parameters-title">Parameters</h4>
151
-										<ul class="tsd-parameters">
152
-											<li>
153
-												<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span></h5>
154
-											</li>
155
-										</ul>
156
-										<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">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
157
-									</li>
158
-								</ul>
159
-							</li>
160
-						</ul>
161
-					</div>
162
-				</section>
163
-				<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module">
164
-					<a name="baseinfo" class="tsd-anchor"></a>
165
-					<h3>Base<wbr>Info</h3>
166
-					<div class="tsd-signature tsd-kind-icon">Base<wbr>Info<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
167
-					<aside class="tsd-sources">
168
-						<ul>
169
-							<li>Defined in Types.ts:43</li>
170
-						</ul>
171
-					</aside>
172
-					<div class="tsd-type-declaration">
173
-						<h4>Type declaration</h4>
174
-						<ul class="tsd-parameters">
175
-							<li class="tsd-parameter">
176
-								<h5>arg<wbr>Names<span class="tsd-signature-symbol">: </span><a href="_types_.html#name-2" class="tsd-signature-type">Name</a><span class="tsd-signature-symbol">[]</span></h5>
177
-							</li>
178
-							<li class="tsd-parameter">
179
-								<h5>name<span class="tsd-signature-symbol">: </span><a href="_types_.html#name-2" class="tsd-signature-type">Name</a></h5>
180
-							</li>
181
-							<li class="tsd-parameter">
182
-								<h5>owner<span class="tsd-signature-symbol">: </span><a href="_types_.html#name-2" class="tsd-signature-type">Name</a></h5>
183
-							</li>
184
-						</ul>
185
-					</div>
186
-				</section>
187
-				<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module">
188
-					<a name="callinfo" class="tsd-anchor"></a>
189
-					<h3>Call<wbr>Info</h3>
190
-					<div class="tsd-signature tsd-kind-icon">Call<wbr>Info<span class="tsd-signature-symbol">:</span> <a href="_types_.html#baseinfo" class="tsd-signature-type">BaseInfo</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">object</span></div>
191
-					<aside class="tsd-sources">
192
-						<ul>
193
-							<li>Defined in Types.ts:54</li>
194
-						</ul>
195
-					</aside>
196
-				</section>
197
-				<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module">
198
-					<a name="callrpc" class="tsd-anchor"></a>
199
-					<h3>CallRPC</h3>
200
-					<div class="tsd-signature tsd-kind-icon">CallRPC<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Function</span></div>
201
-					<aside class="tsd-sources">
202
-						<ul>
203
-							<li>Defined in Types.ts:36</li>
204
-						</ul>
205
-					</aside>
206
-				</section>
207
-				<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module">
208
-					<a name="callbackfunction" class="tsd-anchor"></a>
209
-					<h3>Callback<wbr>Function</h3>
210
-					<div class="tsd-signature tsd-kind-icon">Callback<wbr>Function<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
211
-					<aside class="tsd-sources">
212
-						<ul>
213
-							<li>Defined in Types.ts:66</li>
214
-						</ul>
215
-					</aside>
216
-					<div class="tsd-type-declaration">
217
-						<h4>Type declaration</h4>
218
-						<ul class="tsd-parameters">
219
-							<li class="tsd-parameter-siganture">
220
-								<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias tsd-is-not-exported">
221
-									<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
222
-								</ul>
223
-								<ul class="tsd-descriptions">
224
-									<li class="tsd-description">
225
-										<h4 class="tsd-parameters-title">Parameters</h4>
226
-										<ul class="tsd-parameters">
227
-											<li>
228
-												<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span></h5>
229
-											</li>
230
-										</ul>
231
-										<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
232
-									</li>
233
-								</ul>
234
-							</li>
235
-						</ul>
236
-					</div>
237
-				</section>
238
-				<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module">
239
-					<a name="closehandler" class="tsd-anchor"></a>
240
-					<h3>Close<wbr>Handler</h3>
241
-					<div class="tsd-signature tsd-kind-icon">Close<wbr>Handler<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
242
-					<aside class="tsd-sources">
243
-						<ul>
244
-							<li>Defined in Types.ts:10</li>
245
-						</ul>
246
-					</aside>
247
-					<div class="tsd-type-declaration">
248
-						<h4>Type declaration</h4>
249
-						<ul class="tsd-parameters">
250
-							<li class="tsd-parameter-siganture">
251
-								<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias tsd-is-not-exported">
252
-									<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>socket<span class="tsd-signature-symbol">: </span><a href="../interfaces/_interfaces_.socket.html" class="tsd-signature-type">Socket</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
253
-								</ul>
254
-								<ul class="tsd-descriptions">
255
-									<li class="tsd-description">
256
-										<h4 class="tsd-parameters-title">Parameters</h4>
257
-										<ul class="tsd-parameters">
258
-											<li>
259
-												<h5>socket: <a href="../interfaces/_interfaces_.socket.html" class="tsd-signature-type">Socket</a></h5>
260
-											</li>
261
-										</ul>
262
-										<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
263
-									</li>
264
-								</ul>
265
-							</li>
266
-						</ul>
267
-					</div>
268
-				</section>
269
-				<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module">
270
-					<a name="connectionhandler" class="tsd-anchor"></a>
271
-					<h3>Connection<wbr>Handler</h3>
272
-					<div class="tsd-signature tsd-kind-icon">Connection<wbr>Handler<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
273
-					<aside class="tsd-sources">
274
-						<ul>
275
-							<li>Defined in Types.ts:8</li>
276
-						</ul>
277
-					</aside>
278
-					<div class="tsd-type-declaration">
279
-						<h4>Type declaration</h4>
280
-						<ul class="tsd-parameters">
281
-							<li class="tsd-parameter-siganture">
282
-								<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias tsd-is-not-exported">
283
-									<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>socket<span class="tsd-signature-symbol">: </span><a href="../interfaces/_interfaces_.socket.html" class="tsd-signature-type">Socket</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
284
-								</ul>
285
-								<ul class="tsd-descriptions">
286
-									<li class="tsd-description">
287
-										<h4 class="tsd-parameters-title">Parameters</h4>
288
-										<ul class="tsd-parameters">
289
-											<li>
290
-												<h5>socket: <a href="../interfaces/_interfaces_.socket.html" class="tsd-signature-type">Socket</a></h5>
291
-											</li>
292
-										</ul>
293
-										<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
294
-									</li>
295
-								</ul>
296
-							</li>
297
-						</ul>
298
-					</div>
299
-				</section>
300
-				<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module">
301
-					<a name="errorhandler" class="tsd-anchor"></a>
302
-					<h3>Error<wbr>Handler</h3>
303
-					<div class="tsd-signature tsd-kind-icon">Error<wbr>Handler<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
304
-					<aside class="tsd-sources">
305
-						<ul>
306
-							<li>Defined in Types.ts:9</li>
307
-						</ul>
308
-					</aside>
309
-					<div class="tsd-type-declaration">
310
-						<h4>Type declaration</h4>
311
-						<ul class="tsd-parameters">
312
-							<li class="tsd-parameter-siganture">
313
-								<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias tsd-is-not-exported">
314
-									<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>socket<span class="tsd-signature-symbol">: </span><a href="../interfaces/_interfaces_.socket.html" class="tsd-signature-type">Socket</a>, error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
315
-								</ul>
316
-								<ul class="tsd-descriptions">
317
-									<li class="tsd-description">
318
-										<h4 class="tsd-parameters-title">Parameters</h4>
319
-										<ul class="tsd-parameters">
320
-											<li>
321
-												<h5>socket: <a href="../interfaces/_interfaces_.socket.html" class="tsd-signature-type">Socket</a></h5>
322
-											</li>
323
-											<li>
324
-												<h5>error: <span class="tsd-signature-type">any</span></h5>
325
-											</li>
326
-										</ul>
327
-										<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
328
-									</li>
329
-								</ul>
330
-							</li>
331
-						</ul>
332
-					</div>
333
-				</section>
334
-				<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter">
335
-					<a name="errorresponse" class="tsd-anchor"></a>
336
-					<h3>Error<wbr>Response</h3>
337
-					<div class="tsd-signature tsd-kind-icon">Error<wbr>Response&lt;T&gt;<span class="tsd-signature-symbol">:</span> <a href="_types_.html#respose" class="tsd-signature-type">Respose</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">object</span></div>
338
-					<aside class="tsd-sources">
339
-						<ul>
340
-							<li>Defined in Types.ts:24</li>
341
-						</ul>
342
-					</aside>
343
-					<h4 class="tsd-type-parameters-title">Type parameters</h4>
344
-					<ul class="tsd-type-parameters">
345
-						<li>
346
-							<h4>T</h4>
347
-						</li>
348
-					</ul>
349
-				</section>
350
-				<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module">
351
-					<a name="extendedrpcinfo" class="tsd-anchor"></a>
352
-					<h3>Extended<wbr>Rpc<wbr>Info</h3>
353
-					<div class="tsd-signature tsd-kind-icon">Extended<wbr>Rpc<wbr>Info<span class="tsd-signature-symbol">:</span> <a href="_types_.html#rpcinfo" class="tsd-signature-type">RpcInfo</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">object</span></div>
354
-					<aside class="tsd-sources">
355
-						<ul>
356
-							<li>Defined in Types.ts:60</li>
357
-						</ul>
358
-					</aside>
359
-				</section>
360
-				<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter">
361
-					<a name="hookclosefunction" class="tsd-anchor"></a>
362
-					<h3>Hook<wbr>Close<wbr>Function</h3>
363
-					<div class="tsd-signature tsd-kind-icon">Hook<wbr>Close<wbr>Function&lt;T&gt;<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
364
-					<aside class="tsd-sources">
365
-						<ul>
366
-							<li>Defined in Types.ts:63</li>
367
-						</ul>
368
-					</aside>
369
-					<h4 class="tsd-type-parameters-title">Type parameters</h4>
370
-					<ul class="tsd-type-parameters">
371
-						<li>
372
-							<h4>T</h4>
373
-						</li>
374
-					</ul>
375
-					<div class="tsd-type-declaration">
376
-						<h4>Type declaration</h4>
377
-						<ul class="tsd-parameters">
378
-							<li class="tsd-parameter-siganture">
379
-								<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias tsd-is-not-exported">
380
-									<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>res<span class="tsd-signature-symbol">: </span><a href="_types_.html#subscriptionresponse" class="tsd-signature-type">SubscriptionResponse</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span>, rpc<span class="tsd-signature-symbol">: </span><a href="_types_.html#hookrpc" class="tsd-signature-type">HookRPC</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</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">any</span></li>
381
-								</ul>
382
-								<ul class="tsd-descriptions">
383
-									<li class="tsd-description">
384
-										<h4 class="tsd-parameters-title">Parameters</h4>
385
-										<ul class="tsd-parameters">
386
-											<li>
387
-												<h5>res: <a href="_types_.html#subscriptionresponse" class="tsd-signature-type">SubscriptionResponse</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></h5>
388
-											</li>
389
-											<li>
390
-												<h5>rpc: <a href="_types_.html#hookrpc" class="tsd-signature-type">HookRPC</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></h5>
391
-											</li>
392
-										</ul>
393
-										<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
394
-									</li>
395
-								</ul>
396
-							</li>
397
-						</ul>
398
-					</div>
399
-				</section>
400
-				<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter">
401
-					<a name="hookfunction" class="tsd-anchor"></a>
402
-					<h3>Hook<wbr>Function</h3>
403
-					<div class="tsd-signature tsd-kind-icon">Hook<wbr>Function&lt;T&gt;<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
404
-					<aside class="tsd-sources">
405
-						<ul>
406
-							<li>Defined in Types.ts:64</li>
407
-						</ul>
408
-					</aside>
409
-					<h4 class="tsd-type-parameters-title">Type parameters</h4>
410
-					<ul class="tsd-type-parameters">
411
-						<li>
412
-							<h4>T</h4>
413
-						</li>
414
-					</ul>
415
-					<div class="tsd-type-declaration">
416
-						<h4>Type declaration</h4>
417
-						<ul class="tsd-parameters">
418
-							<li class="tsd-parameter-siganture">
419
-								<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias tsd-is-not-exported">
420
-									<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</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><a href="_types_.html#subscriptionresponse" class="tsd-signature-type">SubscriptionResponse</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><a href="_types_.html#errorresponse" class="tsd-signature-type">ErrorResponse</a><span class="tsd-signature-symbol">&gt;</span></li>
421
-								</ul>
422
-								<ul class="tsd-descriptions">
423
-									<li class="tsd-description">
424
-										<h4 class="tsd-parameters-title">Parameters</h4>
425
-										<ul class="tsd-parameters">
426
-											<li>
427
-												<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span></h5>
428
-											</li>
429
-										</ul>
430
-										<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="_types_.html#subscriptionresponse" class="tsd-signature-type">SubscriptionResponse</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><a href="_types_.html#errorresponse" class="tsd-signature-type">ErrorResponse</a><span class="tsd-signature-symbol">&gt;</span></h4>
431
-									</li>
432
-								</ul>
433
-							</li>
434
-						</ul>
435
-					</div>
436
-				</section>
437
-				<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter">
438
-					<a name="hookinfo" class="tsd-anchor"></a>
439
-					<h3>Hook<wbr>Info</h3>
440
-					<div class="tsd-signature tsd-kind-icon">Hook<wbr>Info&lt;T&gt;<span class="tsd-signature-symbol">:</span> <a href="_types_.html#baseinfo" class="tsd-signature-type">BaseInfo</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">object</span></div>
441
-					<aside class="tsd-sources">
442
-						<ul>
443
-							<li>Defined in Types.ts:49</li>
444
-						</ul>
445
-					</aside>
446
-					<h4 class="tsd-type-parameters-title">Type parameters</h4>
447
-					<ul class="tsd-type-parameters">
448
-						<li>
449
-							<h4>T</h4>
450
-						</li>
451
-					</ul>
452
-				</section>
453
-				<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter">
454
-					<a name="hookrpc" class="tsd-anchor"></a>
455
-					<h3>HookRPC</h3>
456
-					<div class="tsd-signature tsd-kind-icon">HookRPC&lt;T&gt;<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
457
-					<aside class="tsd-sources">
458
-						<ul>
459
-							<li>Defined in Types.ts:29</li>
460
-						</ul>
461
-					</aside>
462
-					<h4 class="tsd-type-parameters-title">Type parameters</h4>
463
-					<ul class="tsd-type-parameters">
464
-						<li>
465
-							<h4>T</h4>
466
-						</li>
467
-					</ul>
468
-					<div class="tsd-type-declaration">
469
-						<h4>Type declaration</h4>
470
-						<ul class="tsd-parameters">
471
-							<li class="tsd-parameter">
472
-								<h5>hook<span class="tsd-signature-symbol">: </span><a href="_types_.html#hookfunction" class="tsd-signature-type">HookFunction</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></h5>
473
-							</li>
474
-							<li class="tsd-parameter">
475
-								<h5>name<span class="tsd-signature-symbol">: </span><a href="_types_.html#name-2" class="tsd-signature-type">Name</a></h5>
476
-							</li>
477
-							<li class="tsd-parameter">
478
-								<h5><span class="tsd-flag ts-flagOptional">Optional</span> on<wbr>Callback<span class="tsd-signature-symbol">?: </span><a href="_types_.html#callbackfunction" class="tsd-signature-type">CallbackFunction</a></h5>
479
-							</li>
480
-							<li class="tsd-parameter">
481
-								<h5><span class="tsd-flag ts-flagOptional">Optional</span> on<wbr>Close<span class="tsd-signature-symbol">?: </span><a href="_types_.html#hookclosefunction" class="tsd-signature-type">HookCloseFunction</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></h5>
482
-							</li>
483
-						</ul>
484
-					</div>
485
-				</section>
486
-				<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module">
487
-					<a name="name-2" class="tsd-anchor"></a>
488
-					<h3>Name</h3>
489
-					<div class="tsd-signature tsd-kind-icon">Name<span class="tsd-signature-symbol">:</span> <a href="_types_.html#arg" class="tsd-signature-type">Arg</a></div>
490
-					<aside class="tsd-sources">
491
-						<ul>
492
-							<li>Defined in Types.ts:6</li>
493
-						</ul>
494
-					</aside>
495
-				</section>
496
-				<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module">
497
-					<a name="onfunction" class="tsd-anchor"></a>
498
-					<h3>On<wbr>Function</h3>
499
-					<div class="tsd-signature tsd-kind-icon">On<wbr>Function<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
500
-					<aside class="tsd-sources">
501
-						<ul>
502
-							<li>Defined in Types.ts:62</li>
503
-						</ul>
504
-					</aside>
505
-					<div class="tsd-type-declaration">
506
-						<h4>Type declaration</h4>
507
-						<ul class="tsd-parameters">
508
-							<li class="tsd-parameter-siganture">
509
-								<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias tsd-is-not-exported">
510
-									<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"error"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"close"</span>, f<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_interfaces_.socket.html" class="tsd-signature-type">Socket</a></li>
511
-								</ul>
512
-								<ul class="tsd-descriptions">
513
-									<li class="tsd-description">
514
-										<h4 class="tsd-parameters-title">Parameters</h4>
515
-										<ul class="tsd-parameters">
516
-											<li>
517
-												<h5>type: <span class="tsd-signature-type">"error"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"close"</span></h5>
518
-											</li>
519
-											<li>
520
-												<h5>f: <span class="tsd-signature-type">function</span></h5>
521
-												<ul class="tsd-parameters">
522
-													<li class="tsd-parameter-siganture">
523
-														<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
524
-															<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
525
-														</ul>
526
-														<ul class="tsd-descriptions">
527
-															<li class="tsd-description">
528
-																<h4 class="tsd-parameters-title">Parameters</h4>
529
-																<ul class="tsd-parameters">
530
-																	<li>
531
-																		<h5><span class="tsd-flag ts-flagOptional">Optional</span> e: <span class="tsd-signature-type">any</span></h5>
532
-																	</li>
533
-																</ul>
534
-																<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
535
-															</li>
536
-														</ul>
537
-													</li>
538
-												</ul>
539
-											</li>
540
-										</ul>
541
-										<h4 class="tsd-returns-title">Returns <a href="../interfaces/_interfaces_.socket.html" class="tsd-signature-type">Socket</a></h4>
542
-									</li>
543
-								</ul>
544
-							</li>
545
-						</ul>
546
-					</div>
547
-				</section>
548
-				<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module">
549
-					<a name="outcome" class="tsd-anchor"></a>
550
-					<h3>Outcome</h3>
551
-					<div class="tsd-signature tsd-kind-icon">Outcome<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"Success"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"Error"</span></div>
552
-					<aside class="tsd-sources">
553
-						<ul>
554
-							<li>Defined in Types.ts:19</li>
555
-						</ul>
556
-					</aside>
557
-				</section>
558
-				<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module">
559
-					<a name="owner-1" class="tsd-anchor"></a>
560
-					<h3>Owner</h3>
561
-					<div class="tsd-signature tsd-kind-icon">Owner<span class="tsd-signature-symbol">:</span> <a href="_types_.html#name-2" class="tsd-signature-type">Name</a></div>
562
-					<aside class="tsd-sources">
563
-						<ul>
564
-							<li>Defined in Types.ts:7</li>
565
-						</ul>
566
-					</aside>
567
-				</section>
568
-				<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter">
569
-					<a name="rpc" class="tsd-anchor"></a>
570
-					<h3>RPC</h3>
571
-					<div class="tsd-signature tsd-kind-icon">RPC&lt;T&gt;<span class="tsd-signature-symbol">:</span> <a href="_types_.html#callrpc" class="tsd-signature-type">CallRPC</a><span class="tsd-signature-symbol"> | </span><a href="_types_.html#hookrpc" class="tsd-signature-type">HookRPC</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></div>
572
-					<aside class="tsd-sources">
573
-						<ul>
574
-							<li>Defined in Types.ts:41</li>
575
-						</ul>
576
-					</aside>
577
-					<h4 class="tsd-type-parameters-title">Type parameters</h4>
578
-					<ul class="tsd-type-parameters">
579
-						<li>
580
-							<h4>T</h4>
581
-						</li>
582
-					</ul>
583
-				</section>
584
-				<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module">
585
-					<a name="rpctype" class="tsd-anchor"></a>
586
-					<h3>RPCType</h3>
587
-					<div class="tsd-signature tsd-kind-icon">RPCType<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"Hook"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"Unhook"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"Call"</span></div>
588
-					<aside class="tsd-sources">
589
-						<ul>
590
-							<li>Defined in Types.ts:27</li>
591
-						</ul>
592
-					</aside>
593
-				</section>
594
-				<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module">
595
-					<a name="responsetype" class="tsd-anchor"></a>
596
-					<h3>Response<wbr>Type</h3>
597
-					<div class="tsd-signature tsd-kind-icon">Response<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"Subscribe"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"Success"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"Error"</span></div>
598
-					<aside class="tsd-sources">
599
-						<ul>
600
-							<li>Defined in Types.ts:18</li>
601
-						</ul>
602
-					</aside>
603
-				</section>
604
-				<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter">
605
-					<a name="respose" class="tsd-anchor"></a>
606
-					<h3>Respose</h3>
607
-					<div class="tsd-signature tsd-kind-icon">Respose&lt;T&gt;<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">T</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">object</span></div>
608
-					<aside class="tsd-sources">
609
-						<ul>
610
-							<li>Defined in Types.ts:22</li>
611
-						</ul>
612
-					</aside>
613
-					<h4 class="tsd-type-parameters-title">Type parameters</h4>
614
-					<ul class="tsd-type-parameters">
615
-						<li>
616
-							<h4>T</h4>
617
-						</li>
618
-					</ul>
619
-				</section>
620
-				<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module">
621
-					<a name="rpcinfo" class="tsd-anchor"></a>
622
-					<h3>Rpc<wbr>Info</h3>
623
-					<div class="tsd-signature tsd-kind-icon">Rpc<wbr>Info<span class="tsd-signature-symbol">:</span> <a href="_types_.html#hookinfo" class="tsd-signature-type">HookInfo</a><span class="tsd-signature-symbol"> | </span><a href="_types_.html#callinfo" class="tsd-signature-type">CallInfo</a></div>
624
-					<aside class="tsd-sources">
625
-						<ul>
626
-							<li>Defined in Types.ts:59</li>
627
-						</ul>
628
-					</aside>
629
-				</section>
630
-				<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module">
631
-					<a name="socketconf" class="tsd-anchor"></a>
632
-					<h3>Socket<wbr>Conf</h3>
633
-					<div class="tsd-signature tsd-kind-icon">Socket<wbr>Conf<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
634
-					<aside class="tsd-sources">
635
-						<ul>
636
-							<li>Defined in Types.ts:11</li>
637
-						</ul>
638
-					</aside>
639
-					<div class="tsd-type-declaration">
640
-						<h4>Type declaration</h4>
641
-						<ul class="tsd-parameters">
642
-							<li class="tsd-parameter">
643
-								<h5><span class="tsd-flag ts-flagOptional">Optional</span> close<wbr>Handler<span class="tsd-signature-symbol">?: </span><a href="_types_.html#closehandler" class="tsd-signature-type">CloseHandler</a></h5>
644
-							</li>
645
-							<li class="tsd-parameter">
646
-								<h5><span class="tsd-flag ts-flagOptional">Optional</span> connection<wbr>Handler<span class="tsd-signature-symbol">?: </span><a href="_types_.html#connectionhandler" class="tsd-signature-type">ConnectionHandler</a></h5>
647
-							</li>
648
-							<li class="tsd-parameter">
649
-								<h5><span class="tsd-flag ts-flagOptional">Optional</span> error<wbr>Handler<span class="tsd-signature-symbol">?: </span><a href="_types_.html#errorhandler" class="tsd-signature-type">ErrorHandler</a></h5>
650
-							</li>
651
-							<li class="tsd-parameter">
652
-								<h5><span class="tsd-flag ts-flagOptional">Optional</span> visibility<span class="tsd-signature-symbol">?: </span><a href="_types_.html#visibility-1" class="tsd-signature-type">Visibility</a></h5>
653
-							</li>
654
-						</ul>
655
-					</div>
656
-				</section>
657
-				<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter">
658
-					<a name="subscriptionresponse" class="tsd-anchor"></a>
659
-					<h3>Subscription<wbr>Response</h3>
660
-					<div class="tsd-signature tsd-kind-icon">Subscription<wbr>Response&lt;T&gt;<span class="tsd-signature-symbol">:</span> <a href="_types_.html#respose" class="tsd-signature-type">Respose</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">object</span></div>
661
-					<aside class="tsd-sources">
662
-						<ul>
663
-							<li>Defined in Types.ts:25</li>
664
-						</ul>
665
-					</aside>
666
-					<h4 class="tsd-type-parameters-title">Type parameters</h4>
667
-					<ul class="tsd-type-parameters">
668
-						<li>
669
-							<h4>T</h4>
670
-						</li>
671
-					</ul>
672
-				</section>
673
-				<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter">
674
-					<a name="successresponse" class="tsd-anchor"></a>
675
-					<h3>Success<wbr>Response</h3>
676
-					<div class="tsd-signature tsd-kind-icon">Success<wbr>Response&lt;T&gt;<span class="tsd-signature-symbol">:</span> <a href="_types_.html#respose" class="tsd-signature-type">Respose</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">object</span></div>
677
-					<aside class="tsd-sources">
678
-						<ul>
679
-							<li>Defined in Types.ts:23</li>
680
-						</ul>
681
-					</aside>
682
-					<h4 class="tsd-type-parameters-title">Type parameters</h4>
683
-					<ul class="tsd-type-parameters">
684
-						<li>
685
-							<h4>T</h4>
686
-						</li>
687
-					</ul>
688
-				</section>
689
-				<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module">
690
-					<a name="visibility-1" class="tsd-anchor"></a>
691
-					<h3>Visibility</h3>
692
-					<div class="tsd-signature tsd-kind-icon">Visibility<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"127.0.0.1"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"0.0.0.0"</span></div>
693
-					<aside class="tsd-sources">
694
-						<ul>
695
-							<li>Defined in Types.ts:3</li>
696
-						</ul>
697
-					</aside>
698
-				</section>
699
-			</section>
700
-		</div>
701
-		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
702
-			<nav class="tsd-navigation primary">
703
-				<ul>
704
-					<li class="globals  ">
705
-						<a href="../index.html"><em>Globals</em></a>
706
-					</li>
707
-					<li class=" tsd-kind-external-module">
708
-						<a href="_backend_.html">"<wbr>Backend"</a>
709
-					</li>
710
-					<li class=" tsd-kind-external-module">
711
-						<a href="_frontend_.html">"<wbr>Frontend"</a>
712
-					</li>
713
-					<li class=" tsd-kind-external-module">
714
-						<a href="_interfaces_.html">"<wbr>Interfaces"</a>
715
-					</li>
716
-					<li class="current tsd-kind-external-module">
717
-						<a href="_types_.html">"<wbr>Types"</a>
718
-					</li>
719
-					<li class=" tsd-kind-external-module">
720
-						<a href="_utils_.html">"<wbr>Utils"</a>
721
-					</li>
722
-				</ul>
723
-			</nav>
724
-			<nav class="tsd-navigation secondary menu-sticky">
725
-				<ul class="before-current">
726
-					<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
727
-						<a href="_types_.html#any" class="tsd-kind-icon">Any</a>
728
-					</li>
729
-					<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
730
-						<a href="_types_.html#arg" class="tsd-kind-icon">Arg</a>
731
-					</li>
732
-					<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
733
-						<a href="_types_.html#asyncfunction" class="tsd-kind-icon">Async<wbr>Function</a>
734
-					</li>
735
-					<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
736
-						<a href="_types_.html#baseinfo" class="tsd-kind-icon">Base<wbr>Info</a>
737
-					</li>
738
-					<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
739
-						<a href="_types_.html#callinfo" class="tsd-kind-icon">Call<wbr>Info</a>
740
-					</li>
741
-					<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
742
-						<a href="_types_.html#callrpc" class="tsd-kind-icon">CallRPC</a>
743
-					</li>
744
-					<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
745
-						<a href="_types_.html#callbackfunction" class="tsd-kind-icon">Callback<wbr>Function</a>
746
-					</li>
747
-					<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
748
-						<a href="_types_.html#closehandler" class="tsd-kind-icon">Close<wbr>Handler</a>
749
-					</li>
750
-					<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
751
-						<a href="_types_.html#connectionhandler" class="tsd-kind-icon">Connection<wbr>Handler</a>
752
-					</li>
753
-					<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
754
-						<a href="_types_.html#errorhandler" class="tsd-kind-icon">Error<wbr>Handler</a>
755
-					</li>
756
-					<li class=" tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter">
757
-						<a href="_types_.html#errorresponse" class="tsd-kind-icon">Error<wbr>Response</a>
758
-					</li>
759
-					<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
760
-						<a href="_types_.html#extendedrpcinfo" class="tsd-kind-icon">Extended<wbr>Rpc<wbr>Info</a>
761
-					</li>
762
-					<li class=" tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter">
763
-						<a href="_types_.html#hookclosefunction" class="tsd-kind-icon">Hook<wbr>Close<wbr>Function</a>
764
-					</li>
765
-					<li class=" tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter">
766
-						<a href="_types_.html#hookfunction" class="tsd-kind-icon">Hook<wbr>Function</a>
767
-					</li>
768
-					<li class=" tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter">
769
-						<a href="_types_.html#hookinfo" class="tsd-kind-icon">Hook<wbr>Info</a>
770
-					</li>
771
-					<li class=" tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter">
772
-						<a href="_types_.html#hookrpc" class="tsd-kind-icon">HookRPC</a>
773
-					</li>
774
-					<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
775
-						<a href="_types_.html#name-2" class="tsd-kind-icon">Name</a>
776
-					</li>
777
-					<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
778
-						<a href="_types_.html#onfunction" class="tsd-kind-icon">On<wbr>Function</a>
779
-					</li>
780
-					<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
781
-						<a href="_types_.html#outcome" class="tsd-kind-icon">Outcome</a>
782
-					</li>
783
-					<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
784
-						<a href="_types_.html#owner-1" class="tsd-kind-icon">Owner</a>
785
-					</li>
786
-					<li class=" tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter">
787
-						<a href="_types_.html#rpc" class="tsd-kind-icon">RPC</a>
788
-					</li>
789
-					<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
790
-						<a href="_types_.html#rpctype" class="tsd-kind-icon">RPCType</a>
791
-					</li>
792
-					<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
793
-						<a href="_types_.html#responsetype" class="tsd-kind-icon">Response<wbr>Type</a>
794
-					</li>
795
-					<li class=" tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter">
796
-						<a href="_types_.html#respose" class="tsd-kind-icon">Respose</a>
797
-					</li>
798
-					<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
799
-						<a href="_types_.html#rpcinfo" class="tsd-kind-icon">Rpc<wbr>Info</a>
800
-					</li>
801
-					<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
802
-						<a href="_types_.html#socketconf" class="tsd-kind-icon">Socket<wbr>Conf</a>
803
-					</li>
804
-					<li class=" tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter">
805
-						<a href="_types_.html#subscriptionresponse" class="tsd-kind-icon">Subscription<wbr>Response</a>
806
-					</li>
807
-					<li class=" tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter">
808
-						<a href="_types_.html#successresponse" class="tsd-kind-icon">Success<wbr>Response</a>
809
-					</li>
810
-					<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
811
-						<a href="_types_.html#visibility-1" class="tsd-kind-icon">Visibility</a>
812
-					</li>
813
-				</ul>
814
-			</nav>
815
-		</div>
816
-	</div>
817
-</div>
818
-<footer class="with-border-bottom">
819
-	<div class="container">
820
-		<h2>Legend</h2>
821
-		<div class="tsd-legend-group">
822
-			<ul class="tsd-legend">
823
-				<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
824
-				<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
825
-				<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
826
-				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
827
-				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
828
-				<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
829
-				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
830
-				<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
831
-			</ul>
832
-			<ul class="tsd-legend">
833
-				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
834
-				<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
835
-				<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
836
-				<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
837
-			</ul>
838
-			<ul class="tsd-legend">
839
-				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
840
-				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
841
-				<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
842
-				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
843
-				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
844
-				<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
845
-			</ul>
846
-			<ul class="tsd-legend">
847
-				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
848
-				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
849
-				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
850
-				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
851
-				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
852
-				<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
853
-				<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
854
-			</ul>
855
-			<ul class="tsd-legend">
856
-				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
857
-				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
858
-				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
859
-				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
860
-			</ul>
861
-			<ul class="tsd-legend">
862
-				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
863
-				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
864
-				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
865
-			</ul>
866
-			<ul class="tsd-legend">
867
-				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
868
-				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
869
-				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
870
-			</ul>
871
-			<ul class="tsd-legend">
872
-				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
873
-				<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
874
-			</ul>
875
-		</div>
876
-	</div>
877
-</footer>
878
-<div class="container tsd-generator">
879
-	<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
880
-</div>
881
-<div class="overlay"></div>
882
-<script src="../assets/js/main.js"></script>
883
-<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
884
-</body>
885
-</html>

+ 387
- 0
docs/modules/_types_.md View File

@@ -0,0 +1,387 @@
1
+[rpclibrary](../README.md) › ["Types"](_types_.md)
2
+
3
+# External module: "Types"
4
+
5
+## Index
6
+
7
+### Type aliases
8
+
9
+* [Any](_types_.md#any)
10
+* [Arg](_types_.md#arg)
11
+* [AsyncFunction](_types_.md#asyncfunction)
12
+* [BaseInfo](_types_.md#baseinfo)
13
+* [CallInfo](_types_.md#callinfo)
14
+* [CallRPC](_types_.md#callrpc)
15
+* [CallbackFunction](_types_.md#callbackfunction)
16
+* [CloseHandler](_types_.md#closehandler)
17
+* [ConnectionHandler](_types_.md#connectionhandler)
18
+* [ErrorHandler](_types_.md#errorhandler)
19
+* [ErrorResponse](_types_.md#errorresponse)
20
+* [ExtendedRpcInfo](_types_.md#extendedrpcinfo)
21
+* [HookCloseFunction](_types_.md#hookclosefunction)
22
+* [HookFunction](_types_.md#hookfunction)
23
+* [HookInfo](_types_.md#hookinfo)
24
+* [HookRPC](_types_.md#hookrpc)
25
+* [Name](_types_.md#name)
26
+* [OnFunction](_types_.md#onfunction)
27
+* [Outcome](_types_.md#outcome)
28
+* [Owner](_types_.md#owner)
29
+* [RPC](_types_.md#rpc)
30
+* [RPCType](_types_.md#rpctype)
31
+* [ResponseType](_types_.md#responsetype)
32
+* [Respose](_types_.md#respose)
33
+* [RpcInfo](_types_.md#rpcinfo)
34
+* [SocketConf](_types_.md#socketconf)
35
+* [SubscriptionResponse](_types_.md#subscriptionresponse)
36
+* [SuccessResponse](_types_.md#successresponse)
37
+* [Visibility](_types_.md#visibility)
38
+
39
+## Type aliases
40
+
41
+###  Any
42
+
43
+Ƭ **Any**: *any*
44
+
45
+Defined in Types.ts:4
46
+
47
+___
48
+
49
+###  Arg
50
+
51
+Ƭ **Arg**: *string*
52
+
53
+Defined in Types.ts:5
54
+
55
+___
56
+
57
+###  AsyncFunction
58
+
59
+Ƭ **AsyncFunction**: *function*
60
+
61
+Defined in Types.ts:65
62
+
63
+#### Type declaration:
64
+
65
+▸ (...`args`: any): *Promise‹any›*
66
+
67
+**Parameters:**
68
+
69
+Name | Type |
70
+------ | ------ |
71
+`...args` | any |
72
+
73
+___
74
+
75
+###  BaseInfo
76
+
77
+Ƭ **BaseInfo**: *object*
78
+
79
+Defined in Types.ts:43
80
+
81
+#### Type declaration:
82
+
83
+* **argNames**: *[Name](_types_.md#name)[]*
84
+
85
+* **name**: *[Name](_types_.md#name)*
86
+
87
+* **owner**: *[Name](_types_.md#name)*
88
+
89
+___
90
+
91
+###  CallInfo
92
+
93
+Ƭ **CallInfo**: *[BaseInfo](_types_.md#baseinfo) & object*
94
+
95
+Defined in Types.ts:54
96
+
97
+___
98
+
99
+###  CallRPC
100
+
101
+Ƭ **CallRPC**: *object | Function*
102
+
103
+Defined in Types.ts:36
104
+
105
+___
106
+
107
+###  CallbackFunction
108
+
109
+Ƭ **CallbackFunction**: *function*
110
+
111
+Defined in Types.ts:66
112
+
113
+#### Type declaration:
114
+
115
+▸ (...`args`: any): *void*
116
+
117
+**Parameters:**
118
+
119
+Name | Type |
120
+------ | ------ |
121
+`...args` | any |
122
+
123
+___
124
+
125
+###  CloseHandler
126
+
127
+Ƭ **CloseHandler**: *function*
128
+
129
+Defined in Types.ts:10
130
+
131
+#### Type declaration:
132
+
133
+▸ (`socket`: [Socket](../interfaces/_interfaces_.socket.md)): *void*
134
+
135
+**Parameters:**
136
+
137
+Name | Type |
138
+------ | ------ |
139
+`socket` | [Socket](../interfaces/_interfaces_.socket.md) |
140
+
141
+___
142
+
143
+###  ConnectionHandler
144
+
145
+Ƭ **ConnectionHandler**: *function*
146
+
147
+Defined in Types.ts:8
148
+
149
+#### Type declaration:
150
+
151
+▸ (`socket`: [Socket](../interfaces/_interfaces_.socket.md)): *void*
152
+
153
+**Parameters:**
154
+
155
+Name | Type |
156
+------ | ------ |
157
+`socket` | [Socket](../interfaces/_interfaces_.socket.md) |
158
+
159
+___
160
+
161
+###  ErrorHandler
162
+
163
+Ƭ **ErrorHandler**: *function*
164
+
165
+Defined in Types.ts:9
166
+
167
+#### Type declaration:
168
+
169
+▸ (`socket`: [Socket](../interfaces/_interfaces_.socket.md), `error`: any): *void*
170
+
171
+**Parameters:**
172
+
173
+Name | Type |
174
+------ | ------ |
175
+`socket` | [Socket](../interfaces/_interfaces_.socket.md) |
176
+`error` | any |
177
+
178
+___
179
+
180
+###  ErrorResponse
181
+
182
+Ƭ **ErrorResponse**: *[Respose](_types_.md#respose)‹T› & object*
183
+
184
+Defined in Types.ts:24
185
+
186
+___
187
+
188
+###  ExtendedRpcInfo
189
+
190
+Ƭ **ExtendedRpcInfo**: *[RpcInfo](_types_.md#rpcinfo) & object*
191
+
192
+Defined in Types.ts:60
193
+
194
+___
195
+
196
+###  HookCloseFunction
197
+
198
+Ƭ **HookCloseFunction**: *function*
199
+
200
+Defined in Types.ts:63
201
+
202
+#### Type declaration:
203
+
204
+▸ (`res`: [SubscriptionResponse](_types_.md#subscriptionresponse)‹T›, `rpc`: [HookRPC](_types_.md#hookrpc)‹T›): *any*
205
+
206
+**Parameters:**
207
+
208
+Name | Type |
209
+------ | ------ |
210
+`res` | [SubscriptionResponse](_types_.md#subscriptionresponse)‹T› |
211
+`rpc` | [HookRPC](_types_.md#hookrpc)‹T› |
212
+
213
+___
214
+
215
+###  HookFunction
216
+
217
+Ƭ **HookFunction**: *function*
218
+
219
+Defined in Types.ts:64
220
+
221
+#### Type declaration:
222
+
223
+▸ (...`args`: any): *Promise‹[SubscriptionResponse](_types_.md#subscriptionresponse)‹T› | [ErrorResponse](_types_.md#errorresponse)›*
224
+
225
+**Parameters:**
226
+
227
+Name | Type |
228
+------ | ------ |
229
+`...args` | any |
230
+
231
+___
232
+
233
+###  HookInfo
234
+
235
+Ƭ **HookInfo**: *[BaseInfo](_types_.md#baseinfo) & object*
236
+
237
+Defined in Types.ts:49
238
+
239
+___
240
+
241
+###  HookRPC
242
+
243
+Ƭ **HookRPC**: *object*
244
+
245
+Defined in Types.ts:29
246
+
247
+#### Type declaration:
248
+
249
+* **hook**: *[HookFunction](_types_.md#hookfunction)‹T›*
250
+
251
+* **name**: *[Name](_types_.md#name)*
252
+
253
+* **onCallback**? : *[CallbackFunction](_types_.md#callbackfunction)*
254
+
255
+* **onClose**? : *[HookCloseFunction](_types_.md#hookclosefunction)‹T›*
256
+
257
+___
258
+
259
+###  Name
260
+
261
+Ƭ **Name**: *[Arg](_types_.md#arg)*
262
+
263
+Defined in Types.ts:6
264
+
265
+___
266
+
267
+###  OnFunction
268
+
269
+Ƭ **OnFunction**: *function*
270
+
271
+Defined in Types.ts:62
272
+
273
+#### Type declaration:
274
+
275
+▸ (`type`: "error" | "close", `f`: function): *[Socket](../interfaces/_interfaces_.socket.md)*
276
+
277
+**Parameters:**
278
+
279
+▪ **type**: *"error" | "close"*
280
+
281
+▪ **f**: *function*
282
+
283
+▸ (`e?`: any): *void*
284
+
285
+**Parameters:**
286
+
287
+Name | Type |
288
+------ | ------ |
289
+`e?` | any |
290
+
291
+___
292
+
293
+###  Outcome
294
+
295
+Ƭ **Outcome**: *"Success" | "Error"*
296
+
297
+Defined in Types.ts:19
298
+
299
+___
300
+
301
+###  Owner
302
+
303
+Ƭ **Owner**: *[Name](_types_.md#name)*
304
+
305
+Defined in Types.ts:7
306
+
307
+___
308
+
309
+###  RPC
310
+
311
+Ƭ **RPC**: *[CallRPC](_types_.md#callrpc) | [HookRPC](_types_.md#hookrpc)‹T›*
312
+
313
+Defined in Types.ts:41
314
+
315
+___
316
+
317
+###  RPCType
318
+
319
+Ƭ **RPCType**: *"Hook" | "Unhook" | "Call"*
320
+
321
+Defined in Types.ts:27
322
+
323
+___
324
+
325
+###  ResponseType
326
+
327
+Ƭ **ResponseType**: *"Subscribe" | "Success" | "Error"*
328
+
329
+Defined in Types.ts:18
330
+
331
+___
332
+
333
+###  Respose
334
+
335
+Ƭ **Respose**: *T & object*
336
+
337
+Defined in Types.ts:22
338
+
339
+___
340
+
341
+###  RpcInfo
342
+
343
+Ƭ **RpcInfo**: *[HookInfo](_types_.md#hookinfo) | [CallInfo](_types_.md#callinfo)*
344
+
345
+Defined in Types.ts:59
346
+
347
+___
348
+
349
+###  SocketConf
350
+
351
+Ƭ **SocketConf**: *object*
352
+
353
+Defined in Types.ts:11
354
+
355
+#### Type declaration:
356
+
357
+* **closeHandler**? : *[CloseHandler](_types_.md#closehandler)*
358
+
359
+* **connectionHandler**? : *[ConnectionHandler](_types_.md#connectionhandler)*
360
+
361
+* **errorHandler**? : *[ErrorHandler](_types_.md#errorhandler)*
362
+
363
+* **visibility**? : *[Visibility](_types_.md#visibility)*
364
+
365
+___
366
+
367
+###  SubscriptionResponse
368
+
369
+Ƭ **SubscriptionResponse**: *[Respose](_types_.md#respose)‹T› & object*
370
+
371
+Defined in Types.ts:25
372
+
373
+___
374
+
375
+###  SuccessResponse
376
+
377
+Ƭ **SuccessResponse**: *[Respose](_types_.md#respose)‹T› & object*
378
+
379
+Defined in Types.ts:23
380
+
381
+___
382
+
383
+###  Visibility
384
+
385
+Ƭ **Visibility**: *"127.0.0.1" | "0.0.0.0"*
386
+
387
+Defined in Types.ts:3

+ 0
- 356
docs/modules/_utils_.html View File

@@ -1,356 +0,0 @@
1
-<!doctype html>
2
-<html class="default no-js">
3
-<head>
4
-	<meta charset="utf-8">
5
-	<meta http-equiv="X-UA-Compatible" content="IE=edge">
6
-	<title>&quot;Utils&quot; | rpclibrary</title>
7
-	<meta name="description" content="">
8
-	<meta name="viewport" content="width=device-width, initial-scale=1">
9
-	<link rel="stylesheet" href="../assets/css/main.css">
10
-</head>
11
-<body>
12
-<header>
13
-	<div class="tsd-page-toolbar">
14
-		<div class="container">
15
-			<div class="table-wrap">
16
-				<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
17
-					<div class="field">
18
-						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
19
-						<input id="tsd-search-field" type="text" />
20
-					</div>
21
-					<ul class="results">
22
-						<li class="state loading">Preparing search index...</li>
23
-						<li class="state failure">The search index is not available</li>
24
-					</ul>
25
-					<a href="../index.html" class="title">rpclibrary</a>
26
-				</div>
27
-				<div class="table-cell" id="tsd-widgets">
28
-					<div id="tsd-filter">
29
-						<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
30
-						<div class="tsd-filter-group">
31
-							<div class="tsd-select" id="tsd-filter-visibility">
32
-								<span class="tsd-select-label">All</span>
33
-								<ul class="tsd-select-list">
34
-									<li data-value="public">Public</li>
35
-									<li data-value="protected">Public/Protected</li>
36
-									<li data-value="private" class="selected">All</li>
37
-								</ul>
38
-							</div>
39
-							<input type="checkbox" id="tsd-filter-inherited" checked />
40
-							<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
41
-							<input type="checkbox" id="tsd-filter-externals" checked />
42
-							<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
43
-							<input type="checkbox" id="tsd-filter-only-exported" />
44
-							<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
45
-						</div>
46
-					</div>
47
-					<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
48
-				</div>
49
-			</div>
50
-		</div>
51
-	</div>
52
-	<div class="tsd-page-title">
53
-		<div class="container">
54
-			<ul class="tsd-breadcrumb">
55
-				<li>
56
-					<a href="../index.html">Globals</a>
57
-				</li>
58
-				<li>
59
-					<a href="_utils_.html">&quot;Utils&quot;</a>
60
-				</li>
61
-			</ul>
62
-			<h1>External module &quot;Utils&quot;</h1>
63
-		</div>
64
-	</div>
65
-</header>
66
-<div class="container container-main">
67
-	<div class="row">
68
-		<div class="col-8 col-content">
69
-			<section class="tsd-panel-group tsd-index-group">
70
-				<h2>Index</h2>
71
-				<section class="tsd-panel tsd-index-panel">
72
-					<div class="tsd-index-content">
73
-						<section class="tsd-index-section ">
74
-							<h3>Functions</h3>
75
-							<ul class="tsd-index-list">
76
-								<li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"><a href="_utils_.html#extractargs" class="tsd-kind-icon">extract<wbr>Args</a></li>
77
-								<li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"><a href="_utils_.html#hookgenerator" class="tsd-kind-icon">hook<wbr>Generator</a></li>
78
-								<li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_utils_.html#makesubresponse" class="tsd-kind-icon">make<wbr>Sub<wbr>Response</a></li>
79
-								<li class="tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter"><a href="_utils_.html#rpchooker" class="tsd-kind-icon">rpc<wbr>Hooker</a></li>
80
-								<li class="tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter"><a href="_utils_.html#rpctorpcinfo" class="tsd-kind-icon">rpc<wbr>ToRpcinfo</a></li>
81
-							</ul>
82
-						</section>
83
-					</div>
84
-				</section>
85
-			</section>
86
-			<section class="tsd-panel-group tsd-member-group ">
87
-				<h2>Functions</h2>
88
-				<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
89
-					<a name="extractargs" class="tsd-anchor"></a>
90
-					<h3><span class="tsd-flag ts-flagConst">Const</span> extract<wbr>Args</h3>
91
-					<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
92
-						<li class="tsd-signature tsd-kind-icon">extract<wbr>Args<span class="tsd-signature-symbol">(</span>f<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T.Arg</span><span class="tsd-signature-symbol">[]</span></li>
93
-					</ul>
94
-					<ul class="tsd-descriptions">
95
-						<li class="tsd-description">
96
-							<aside class="tsd-sources">
97
-								<ul>
98
-									<li>Defined in Utils.ts:91</li>
99
-								</ul>
100
-							</aside>
101
-							<h4 class="tsd-parameters-title">Parameters</h4>
102
-							<ul class="tsd-parameters">
103
-								<li>
104
-									<h5>f: <span class="tsd-signature-type">Function</span></h5>
105
-								</li>
106
-							</ul>
107
-							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T.Arg</span><span class="tsd-signature-symbol">[]</span></h4>
108
-						</li>
109
-					</ul>
110
-				</section>
111
-				<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
112
-					<a name="hookgenerator" class="tsd-anchor"></a>
113
-					<h3><span class="tsd-flag ts-flagConst">Const</span> hook<wbr>Generator</h3>
114
-					<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
115
-						<li class="tsd-signature tsd-kind-icon">hook<wbr>Generator<span class="tsd-signature-symbol">(</span>rpc<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T.HookRPC</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</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">function</span></li>
116
-					</ul>
117
-					<ul class="tsd-descriptions">
118
-						<li class="tsd-description">
119
-							<aside class="tsd-sources">
120
-								<ul>
121
-									<li>Defined in Utils.ts:70</li>
122
-								</ul>
123
-							</aside>
124
-							<h4 class="tsd-parameters-title">Parameters</h4>
125
-							<ul class="tsd-parameters">
126
-								<li>
127
-									<h5>rpc: <span class="tsd-signature-type">T.HookRPC</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h5>
128
-								</li>
129
-							</ul>
130
-							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">function</span></h4>
131
-							<ul class="tsd-parameters">
132
-								<li class="tsd-parameter-siganture">
133
-									<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
134
-										<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>socket<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">I.Socket</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_types_.html#hookfunction" class="tsd-signature-type">HookFunction</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></li>
135
-									</ul>
136
-									<ul class="tsd-descriptions">
137
-										<li class="tsd-description">
138
-											<h4 class="tsd-parameters-title">Parameters</h4>
139
-											<ul class="tsd-parameters">
140
-												<li>
141
-													<h5><span class="tsd-flag ts-flagOptional">Optional</span> socket: <span class="tsd-signature-type">I.Socket</span></h5>
142
-												</li>
143
-											</ul>
144
-											<h4 class="tsd-returns-title">Returns <a href="_types_.html#hookfunction" class="tsd-signature-type">HookFunction</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></h4>
145
-										</li>
146
-									</ul>
147
-								</li>
148
-							</ul>
149
-						</li>
150
-					</ul>
151
-				</section>
152
-				<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module">
153
-					<a name="makesubresponse" class="tsd-anchor"></a>
154
-					<h3>make<wbr>Sub<wbr>Response</h3>
155
-					<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module">
156
-						<li class="tsd-signature tsd-kind-icon">make<wbr>Sub<wbr>Response<span class="tsd-signature-symbol">(</span>uuid<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><span class="tsd-signature-symbol">: </span><a href="_types_.html#subscriptionresponse" class="tsd-signature-type">SubscriptionResponse</a></li>
157
-					</ul>
158
-					<ul class="tsd-descriptions">
159
-						<li class="tsd-description">
160
-							<aside class="tsd-sources">
161
-								<ul>
162
-									<li>Defined in Utils.ts:96</li>
163
-								</ul>
164
-							</aside>
165
-							<h4 class="tsd-parameters-title">Parameters</h4>
166
-							<ul class="tsd-parameters">
167
-								<li>
168
-									<h5><span class="tsd-flag ts-flagOptional">Optional</span> uuid: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
169
-								</li>
170
-							</ul>
171
-							<h4 class="tsd-returns-title">Returns <a href="_types_.html#subscriptionresponse" class="tsd-signature-type">SubscriptionResponse</a></h4>
172
-						</li>
173
-					</ul>
174
-				</section>
175
-				<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter">
176
-					<a name="rpchooker" class="tsd-anchor"></a>
177
-					<h3>rpc<wbr>Hooker</h3>
178
-					<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter">
179
-						<li class="tsd-signature tsd-kind-icon">rpc<wbr>Hooker&lt;SubResT&gt;<span class="tsd-signature-symbol">(</span>socket<span class="tsd-signature-symbol">: </span><a href="../interfaces/_interfaces_.socket.html" class="tsd-signature-type">Socket</a>, exporter<span class="tsd-signature-symbol">: </span><a href="../interfaces/_interfaces_.exporter.html" class="tsd-signature-type">Exporter</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">SubResT</span><span class="tsd-signature-symbol">&gt;</span>, makeUnique<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T.ExtendedRpcInfo</span><span class="tsd-signature-symbol">[]</span></li>
180
-					</ul>
181
-					<ul class="tsd-descriptions">
182
-						<li class="tsd-description">
183
-							<aside class="tsd-sources">
184
-								<ul>
185
-									<li>Defined in Utils.ts:48</li>
186
-								</ul>
187
-							</aside>
188
-							<h4 class="tsd-type-parameters-title">Type parameters</h4>
189
-							<ul class="tsd-type-parameters">
190
-								<li>
191
-									<h4>SubResT</h4>
192
-								</li>
193
-							</ul>
194
-							<h4 class="tsd-parameters-title">Parameters</h4>
195
-							<ul class="tsd-parameters">
196
-								<li>
197
-									<h5>socket: <a href="../interfaces/_interfaces_.socket.html" class="tsd-signature-type">Socket</a></h5>
198
-								</li>
199
-								<li>
200
-									<h5>exporter: <a href="../interfaces/_interfaces_.exporter.html" class="tsd-signature-type">Exporter</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">SubResT</span><span class="tsd-signature-symbol">&gt;</span></h5>
201
-								</li>
202
-								<li>
203
-									<h5><span class="tsd-flag ts-flagDefault value">Default value</span> makeUnique: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> =&nbsp;true</span></h5>
204
-								</li>
205
-							</ul>
206
-							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T.ExtendedRpcInfo</span><span class="tsd-signature-symbol">[]</span></h4>
207
-						</li>
208
-					</ul>
209
-				</section>
210
-				<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter">
211
-					<a name="rpctorpcinfo" class="tsd-anchor"></a>
212
-					<h3><span class="tsd-flag ts-flagConst">Const</span> rpc<wbr>ToRpcinfo</h3>
213
-					<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter">
214
-						<li class="tsd-signature tsd-kind-icon">rpc<wbr>ToRpcinfo&lt;SubResT&gt;<span class="tsd-signature-symbol">(</span>rpc<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T.RPC</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">SubResT</span><span class="tsd-signature-symbol">&gt;</span>, owner<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T.Owner</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T.RpcInfo</span></li>
215
-					</ul>
216
-					<ul class="tsd-descriptions">
217
-						<li class="tsd-description">
218
-							<aside class="tsd-sources">
219
-								<ul>
220
-									<li>Defined in Utils.ts:8</li>
221
-								</ul>
222
-							</aside>
223
-							<h4 class="tsd-type-parameters-title">Type parameters</h4>
224
-							<ul class="tsd-type-parameters">
225
-								<li>
226
-									<h4>SubResT</h4>
227
-								</li>
228
-							</ul>
229
-							<h4 class="tsd-parameters-title">Parameters</h4>
230
-							<ul class="tsd-parameters">
231
-								<li>
232
-									<h5>rpc: <span class="tsd-signature-type">T.RPC</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">SubResT</span><span class="tsd-signature-symbol">&gt;</span></h5>
233
-								</li>
234
-								<li>
235
-									<h5>owner: <span class="tsd-signature-type">T.Owner</span></h5>
236
-								</li>
237
-							</ul>
238
-							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T.RpcInfo</span></h4>
239
-						</li>
240
-					</ul>
241
-				</section>
242
-			</section>
243
-		</div>
244
-		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
245
-			<nav class="tsd-navigation primary">
246
-				<ul>
247
-					<li class="globals  ">
248
-						<a href="../index.html"><em>Globals</em></a>
249
-					</li>
250
-					<li class=" tsd-kind-external-module">
251
-						<a href="_backend_.html">"<wbr>Backend"</a>
252
-					</li>
253
-					<li class=" tsd-kind-external-module">
254
-						<a href="_frontend_.html">"<wbr>Frontend"</a>
255
-					</li>
256
-					<li class=" tsd-kind-external-module">
257
-						<a href="_interfaces_.html">"<wbr>Interfaces"</a>
258
-					</li>
259
-					<li class=" tsd-kind-external-module">
260
-						<a href="_types_.html">"<wbr>Types"</a>
261
-					</li>
262
-					<li class="current tsd-kind-external-module">
263
-						<a href="_utils_.html">"<wbr>Utils"</a>
264
-					</li>
265
-				</ul>
266
-			</nav>
267
-			<nav class="tsd-navigation secondary menu-sticky">
268
-				<ul class="before-current">
269
-					<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
270
-						<a href="_utils_.html#extractargs" class="tsd-kind-icon">extract<wbr>Args</a>
271
-					</li>
272
-					<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
273
-						<a href="_utils_.html#hookgenerator" class="tsd-kind-icon">hook<wbr>Generator</a>
274
-					</li>
275
-					<li class=" tsd-kind-function tsd-parent-kind-external-module">
276
-						<a href="_utils_.html#makesubresponse" class="tsd-kind-icon">make<wbr>Sub<wbr>Response</a>
277
-					</li>
278
-					<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter">
279
-						<a href="_utils_.html#rpchooker" class="tsd-kind-icon">rpc<wbr>Hooker</a>
280
-					</li>
281
-					<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter">
282
-						<a href="_utils_.html#rpctorpcinfo" class="tsd-kind-icon">rpc<wbr>ToRpcinfo</a>
283
-					</li>
284
-				</ul>
285
-			</nav>
286
-		</div>
287
-	</div>
288
-</div>
289
-<footer class="with-border-bottom">
290
-	<div class="container">
291
-		<h2>Legend</h2>
292
-		<div class="tsd-legend-group">
293
-			<ul class="tsd-legend">
294
-				<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
295
-				<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
296
-				<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
297
-				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
298
-				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
299
-				<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
300
-				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
301
-				<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
302
-			</ul>
303
-			<ul class="tsd-legend">
304
-				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
305
-				<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
306
-				<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
307
-				<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
308
-			</ul>
309
-			<ul class="tsd-legend">
310
-				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
311
-				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
312
-				<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
313
-				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
314
-				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
315
-				<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
316
-			</ul>
317
-			<ul class="tsd-legend">
318
-				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
319
-				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
320
-				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
321
-				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
322
-				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
323
-				<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
324
-				<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
325
-			</ul>
326
-			<ul class="tsd-legend">
327
-				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
328
-				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
329
-				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
330
-				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
331
-			</ul>
332
-			<ul class="tsd-legend">
333
-				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
334
-				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
335
-				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
336
-			</ul>
337
-			<ul class="tsd-legend">
338
-				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
339
-				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
340
-				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
341
-			</ul>
342
-			<ul class="tsd-legend">
343
-				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
344
-				<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
345
-			</ul>
346
-		</div>
347
-	</div>
348
-</footer>
349
-<div class="container tsd-generator">
350
-	<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
351
-</div>
352
-<div class="overlay"></div>
353
-<script src="../assets/js/main.js"></script>
354
-<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
355
-</body>
356
-</html>

+ 112
- 0
docs/modules/_utils_.md View File

@@ -0,0 +1,112 @@
1
+[rpclibrary](../README.md) › ["Utils"](_utils_.md)
2
+
3
+# External module: "Utils"
4
+
5
+## Index
6
+
7
+### Functions
8
+
9
+* [extractArgs](_utils_.md#const-extractargs)
10
+* [hookGenerator](_utils_.md#const-hookgenerator)
11
+* [makeSubResponse](_utils_.md#makesubresponse)
12
+* [rpcHooker](_utils_.md#rpchooker)
13
+* [rpcToRpcinfo](_utils_.md#const-rpctorpcinfo)
14
+
15
+## Functions
16
+
17
+### `Const` extractArgs
18
+
19
+▸ **extractArgs**(`f`: Function): *T.Arg[]*
20
+
21
+Defined in Utils.ts:91
22
+
23
+**Parameters:**
24
+
25
+Name | Type |
26
+------ | ------ |
27
+`f` | Function |
28
+
29
+**Returns:** *T.Arg[]*
30
+
31
+___
32
+
33
+### `Const` hookGenerator
34
+
35
+▸ **hookGenerator**(`rpc`: T.HookRPC‹any›): *function*
36
+
37
+Defined in Utils.ts:70
38
+
39
+**Parameters:**
40
+
41
+Name | Type |
42
+------ | ------ |
43
+`rpc` | T.HookRPC‹any› |
44
+
45
+**Returns:** *function*
46
+
47
+▸ (`socket?`: I.Socket): *[HookFunction](_types_.md#hookfunction)‹T›*
48
+
49
+**Parameters:**
50
+
51
+Name | Type |
52
+------ | ------ |
53
+`socket?` | I.Socket |
54
+
55
+___
56
+
57
+###  makeSubResponse
58
+
59
+▸ **makeSubResponse**(`uuid?`: undefined | string): *[SubscriptionResponse](_types_.md#subscriptionresponse)*
60
+
61
+Defined in Utils.ts:96
62
+
63
+**Parameters:**
64
+
65
+Name | Type |
66
+------ | ------ |
67
+`uuid?` | undefined &#124; string |
68
+
69
+**Returns:** *[SubscriptionResponse](_types_.md#subscriptionresponse)*
70
+
71
+___
72
+
73
+###  rpcHooker
74
+
75
+▸ **rpcHooker**<**SubResT**>(`socket`: [Socket](../interfaces/_interfaces_.socket.md), `exporter`: [Exporter](../interfaces/_interfaces_.exporter.md)‹SubResT›, `makeUnique`: boolean): *T.ExtendedRpcInfo[]*
76
+
77
+Defined in Utils.ts:48
78
+
79
+**Type parameters:**
80
+
81
+▪ **SubResT**
82
+
83
+**Parameters:**
84
+
85
+Name | Type | Default |
86
+------ | ------ | ------ |
87
+`socket` | [Socket](../interfaces/_interfaces_.socket.md) | - |
88
+`exporter` | [Exporter](../interfaces/_interfaces_.exporter.md)‹SubResT› | - |
89
+`makeUnique` | boolean | true |
90
+
91
+**Returns:** *T.ExtendedRpcInfo[]*
92
+
93
+___
94
+
95
+### `Const` rpcToRpcinfo
96
+
97
+▸ **rpcToRpcinfo**<**SubResT**>(`rpc`: T.RPC‹SubResT›, `owner`: T.Owner): *T.RpcInfo*
98
+
99
+Defined in Utils.ts:8
100
+
101
+**Type parameters:**
102
+
103
+▪ **SubResT**
104
+
105
+**Parameters:**
106
+
107
+Name | Type |
108
+------ | ------ |
109
+`rpc` | T.RPC‹SubResT› |
110
+`owner` | T.Owner |
111
+
112
+**Returns:** *T.RpcInfo*

+ 10
- 1
package-lock.json View File

@@ -1,6 +1,6 @@
1 1
 {
2 2
   "name": "rpclibrary",
3
-  "version": "1.1.2",
3
+  "version": "1.1.3",
4 4
   "lockfileVersion": 1,
5 5
   "requires": true,
6 6
   "dependencies": {
@@ -4704,6 +4704,15 @@
4704 4704
         "underscore": "^1.9.1"
4705 4705
       }
4706 4706
     },
4707
+    "typedoc-plugin-markdown": {
4708
+      "version": "2.2.6",
4709
+      "resolved": "https://registry.npmjs.org/typedoc-plugin-markdown/-/typedoc-plugin-markdown-2.2.6.tgz",
4710
+      "integrity": "sha512-1c6Vml1WIlUclLP/NX0Fq8UnQ9K9mak8o9J5P7g4kx3SzPsC1vY4/1rQPffKo1YYbRwU7qWBiM1J9vSEHoYSRQ==",
4711
+      "dev": true,
4712
+      "requires": {
4713
+        "fs-extra": "^8.1.0"
4714
+      }
4715
+    },
4707 4716
     "typescript": {
4708 4717
       "version": "3.6.3",
4709 4718
       "resolved": "https://registry.npmjs.org/typescript/-/typescript-3.6.3.tgz",

+ 2
- 1
package.json View File

@@ -11,7 +11,7 @@
11 11
     "build": "npm run clean && tsc && npm run webpack",
12 12
     "clean": "rm -rf js",
13 13
     "test": "mocha js/test/Test.js",
14
-    "doc": "typedoc --out docs ./src --readme none"
14
+    "doc": "typedoc --out docs ./src --readme none --plugin typedoc-plugin-markdown "
15 15
   },
16 16
   "author": "",
17 17
   "license": "ISC",
@@ -26,6 +26,7 @@
26 26
     "ts-loader": "^5.3.3",
27 27
     "ts-mocha": "^6.0.0",
28 28
     "typedoc": "^0.15.0",
29
+    "typedoc-plugin-markdown": "^2.2.6",
29 30
     "typescript": "^3.5.3",
30 31
     "webpack": "^4.40.2",
31 32
     "webpack-cli": "^3.3.9"

+ 11
- 1
test/Test.ts View File

@@ -5,6 +5,7 @@ import * as uuidv4 from "uuid/v4"
5 5
 import { RPCSocket } from "../src/Frontend";
6 6
 import { SubscriptionResponse } from "../src/Types";
7 7
 
8
+const add = (...args:number[]) => {return args.reduce((a,b)=>a+b, 0)}
8 9
 function makeServer(){
9 10
     let subcallback
10 11
     return new RPCServer<{ topic: string }>(20000, [{
@@ -41,7 +42,7 @@ function makeServer(){
41 42
                     console.log("onCallback", args[0] === "test" && args[1] === "callback"?"OK":"")                    
42 43
                 }
43 44
             },
44
-            function add(...args:number[]):number {return args.reduce((a,b)=>a+b, 0)},
45
+            add,
45 46
             function triggerCallback(...messages:any[]):number {return subcallback.apply({}, messages)},
46 47
         ]
47 48
     }],{
@@ -105,6 +106,15 @@ describe('RPCSocket', () => {
105 106
         })
106 107
     })
107 108
 
109
+    it('should add up to 6', (done) => {
110
+        client['test'].add(1,2,3).then(x => {
111
+            if(x === 6)
112
+                done()
113
+            else
114
+                done(new Error('echo RPC response did not match'))   
115
+        })
116
+    })
117
+
108 118
     it('should subscribe with success', (done) => {
109 119
         client['test'].simpleSubscribe(console.log).then(res => {
110 120
             if(res.result === 'Success'){

Loading…
Cancel
Save