Skip to content

Commit 2a0e0f5

Browse files
nuclearacenuclearace
committed
Update and gen docs
1 parent 888b84a commit 2a0e0f5

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+84
-84
lines changed

‎README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ socket.connect()
3232
```
3333

3434
## Features
35-
- Supports socket.io 3.0+ (For socket.io 1.0 use v9.x, For socket.io 2.0 use 15.x)
35+
- Supports socket.io 2.0+/3.0+.
3636
- Supports Binary
3737
- Supports Polling and WebSockets
3838
- Supports TLS/SSL

‎docs/12to13.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
<header class="header">
2121
<p class="header-col header-col--primary">
2222
<a class="header-link" href="index.html">
23-
SocketIO 16.0.0-beta2 Docs
23+
SocketIO 16.0.0 Docs
2424
</a>
2525
(100% documented)
2626
</p>
@@ -327,7 +327,7 @@ <h2 id='what-to-call-connect-on' class='heading'>What to call connect on</h2>
327327
</article>
328328
</div>
329329
<section class="footer">
330-
<p>&copy; 2021 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2021-01-27)</p>
330+
<p>&copy; 2021 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2021-02-01)</p>
331331
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
332332
</section>
333333
</body>

‎docs/15to16.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
<header class="header">
2121
<p class="header-col header-col--primary">
2222
<a class="header-link" href="index.html">
23-
SocketIO 16.0.0-beta2 Docs
23+
SocketIO 16.0.0 Docs
2424
</a>
2525
(100% documented)
2626
</p>
@@ -247,7 +247,7 @@ <h2 id='client-supports-multiple-socket-io-versions' class='heading'>Client supp
247247
</article>
248248
</div>
249249
<section class="footer">
250-
<p>&copy; 2021 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2021-01-27)</p>
250+
<p>&copy; 2021 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2021-02-01)</p>
251251
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
252252
</section>
253253
</body>

‎docs/Classes.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
<header class="header">
2222
<p class="header-col header-col--primary">
2323
<a class="header-link" href="index.html">
24-
SocketIO 16.0.0-beta2 Docs
24+
SocketIO 16.0.0 Docs
2525
</a>
2626
(100% documented)
2727
</p>
@@ -518,7 +518,7 @@ <h4>Declaration</h4>
518518
</article>
519519
</div>
520520
<section class="footer">
521-
<p>&copy; 2021 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2021-01-27)</p>
521+
<p>&copy; 2021 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2021-02-01)</p>
522522
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
523523
</section>
524524
</body>

‎docs/Classes/OnAckCallback.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
<header class="header">
2222
<p class="header-col header-col--primary">
2323
<a class="header-link" href="../index.html">
24-
SocketIO 16.0.0-beta2 Docs
24+
SocketIO 16.0.0 Docs
2525
</a>
2626
(100% documented)
2727
</p>
@@ -329,7 +329,7 @@ <h4>Parameters</h4>
329329
</article>
330330
</div>
331331
<section class="footer">
332-
<p>&copy; 2021 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2021-01-27)</p>
332+
<p>&copy; 2021 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2021-02-01)</p>
333333
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
334334
</section>
335335
</body>

‎docs/Classes/SocketAckEmitter.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
<header class="header">
2222
<p class="header-col header-col--primary">
2323
<a class="header-link" href="../index.html">
24-
SocketIO 16.0.0-beta2 Docs
24+
SocketIO 16.0.0 Docs
2525
</a>
2626
(100% documented)
2727
</p>
@@ -510,7 +510,7 @@ <h4>Parameters</h4>
510510
</article>
511511
</div>
512512
<section class="footer">
513-
<p>&copy; 2021 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2021-01-27)</p>
513+
<p>&copy; 2021 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2021-02-01)</p>
514514
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
515515
</section>
516516
</body>

‎docs/Classes/SocketAnyEvent.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
<header class="header">
2222
<p class="header-col header-col--primary">
2323
<a class="header-link" href="../index.html">
24-
SocketIO 16.0.0-beta2 Docs
24+
SocketIO 16.0.0 Docs
2525
</a>
2626
(100% documented)
2727
</p>
@@ -346,7 +346,7 @@ <h4>Declaration</h4>
346346
</article>
347347
</div>
348348
<section class="footer">
349-
<p>&copy; 2021 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2021-01-27)</p>
349+
<p>&copy; 2021 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2021-02-01)</p>
350350
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
351351
</section>
352352
</body>

‎docs/Classes/SocketEngine.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
<header class="header">
2222
<p class="header-col header-col--primary">
2323
<a class="header-link" href="../index.html">
24-
SocketIO 16.0.0-beta2 Docs
24+
SocketIO 16.0.0 Docs
2525
</a>
2626
(100% documented)
2727
</p>
@@ -1632,7 +1632,7 @@ <h4>Parameters</h4>
16321632
</article>
16331633
</div>
16341634
<section class="footer">
1635-
<p>&copy; 2021 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2021-01-27)</p>
1635+
<p>&copy; 2021 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2021-02-01)</p>
16361636
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
16371637
</section>
16381638
</body>

‎docs/Classes/SocketIOClient.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
<header class="header">
2222
<p class="header-col header-col--primary">
2323
<a class="header-link" href="../index.html">
24-
SocketIO 16.0.0-beta2 Docs
24+
SocketIO 16.0.0 Docs
2525
</a>
2626
(100% documented)
2727
</p>
@@ -1848,7 +1848,7 @@ <h4>Parameters</h4>
18481848
</article>
18491849
</div>
18501850
<section class="footer">
1851-
<p>&copy; 2021 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2021-01-27)</p>
1851+
<p>&copy; 2021 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2021-02-01)</p>
18521852
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
18531853
</section>
18541854
</body>

‎docs/Classes/SocketManager.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
<header class="header">
2222
<p class="header-col header-col--primary">
2323
<a class="header-link" href="../index.html">
24-
SocketIO 16.0.0-beta2 Docs
24+
SocketIO 16.0.0 Docs
2525
</a>
2626
(100% documented)
2727
</p>
@@ -1730,7 +1730,7 @@ <h4>Return Value</h4>
17301730
</article>
17311731
</div>
17321732
<section class="footer">
1733-
<p>&copy; 2021 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2021-01-27)</p>
1733+
<p>&copy; 2021 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2021-02-01)</p>
17341734
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
17351735
</section>
17361736
</body>

‎docs/Classes/SocketRawAckView.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
<header class="header">
2222
<p class="header-col header-col--primary">
2323
<a class="header-link" href="../index.html">
24-
SocketIO 16.0.0-beta2 Docs
24+
SocketIO 16.0.0 Docs
2525
</a>
2626
(100% documented)
2727
</p>
@@ -354,7 +354,7 @@ <h4>Parameters</h4>
354354
</article>
355355
</div>
356356
<section class="footer">
357-
<p>&copy; 2021 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2021-01-27)</p>
357+
<p>&copy; 2021 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2021-02-01)</p>
358358
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
359359
</section>
360360
</body>

‎docs/Classes/SocketRawView.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
<header class="header">
2222
<p class="header-col header-col--primary">
2323
<a class="header-link" href="../index.html">
24-
SocketIO 16.0.0-beta2 Docs
24+
SocketIO 16.0.0 Docs
2525
</a>
2626
(100% documented)
2727
</p>
@@ -524,7 +524,7 @@ <h4>Return Value</h4>
524524
</article>
525525
</div>
526526
<section class="footer">
527-
<p>&copy; 2021 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2021-01-27)</p>
527+
<p>&copy; 2021 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2021-02-01)</p>
528528
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
529529
</section>
530530
</body>

‎docs/Enums.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
<header class="header">
2222
<p class="header-col header-col--primary">
2323
<a class="header-link" href="index.html">
24-
SocketIO 16.0.0-beta2 Docs
24+
SocketIO 16.0.0 Docs
2525
</a>
2626
(100% documented)
2727
</p>
@@ -445,7 +445,7 @@ <h4>Declaration</h4>
445445
</article>
446446
</div>
447447
<section class="footer">
448-
<p>&copy; 2021 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2021-01-27)</p>
448+
<p>&copy; 2021 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2021-02-01)</p>
449449
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
450450
</section>
451451
</body>

‎docs/Enums/SocketAckStatus.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
<header class="header">
2222
<p class="header-col header-col--primary">
2323
<a class="header-link" href="../index.html">
24-
SocketIO 16.0.0-beta2 Docs
24+
SocketIO 16.0.0 Docs
2525
</a>
2626
(100% documented)
2727
</p>
@@ -344,7 +344,7 @@ <h4>Declaration</h4>
344344
</article>
345345
</div>
346346
<section class="footer">
347-
<p>&copy; 2021 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2021-01-27)</p>
347+
<p>&copy; 2021 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2021-02-01)</p>
348348
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
349349
</section>
350350
</body>

‎docs/Enums/SocketClientEvent.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
<header class="header">
2222
<p class="header-col header-col--primary">
2323
<a class="header-link" href="../index.html">
24-
SocketIO 16.0.0-beta2 Docs
24+
SocketIO 16.0.0 Docs
2525
</a>
2626
(100% documented)
2727
</p>
@@ -564,7 +564,7 @@ <h4>Declaration</h4>
564564
</article>
565565
</div>
566566
<section class="footer">
567-
<p>&copy; 2021 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2021-01-27)</p>
567+
<p>&copy; 2021 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2021-02-01)</p>
568568
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
569569
</section>
570570
</body>

‎docs/Enums/SocketEnginePacketType.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
<header class="header">
2222
<p class="header-col header-col--primary">
2323
<a class="header-link" href="../index.html">
24-
SocketIO 16.0.0-beta2 Docs
24+
SocketIO 16.0.0 Docs
2525
</a>
2626
(100% documented)
2727
</p>
@@ -444,7 +444,7 @@ <h4>Declaration</h4>
444444
</article>
445445
</div>
446446
<section class="footer">
447-
<p>&copy; 2021 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2021-01-27)</p>
447+
<p>&copy; 2021 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2021-02-01)</p>
448448
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
449449
</section>
450450
</body>

‎docs/Enums/SocketIOClientOption.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
<header class="header">
2222
<p class="header-col header-col--primary">
2323
<a class="header-link" href="../index.html">
24-
SocketIO 16.0.0-beta2 Docs
24+
SocketIO 16.0.0 Docs
2525
</a>
2626
(100% documented)
2727
</p>
@@ -968,7 +968,7 @@ <h4>Return Value</h4>
968968
</article>
969969
</div>
970970
<section class="footer">
971-
<p>&copy; 2021 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2021-01-27)</p>
971+
<p>&copy; 2021 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2021-02-01)</p>
972972
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
973973
</section>
974974
</body>

‎docs/Enums/SocketIOStatus.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
<header class="header">
2222
<p class="header-col header-col--primary">
2323
<a class="header-link" href="../index.html">
24-
SocketIO 16.0.0-beta2 Docs
24+
SocketIO 16.0.0 Docs
2525
</a>
2626
(100% documented)
2727
</p>
@@ -441,7 +441,7 @@ <h4>Declaration</h4>
441441
</article>
442442
</div>
443443
<section class="footer">
444-
<p>&copy; 2021 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2021-01-27)</p>
444+
<p>&copy; 2021 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2021-02-01)</p>
445445
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
446446
</section>
447447
</body>

‎docs/Enums/SocketIOVersion.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
<header class="header">
2222
<p class="header-col header-col--primary">
2323
<a class="header-link" href="../index.html">
24-
SocketIO 16.0.0-beta2 Docs
24+
SocketIO 16.0.0 Docs
2525
</a>
2626
(100% documented)
2727
</p>
@@ -308,7 +308,7 @@ <h4>Declaration</h4>
308308
</article>
309309
</div>
310310
<section class="footer">
311-
<p>&copy; 2021 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2021-01-27)</p>
311+
<p>&copy; 2021 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2021-02-01)</p>
312312
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
313313
</section>
314314
</body>

‎docs/Enums/SocketParsableError.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
<header class="header">
2222
<p class="header-col header-col--primary">
2323
<a class="header-link" href="../index.html">
24-
SocketIO 16.0.0-beta2 Docs
24+
SocketIO 16.0.0 Docs
2525
</a>
2626
(100% documented)
2727
</p>
@@ -344,7 +344,7 @@ <h4>Declaration</h4>
344344
</article>
345345
</div>
346346
<section class="footer">
347-
<p>&copy; 2021 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2021-01-27)</p>
347+
<p>&copy; 2021 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2021-02-01)</p>
348348
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
349349
</section>
350350
</body>

0 commit comments

Comments
 (0)