Skip to content

Commit 05225db

Browse files
jscriptcoderjscriptcoder
committed
docs: updated readme and docs
1 parent 2b0a1b6 commit 05225db

18 files changed

+213
-102
lines changed

‎docs/classes/commander.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ <h3>constructor</h3>
125125
<li class="tsd-description">
126126
<aside class="tsd-sources">
127127
<ul>
128-
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/8d8246c/src/Commander.ts#L30">src/Commander.ts:30</a></li>
128+
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/2b0a1b6/src/Commander.ts#L30">src/Commander.ts:30</a></li>
129129
</ul>
130130
</aside>
131131
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -147,7 +147,7 @@ <h3>instance<wbr>Id</h3>
147147
<div class="tsd-signature tsd-kind-icon">instance<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;&quot;</span></div>
148148
<aside class="tsd-sources">
149149
<ul>
150-
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/8d8246c/src/Commander.ts#L30">src/Commander.ts:30</a></li>
150+
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/2b0a1b6/src/Commander.ts#L30">src/Commander.ts:30</a></li>
151151
</ul>
152152
</aside>
153153
<div class="tsd-comment tsd-typography">
@@ -169,7 +169,7 @@ <h3>make</h3>
169169
<li class="tsd-description">
170170
<aside class="tsd-sources">
171171
<ul>
172-
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/8d8246c/src/Commander.ts#L42">src/Commander.ts:42</a></li>
172+
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/2b0a1b6/src/Commander.ts#L42">src/Commander.ts:42</a></li>
173173
</ul>
174174
</aside>
175175
<div class="tsd-comment tsd-typography">

‎docs/classes/connectfailed.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ <h3>constructor</h3>
125125
<li class="tsd-description">
126126
<aside class="tsd-sources">
127127
<ul>
128-
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/8d8246c/src/errors.ts#L11">src/errors.ts:11</a></li>
128+
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/2b0a1b6/src/errors.ts#L11">src/errors.ts:11</a></li>
129129
</ul>
130130
</aside>
131131
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -159,7 +159,7 @@ <h3>name</h3>
159159
<aside class="tsd-sources">
160160
<p>Overrides Error.name</p>
161161
<ul>
162-
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/8d8246c/src/errors.ts#L11">src/errors.ts:11</a></li>
162+
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/2b0a1b6/src/errors.ts#L11">src/errors.ts:11</a></li>
163163
</ul>
164164
</aside>
165165
</section>

‎docs/classes/connectionclosed.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ <h3>constructor</h3>
125125
<li class="tsd-description">
126126
<aside class="tsd-sources">
127127
<ul>
128-
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/8d8246c/src/errors.ts#L33">src/errors.ts:33</a></li>
128+
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/2b0a1b6/src/errors.ts#L33">src/errors.ts:33</a></li>
129129
</ul>
130130
</aside>
131131
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -159,7 +159,7 @@ <h3>name</h3>
159159
<aside class="tsd-sources">
160160
<p>Overrides Error.name</p>
161161
<ul>
162-
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/8d8246c/src/errors.ts#L33">src/errors.ts:33</a></li>
162+
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/2b0a1b6/src/errors.ts#L33">src/errors.ts:33</a></li>
163163
</ul>
164164
</aside>
165165
</section>

‎docs/classes/connectionerror.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ <h3>constructor</h3>
125125
<li class="tsd-description">
126126
<aside class="tsd-sources">
127127
<ul>
128-
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/8d8246c/src/errors.ts#L44">src/errors.ts:44</a></li>
128+
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/2b0a1b6/src/errors.ts#L44">src/errors.ts:44</a></li>
129129
</ul>
130130
</aside>
131131
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -159,7 +159,7 @@ <h3>name</h3>
159159
<aside class="tsd-sources">
160160
<p>Overrides Error.name</p>
161161
<ul>
162-
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/8d8246c/src/errors.ts#L44">src/errors.ts:44</a></li>
162+
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/2b0a1b6/src/errors.ts#L44">src/errors.ts:44</a></li>
163163
</ul>
164164
</aside>
165165
</section>

‎docs/classes/deferred.html

+4-4
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ <h3>constructor</h3>
133133
<li class="tsd-description">
134134
<aside class="tsd-sources">
135135
<ul>
136-
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/8d8246c/src/Deferred.ts#L30">src/Deferred.ts:30</a></li>
136+
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/2b0a1b6/src/Deferred.ts#L30">src/Deferred.ts:30</a></li>
137137
</ul>
138138
</aside>
139139
<h4 class="tsd-returns-title">Returns <a href="deferred.html" class="tsd-signature-type">Deferred</a></h4>
@@ -149,7 +149,7 @@ <h3>promise</h3>
149149
<div class="tsd-signature tsd-kind-icon">promise<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</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = null</span></div>
150150
<aside class="tsd-sources">
151151
<ul>
152-
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/8d8246c/src/Deferred.ts#L30">src/Deferred.ts:30</a></li>
152+
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/2b0a1b6/src/Deferred.ts#L30">src/Deferred.ts:30</a></li>
153153
</ul>
154154
</aside>
155155
</section>
@@ -159,7 +159,7 @@ <h3>reject</h3>
159159
<div class="tsd-signature tsd-kind-icon">reject<span class="tsd-signature-symbol">:</span> <a href="../globals.html#promisereject" class="tsd-signature-type">PromiseReject</a><span class="tsd-signature-symbol"> = null</span></div>
160160
<aside class="tsd-sources">
161161
<ul>
162-
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/8d8246c/src/Deferred.ts#L29">src/Deferred.ts:29</a></li>
162+
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/2b0a1b6/src/Deferred.ts#L29">src/Deferred.ts:29</a></li>
163163
</ul>
164164
</aside>
165165
<div class="tsd-comment tsd-typography">
@@ -179,7 +179,7 @@ <h3>resolve</h3>
179179
<div class="tsd-signature tsd-kind-icon">resolve<span class="tsd-signature-symbol">:</span> <a href="../globals.html#promiseresolve" class="tsd-signature-type">PromiseResolve</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"> = null</span></div>
180180
<aside class="tsd-sources">
181181
<ul>
182-
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/8d8246c/src/Deferred.ts#L23">src/Deferred.ts:23</a></li>
182+
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/2b0a1b6/src/Deferred.ts#L23">src/Deferred.ts:23</a></li>
183183
</ul>
184184
</aside>
185185
<div class="tsd-comment tsd-typography">

‎docs/classes/env.html

+9-9
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ <h3>constructor</h3>
145145
<li class="tsd-description">
146146
<aside class="tsd-sources">
147147
<ul>
148-
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/8d8246c/src/Env.ts#L110">src/Env.ts:110</a></li>
148+
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/2b0a1b6/src/Env.ts#L110">src/Env.ts:110</a></li>
149149
</ul>
150150
</aside>
151151
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -170,7 +170,7 @@ <h3>commander</h3>
170170
<div class="tsd-signature tsd-kind-icon">commander<span class="tsd-signature-symbol">:</span> <a href="commander.html" class="tsd-signature-type">Commander</a><span class="tsd-signature-symbol"> = null</span></div>
171171
<aside class="tsd-sources">
172172
<ul>
173-
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/8d8246c/src/Env.ts#L109">src/Env.ts:109</a></li>
173+
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/2b0a1b6/src/Env.ts#L109">src/Env.ts:109</a></li>
174174
</ul>
175175
</aside>
176176
</section>
@@ -180,7 +180,7 @@ <h3>requester</h3>
180180
<div class="tsd-signature tsd-kind-icon">requester<span class="tsd-signature-symbol">:</span> <a href="requester.html" class="tsd-signature-type">Requester</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/command.html" class="tsd-signature-type">Command</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = null</span></div>
181181
<aside class="tsd-sources">
182182
<ul>
183-
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/8d8246c/src/Env.ts#L110">src/Env.ts:110</a></li>
183+
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/2b0a1b6/src/Env.ts#L110">src/Env.ts:110</a></li>
184184
</ul>
185185
</aside>
186186
</section>
@@ -197,7 +197,7 @@ <h3>action<wbr>Sample</h3>
197197
<li class="tsd-description">
198198
<aside class="tsd-sources">
199199
<ul>
200-
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/8d8246c/src/Env.ts#L182">src/Env.ts:182</a></li>
200+
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/2b0a1b6/src/Env.ts#L182">src/Env.ts:182</a></li>
201201
</ul>
202202
</aside>
203203
<div class="tsd-comment tsd-typography">
@@ -225,7 +225,7 @@ <h3>action<wbr>Space</h3>
225225
<li class="tsd-description">
226226
<aside class="tsd-sources">
227227
<ul>
228-
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/8d8246c/src/Env.ts#L168">src/Env.ts:168</a></li>
228+
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/2b0a1b6/src/Env.ts#L168">src/Env.ts:168</a></li>
229229
</ul>
230230
</aside>
231231
<div class="tsd-comment tsd-typography">
@@ -253,7 +253,7 @@ <h3>close</h3>
253253
<li class="tsd-description">
254254
<aside class="tsd-sources">
255255
<ul>
256-
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/8d8246c/src/Env.ts#L196">src/Env.ts:196</a></li>
256+
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/2b0a1b6/src/Env.ts#L196">src/Env.ts:196</a></li>
257257
</ul>
258258
</aside>
259259
<div class="tsd-comment tsd-typography">
@@ -281,7 +281,7 @@ <h3>observation<wbr>Space</h3>
281281
<li class="tsd-description">
282282
<aside class="tsd-sources">
283283
<ul>
284-
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/8d8246c/src/Env.ts#L154">src/Env.ts:154</a></li>
284+
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/2b0a1b6/src/Env.ts#L154">src/Env.ts:154</a></li>
285285
</ul>
286286
</aside>
287287
<div class="tsd-comment tsd-typography">
@@ -309,7 +309,7 @@ <h3>reset</h3>
309309
<li class="tsd-description">
310310
<aside class="tsd-sources">
311311
<ul>
312-
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/8d8246c/src/Env.ts#L140">src/Env.ts:140</a></li>
312+
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/2b0a1b6/src/Env.ts#L140">src/Env.ts:140</a></li>
313313
</ul>
314314
</aside>
315315
<div class="tsd-comment tsd-typography">
@@ -337,7 +337,7 @@ <h3>step</h3>
337337
<li class="tsd-description">
338338
<aside class="tsd-sources">
339339
<ul>
340-
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/8d8246c/src/Env.ts#L126">src/Env.ts:126</a></li>
340+
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/2b0a1b6/src/Env.ts#L126">src/Env.ts:126</a></li>
341341
</ul>
342342
</aside>
343343
<div class="tsd-comment tsd-typography">

‎docs/classes/gymie.html

+11-11
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ <h3>constructor</h3>
129129
<li class="tsd-description">
130130
<aside class="tsd-sources">
131131
<ul>
132-
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/8d8246c/src/Gymie.ts#L73">src/Gymie.ts:73</a></li>
132+
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/2b0a1b6/src/Gymie.ts#L73">src/Gymie.ts:73</a></li>
133133
</ul>
134134
</aside>
135135
<h4 class="tsd-returns-title">Returns <a href="gymie.html" class="tsd-signature-type">Gymie</a></h4>
@@ -145,7 +145,7 @@ <h3>requester</h3>
145145
<div class="tsd-signature tsd-kind-icon">requester<span class="tsd-signature-symbol">:</span> <a href="requester.html" class="tsd-signature-type">Requester</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/command.html" class="tsd-signature-type">Command</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></div>
146146
<aside class="tsd-sources">
147147
<ul>
148-
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/8d8246c/src/Gymie.ts#L27">src/Gymie.ts:27</a></li>
148+
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/2b0a1b6/src/Gymie.ts#L27">src/Gymie.ts:27</a></li>
149149
</ul>
150150
</aside>
151151
</section>
@@ -155,7 +155,7 @@ <h3>ws<wbr>Client</h3>
155155
<div class="tsd-signature tsd-kind-icon">ws<wbr>Client<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">WebSocketClient</span><span class="tsd-signature-symbol"> = null</span></div>
156156
<aside class="tsd-sources">
157157
<ul>
158-
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/8d8246c/src/Gymie.ts#L28">src/Gymie.ts:28</a></li>
158+
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/2b0a1b6/src/Gymie.ts#L28">src/Gymie.ts:28</a></li>
159159
</ul>
160160
</aside>
161161
</section>
@@ -165,7 +165,7 @@ <h3>ws<wbr>Conn</h3>
165165
<div class="tsd-signature tsd-kind-icon">ws<wbr>Conn<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">connection</span><span class="tsd-signature-symbol"> = null</span></div>
166166
<aside class="tsd-sources">
167167
<ul>
168-
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/8d8246c/src/Gymie.ts#L29">src/Gymie.ts:29</a></li>
168+
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/2b0a1b6/src/Gymie.ts#L29">src/Gymie.ts:29</a></li>
169169
</ul>
170170
</aside>
171171
</section>
@@ -182,7 +182,7 @@ <h3>close</h3>
182182
<li class="tsd-description">
183183
<aside class="tsd-sources">
184184
<ul>
185-
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/8d8246c/src/Gymie.ts#L147">src/Gymie.ts:147</a></li>
185+
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/2b0a1b6/src/Gymie.ts#L147">src/Gymie.ts:147</a></li>
186186
</ul>
187187
</aside>
188188
<div class="tsd-comment tsd-typography">
@@ -218,7 +218,7 @@ <h3>connect</h3>
218218
<li class="tsd-description">
219219
<aside class="tsd-sources">
220220
<ul>
221-
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/8d8246c/src/Gymie.ts#L93">src/Gymie.ts:93</a></li>
221+
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/2b0a1b6/src/Gymie.ts#L93">src/Gymie.ts:93</a></li>
222222
</ul>
223223
</aside>
224224
<div class="tsd-comment tsd-typography">
@@ -261,7 +261,7 @@ <h3>make</h3>
261261
<li class="tsd-description">
262262
<aside class="tsd-sources">
263263
<ul>
264-
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/8d8246c/src/Gymie.ts#L126">src/Gymie.ts:126</a></li>
264+
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/2b0a1b6/src/Gymie.ts#L126">src/Gymie.ts:126</a></li>
265265
</ul>
266266
</aside>
267267
<div class="tsd-comment tsd-typography">
@@ -313,7 +313,7 @@ <h3>on<wbr>Close</h3>
313313
<li class="tsd-description">
314314
<aside class="tsd-sources">
315315
<ul>
316-
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/8d8246c/src/Gymie.ts#L68">src/Gymie.ts:68</a></li>
316+
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/2b0a1b6/src/Gymie.ts#L68">src/Gymie.ts:68</a></li>
317317
</ul>
318318
</aside>
319319
<div class="tsd-comment tsd-typography">
@@ -362,7 +362,7 @@ <h3>on<wbr>Error</h3>
362362
<li class="tsd-description">
363363
<aside class="tsd-sources">
364364
<ul>
365-
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/8d8246c/src/Gymie.ts#L54">src/Gymie.ts:54</a></li>
365+
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/2b0a1b6/src/Gymie.ts#L54">src/Gymie.ts:54</a></li>
366366
</ul>
367367
</aside>
368368
<div class="tsd-comment tsd-typography">
@@ -396,7 +396,7 @@ <h3>on<wbr>Message</h3>
396396
<li class="tsd-description">
397397
<aside class="tsd-sources">
398398
<ul>
399-
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/8d8246c/src/Gymie.ts#L45">src/Gymie.ts:45</a></li>
399+
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/2b0a1b6/src/Gymie.ts#L45">src/Gymie.ts:45</a></li>
400400
</ul>
401401
</aside>
402402
<div class="tsd-comment tsd-typography">
@@ -430,7 +430,7 @@ <h3>sender</h3>
430430
<li class="tsd-description">
431431
<aside class="tsd-sources">
432432
<ul>
433-
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/8d8246c/src/Gymie.ts#L36">src/Gymie.ts:36</a></li>
433+
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/2b0a1b6/src/Gymie.ts#L36">src/Gymie.ts:36</a></li>
434434
</ul>
435435
</aside>
436436
<div class="tsd-comment tsd-typography">

‎docs/classes/noconnected.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ <h3>constructor</h3>
121121
<li class="tsd-description">
122122
<aside class="tsd-sources">
123123
<ul>
124-
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/8d8246c/src/errors.ts#L22">src/errors.ts:22</a></li>
124+
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/2b0a1b6/src/errors.ts#L22">src/errors.ts:22</a></li>
125125
</ul>
126126
</aside>
127127
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -155,7 +155,7 @@ <h3>name</h3>
155155
<aside class="tsd-sources">
156156
<p>Overrides Error.name</p>
157157
<ul>
158-
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/8d8246c/src/errors.ts#L22">src/errors.ts:22</a></li>
158+
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/2b0a1b6/src/errors.ts#L22">src/errors.ts:22</a></li>
159159
</ul>
160160
</aside>
161161
</section>

0 commit comments

Comments
 (0)