Skip to content

Commit a5dcf10

Browse files
committed
chore: updating docs and added some logos
1 parent 55c7242 commit a5dcf10

23 files changed

+135
-76
lines changed

docs/classes/commander.html

Lines changed: 3 additions & 3 deletions
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/109e8b9/src/Commander.ts#L30">src/Commander.ts:30</a></li>
128+
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/55c7242/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/109e8b9/src/Commander.ts#L30">src/Commander.ts:30</a></li>
150+
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/55c7242/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/109e8b9/src/Commander.ts#L42">src/Commander.ts:42</a></li>
172+
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/55c7242/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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ <h1>Class ConnectFailed</h1>
7373
</div>
7474
<dl class="tsd-comment-tags">
7575
<dt>see</dt>
76-
<dd><p><a href="https://github.com/theturtle32/WebSocket-Node/blob/master/docs/WebSocketClient.md#connectfailed" class="external">WebSocketClient.onConnectionFailed</a></p>
76+
<dd><p><a href="https://bit.ly/2TcFJcv" class="external">WebSocketClient.onConnectionFailed</a></p>
7777
</dd>
7878
</dl>
7979
</div>
@@ -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/109e8b9/src/errors.ts#L11">src/errors.ts:11</a></li>
128+
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/55c7242/src/errors.ts#L12">src/errors.ts:12</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/109e8b9/src/errors.ts#L11">src/errors.ts:11</a></li>
162+
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/55c7242/src/errors.ts#L12">src/errors.ts:12</a></li>
163163
</ul>
164164
</aside>
165165
</section>

docs/classes/connectionclosed.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ <h1>Class ConnectionClosed</h1>
7373
</div>
7474
<dl class="tsd-comment-tags">
7575
<dt>see</dt>
76-
<dd><p><a href="https://github.com/theturtle32/WebSocket-Node/blob/master/docs/WebSocketConnection.md#closereasoncode-description" class="external">WebSocketConnection.onClose</a></p>
76+
<dd><p><a href="https://bit.ly/3kiSePP" class="external">WebSocketConnection.onClose</a></p>
7777
</dd>
7878
</dl>
7979
</div>
@@ -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/109e8b9/src/errors.ts#L33">src/errors.ts:33</a></li>
128+
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/55c7242/src/errors.ts#L34">src/errors.ts:34</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/109e8b9/src/errors.ts#L33">src/errors.ts:33</a></li>
162+
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/55c7242/src/errors.ts#L34">src/errors.ts:34</a></li>
163163
</ul>
164164
</aside>
165165
</section>

docs/classes/connectionerror.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ <h1>Class ConnectionError</h1>
7373
</div>
7474
<dl class="tsd-comment-tags">
7575
<dt>see</dt>
76-
<dd><p><a href="https://github.com/theturtle32/WebSocket-Node/blob/master/docs/WebSocketConnection.md#error" class="external">WebSocketConnection.onError</a></p>
76+
<dd><p><a href="https://bit.ly/31v9Wbw" class="external">WebSocketConnection.onError</a></p>
7777
</dd>
7878
</dl>
7979
</div>
@@ -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/109e8b9/src/errors.ts#L44">src/errors.ts:44</a></li>
128+
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/55c7242/src/errors.ts#L45">src/errors.ts:45</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/109e8b9/src/errors.ts#L44">src/errors.ts:44</a></li>
162+
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/55c7242/src/errors.ts#L45">src/errors.ts:45</a></li>
163163
</ul>
164164
</aside>
165165
</section>

docs/classes/deferred.html

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ <h1>Class Deferred&lt;T&gt;</h1>
7474
</div>
7575
<dl class="tsd-comment-tags">
7676
<dt>see</dt>
77-
<dd><p><a href="https://developer.mozilla.org/en-US/docs/Mozilla/JavaScript_code_modules/Promise.jsm/Deferred" class="external">Deferred object</a></p>
77+
<dd><p><a href="https://mzl.la/34i6vXn" class="external">Deferred object</a></p>
7878
</dd>
7979
</dl>
8080
</div>
@@ -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/109e8b9/src/Deferred.ts#L30">src/Deferred.ts:30</a></li>
136+
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/55c7242/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/109e8b9/src/Deferred.ts#L30">src/Deferred.ts:30</a></li>
152+
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/55c7242/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/109e8b9/src/Deferred.ts#L29">src/Deferred.ts:29</a></li>
162+
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/55c7242/src/Deferred.ts#L29">src/Deferred.ts:29</a></li>
163163
</ul>
164164
</aside>
165165
<div class="tsd-comment tsd-typography">
@@ -168,7 +168,7 @@ <h3>reject</h3>
168168
</div>
169169
<dl class="tsd-comment-tags">
170170
<dt>see</dt>
171-
<dd><p><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/reject" class="external">Promise.reject()</a></p>
171+
<dd><p><a href="https://mzl.la/2TbqLDw" class="external">Promise.reject()</a></p>
172172
</dd>
173173
</dl>
174174
</div>
@@ -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/109e8b9/src/Deferred.ts#L23">src/Deferred.ts:23</a></li>
182+
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/55c7242/src/Deferred.ts#L23">src/Deferred.ts:23</a></li>
183183
</ul>
184184
</aside>
185185
<div class="tsd-comment tsd-typography">
@@ -188,7 +188,7 @@ <h3>resolve</h3>
188188
</div>
189189
<dl class="tsd-comment-tags">
190190
<dt>see</dt>
191-
<dd><p><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/resolve" class="external">Promise.resolve()</a></p>
191+
<dd><p><a href="https://mzl.la/3johZwY" class="external">Promise.resolve()</a></p>
192192
</dd>
193193
</dl>
194194
</div>

docs/classes/env.html

Lines changed: 9 additions & 9 deletions
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/109e8b9/src/Env.ts#L110">src/Env.ts:110</a></li>
148+
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/55c7242/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/109e8b9/src/Env.ts#L109">src/Env.ts:109</a></li>
173+
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/55c7242/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/109e8b9/src/Env.ts#L110">src/Env.ts:110</a></li>
183+
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/55c7242/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/109e8b9/src/Env.ts#L182">src/Env.ts:182</a></li>
200+
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/55c7242/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/109e8b9/src/Env.ts#L168">src/Env.ts:168</a></li>
228+
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/55c7242/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/109e8b9/src/Env.ts#L196">src/Env.ts:196</a></li>
256+
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/55c7242/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/109e8b9/src/Env.ts#L154">src/Env.ts:154</a></li>
284+
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/55c7242/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/109e8b9/src/Env.ts#L140">src/Env.ts:140</a></li>
312+
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/55c7242/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/109e8b9/src/Env.ts#L126">src/Env.ts:126</a></li>
340+
<li>Defined in <a href="https://github.com/jscriptcoder/Gymie-Client/blob/55c7242/src/Env.ts#L126">src/Env.ts:126</a></li>
341341
</ul>
342342
</aside>
343343
<div class="tsd-comment tsd-typography">

0 commit comments

Comments
 (0)