Skip to content

Commit 662c045

Browse files
committed
docs: regenerate doc
1 parent ac9197a commit 662c045

File tree

74 files changed

+2580
-1527
lines changed

Some content is hidden

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

74 files changed

+2580
-1527
lines changed

docs/ast/source/BotFacade.js.json

+1,327-1,327
Large diffs are not rendered by default.

docs/ast/source/index.common.doc.js.json

+52-52
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"type": "File",
33
"start": 0,
4-
"end": 5547,
4+
"end": 5523,
55
"loc": {
66
"start": {
77
"line": 1,
@@ -15,7 +15,7 @@
1515
"program": {
1616
"type": "Program",
1717
"start": 0,
18-
"end": 5547,
18+
"end": 5523,
1919
"loc": {
2020
"start": {
2121
"line": 1,
@@ -3796,9 +3796,9 @@
37963796
},
37973797
{
37983798
"type": "CommentBlock",
3799-
"value": "*\n * The options to be passed into {@link Bot} constructor.\n * @typedef {Object} BotOptions\n * @property {Topology} [topology] See WebGroupOptions.topology\n * @property {string} [signalingServer] See WebGroupOptions.signalingServer\n * @property {RTCConfiguration} [rtcConfiguration] See WebGroupOptions.rtcConfiguration\n * @property {boolean} [autoRejoin] See WebGroupOptions.autoRejoin\n * @property {Object} bot Server related options of the bot.\n * @property {NodeJSHttpServer|NodeJSHttpsServer} bot.server NodeJS http(s) server.\n * @property {string} [bot.url] Bot server URL.\n * @property {boolean} [bot.perMessageDeflate] Enable/disable permessage-deflate.\n * @property {boolean} [bot.leaveOnceAlone] If true, bot will live (disconnect from the signaling server) if no other peers left in the group.\n ",
3799+
"value": "*\n * The options to be passed into {@link Bot} constructor.\n * @typedef {Object} BotOptions\n * @property {Topology} [topology] See WebGroupOptions.topology\n * @property {string} [signalingServer] See WebGroupOptions.signalingServer\n * @property {RTCConfiguration} [rtcConfiguration] See WebGroupOptions.rtcConfiguration\n * @property {boolean} [autoRejoin] See WebGroupOptions.autoRejoin\n * @property {Object} bot Server related options of the bot.\n * @property {HttpServer|HttpsServer} bot.server NodeJS http(s) server.\n * @property {string} [bot.url] Bot server URL.\n * @property {boolean} [bot.perMessageDeflate] Enable/disable permessage-deflate.\n * @property {boolean} [bot.leaveOnceAlone] If true, bot will live (disconnect from the signaling server) if no other peers left in the group.\n ",
38003800
"start": 4314,
3801-
"end": 5124,
3801+
"end": 5112,
38023802
"loc": {
38033803
"start": {
38043804
"line": 158,
@@ -3813,8 +3813,8 @@
38133813
{
38143814
"type": "CommentBlock",
38153815
"value": "*\n * @external {RTCConfiguration} https://developer.mozilla.org/en/docs/Web/API/RTCConfiguration\n ",
3816-
"start": 5125,
3817-
"end": 5227,
3816+
"start": 5113,
3817+
"end": 5215,
38183818
"loc": {
38193819
"start": {
38203820
"line": 171,
@@ -3829,8 +3829,8 @@
38293829
{
38303830
"type": "CommentBlock",
38313831
"value": "*\n * @external {Uint8Array} https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array\n ",
3832-
"start": 5228,
3833-
"end": 5350,
3832+
"start": 5216,
3833+
"end": 5338,
38343834
"loc": {
38353835
"start": {
38363836
"line": 174,
@@ -3844,9 +3844,9 @@
38443844
},
38453845
{
38463846
"type": "CommentBlock",
3847-
"value": "*\n * @external {NodeJSHttpServer} https://nodejs.org/api/http.html#http_class_http_server\n ",
3848-
"start": 5351,
3849-
"end": 5446,
3847+
"value": "*\n * @external {HttpServer} https://nodejs.org/api/http.html#http_class_http_server\n ",
3848+
"start": 5339,
3849+
"end": 5428,
38503850
"loc": {
38513851
"start": {
38523852
"line": 177,
@@ -3860,9 +3860,9 @@
38603860
},
38613861
{
38623862
"type": "CommentBlock",
3863-
"value": "*\n * @external {NodeJSHttpsServer} https://nodejs.org/api/https.html#https_class_https_server\n ",
3864-
"start": 5447,
3865-
"end": 5546,
3863+
"value": "*\n * @external {HttpsServer} https://nodejs.org/api/https.html#https_class_https_server\n ",
3864+
"start": 5429,
3865+
"end": 5522,
38663866
"loc": {
38673867
"start": {
38683868
"line": 180,
@@ -3913,9 +3913,9 @@
39133913
},
39143914
{
39153915
"type": "CommentBlock",
3916-
"value": "*\n * The options to be passed into {@link Bot} constructor.\n * @typedef {Object} BotOptions\n * @property {Topology} [topology] See WebGroupOptions.topology\n * @property {string} [signalingServer] See WebGroupOptions.signalingServer\n * @property {RTCConfiguration} [rtcConfiguration] See WebGroupOptions.rtcConfiguration\n * @property {boolean} [autoRejoin] See WebGroupOptions.autoRejoin\n * @property {Object} bot Server related options of the bot.\n * @property {NodeJSHttpServer|NodeJSHttpsServer} bot.server NodeJS http(s) server.\n * @property {string} [bot.url] Bot server URL.\n * @property {boolean} [bot.perMessageDeflate] Enable/disable permessage-deflate.\n * @property {boolean} [bot.leaveOnceAlone] If true, bot will live (disconnect from the signaling server) if no other peers left in the group.\n ",
3916+
"value": "*\n * The options to be passed into {@link Bot} constructor.\n * @typedef {Object} BotOptions\n * @property {Topology} [topology] See WebGroupOptions.topology\n * @property {string} [signalingServer] See WebGroupOptions.signalingServer\n * @property {RTCConfiguration} [rtcConfiguration] See WebGroupOptions.rtcConfiguration\n * @property {boolean} [autoRejoin] See WebGroupOptions.autoRejoin\n * @property {Object} bot Server related options of the bot.\n * @property {HttpServer|HttpsServer} bot.server NodeJS http(s) server.\n * @property {string} [bot.url] Bot server URL.\n * @property {boolean} [bot.perMessageDeflate] Enable/disable permessage-deflate.\n * @property {boolean} [bot.leaveOnceAlone] If true, bot will live (disconnect from the signaling server) if no other peers left in the group.\n ",
39173917
"start": 4314,
3918-
"end": 5124,
3918+
"end": 5112,
39193919
"loc": {
39203920
"start": {
39213921
"line": 158,
@@ -3930,8 +3930,8 @@
39303930
{
39313931
"type": "CommentBlock",
39323932
"value": "*\n * @external {RTCConfiguration} https://developer.mozilla.org/en/docs/Web/API/RTCConfiguration\n ",
3933-
"start": 5125,
3934-
"end": 5227,
3933+
"start": 5113,
3934+
"end": 5215,
39353935
"loc": {
39363936
"start": {
39373937
"line": 171,
@@ -3946,8 +3946,8 @@
39463946
{
39473947
"type": "CommentBlock",
39483948
"value": "*\n * @external {Uint8Array} https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array\n ",
3949-
"start": 5228,
3950-
"end": 5350,
3949+
"start": 5216,
3950+
"end": 5338,
39513951
"loc": {
39523952
"start": {
39533953
"line": 174,
@@ -3961,9 +3961,9 @@
39613961
},
39623962
{
39633963
"type": "CommentBlock",
3964-
"value": "*\n * @external {NodeJSHttpServer} https://nodejs.org/api/http.html#http_class_http_server\n ",
3965-
"start": 5351,
3966-
"end": 5446,
3964+
"value": "*\n * @external {HttpServer} https://nodejs.org/api/http.html#http_class_http_server\n ",
3965+
"start": 5339,
3966+
"end": 5428,
39673967
"loc": {
39683968
"start": {
39693969
"line": 177,
@@ -3977,9 +3977,9 @@
39773977
},
39783978
{
39793979
"type": "CommentBlock",
3980-
"value": "*\n * @external {NodeJSHttpsServer} https://nodejs.org/api/https.html#https_class_https_server\n ",
3981-
"start": 5447,
3982-
"end": 5546,
3980+
"value": "*\n * @external {HttpsServer} https://nodejs.org/api/https.html#https_class_https_server\n ",
3981+
"start": 5429,
3982+
"end": 5522,
39833983
"loc": {
39843984
"start": {
39853985
"line": 180,
@@ -4351,9 +4351,9 @@
43514351
},
43524352
{
43534353
"type": "CommentBlock",
4354-
"value": "*\n * The options to be passed into {@link Bot} constructor.\n * @typedef {Object} BotOptions\n * @property {Topology} [topology] See WebGroupOptions.topology\n * @property {string} [signalingServer] See WebGroupOptions.signalingServer\n * @property {RTCConfiguration} [rtcConfiguration] See WebGroupOptions.rtcConfiguration\n * @property {boolean} [autoRejoin] See WebGroupOptions.autoRejoin\n * @property {Object} bot Server related options of the bot.\n * @property {NodeJSHttpServer|NodeJSHttpsServer} bot.server NodeJS http(s) server.\n * @property {string} [bot.url] Bot server URL.\n * @property {boolean} [bot.perMessageDeflate] Enable/disable permessage-deflate.\n * @property {boolean} [bot.leaveOnceAlone] If true, bot will live (disconnect from the signaling server) if no other peers left in the group.\n ",
4354+
"value": "*\n * The options to be passed into {@link Bot} constructor.\n * @typedef {Object} BotOptions\n * @property {Topology} [topology] See WebGroupOptions.topology\n * @property {string} [signalingServer] See WebGroupOptions.signalingServer\n * @property {RTCConfiguration} [rtcConfiguration] See WebGroupOptions.rtcConfiguration\n * @property {boolean} [autoRejoin] See WebGroupOptions.autoRejoin\n * @property {Object} bot Server related options of the bot.\n * @property {HttpServer|HttpsServer} bot.server NodeJS http(s) server.\n * @property {string} [bot.url] Bot server URL.\n * @property {boolean} [bot.perMessageDeflate] Enable/disable permessage-deflate.\n * @property {boolean} [bot.leaveOnceAlone] If true, bot will live (disconnect from the signaling server) if no other peers left in the group.\n ",
43554355
"start": 4314,
4356-
"end": 5124,
4356+
"end": 5112,
43574357
"loc": {
43584358
"start": {
43594359
"line": 158,
@@ -4368,8 +4368,8 @@
43684368
{
43694369
"type": "CommentBlock",
43704370
"value": "*\n * @external {RTCConfiguration} https://developer.mozilla.org/en/docs/Web/API/RTCConfiguration\n ",
4371-
"start": 5125,
4372-
"end": 5227,
4371+
"start": 5113,
4372+
"end": 5215,
43734373
"loc": {
43744374
"start": {
43754375
"line": 171,
@@ -4384,8 +4384,8 @@
43844384
{
43854385
"type": "CommentBlock",
43864386
"value": "*\n * @external {Uint8Array} https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array\n ",
4387-
"start": 5228,
4388-
"end": 5350,
4387+
"start": 5216,
4388+
"end": 5338,
43894389
"loc": {
43904390
"start": {
43914391
"line": 174,
@@ -4399,9 +4399,9 @@
43994399
},
44004400
{
44014401
"type": "CommentBlock",
4402-
"value": "*\n * @external {NodeJSHttpServer} https://nodejs.org/api/http.html#http_class_http_server\n ",
4403-
"start": 5351,
4404-
"end": 5446,
4402+
"value": "*\n * @external {HttpServer} https://nodejs.org/api/http.html#http_class_http_server\n ",
4403+
"start": 5339,
4404+
"end": 5428,
44054405
"loc": {
44064406
"start": {
44074407
"line": 177,
@@ -4415,9 +4415,9 @@
44154415
},
44164416
{
44174417
"type": "CommentBlock",
4418-
"value": "*\n * @external {NodeJSHttpsServer} https://nodejs.org/api/https.html#https_class_https_server\n ",
4419-
"start": 5447,
4420-
"end": 5546,
4418+
"value": "*\n * @external {HttpsServer} https://nodejs.org/api/https.html#https_class_https_server\n ",
4419+
"start": 5429,
4420+
"end": 5522,
44214421
"loc": {
44224422
"start": {
44234423
"line": 180,
@@ -11783,9 +11783,9 @@
1178311783
},
1178411784
{
1178511785
"type": "CommentBlock",
11786-
"value": "*\n * The options to be passed into {@link Bot} constructor.\n * @typedef {Object} BotOptions\n * @property {Topology} [topology] See WebGroupOptions.topology\n * @property {string} [signalingServer] See WebGroupOptions.signalingServer\n * @property {RTCConfiguration} [rtcConfiguration] See WebGroupOptions.rtcConfiguration\n * @property {boolean} [autoRejoin] See WebGroupOptions.autoRejoin\n * @property {Object} bot Server related options of the bot.\n * @property {NodeJSHttpServer|NodeJSHttpsServer} bot.server NodeJS http(s) server.\n * @property {string} [bot.url] Bot server URL.\n * @property {boolean} [bot.perMessageDeflate] Enable/disable permessage-deflate.\n * @property {boolean} [bot.leaveOnceAlone] If true, bot will live (disconnect from the signaling server) if no other peers left in the group.\n ",
11786+
"value": "*\n * The options to be passed into {@link Bot} constructor.\n * @typedef {Object} BotOptions\n * @property {Topology} [topology] See WebGroupOptions.topology\n * @property {string} [signalingServer] See WebGroupOptions.signalingServer\n * @property {RTCConfiguration} [rtcConfiguration] See WebGroupOptions.rtcConfiguration\n * @property {boolean} [autoRejoin] See WebGroupOptions.autoRejoin\n * @property {Object} bot Server related options of the bot.\n * @property {HttpServer|HttpsServer} bot.server NodeJS http(s) server.\n * @property {string} [bot.url] Bot server URL.\n * @property {boolean} [bot.perMessageDeflate] Enable/disable permessage-deflate.\n * @property {boolean} [bot.leaveOnceAlone] If true, bot will live (disconnect from the signaling server) if no other peers left in the group.\n ",
1178711787
"start": 4314,
11788-
"end": 5124,
11788+
"end": 5112,
1178911789
"loc": {
1179011790
"start": {
1179111791
"line": 158,
@@ -11800,8 +11800,8 @@
1180011800
{
1180111801
"type": "CommentBlock",
1180211802
"value": "*\n * @external {RTCConfiguration} https://developer.mozilla.org/en/docs/Web/API/RTCConfiguration\n ",
11803-
"start": 5125,
11804-
"end": 5227,
11803+
"start": 5113,
11804+
"end": 5215,
1180511805
"loc": {
1180611806
"start": {
1180711807
"line": 171,
@@ -11816,8 +11816,8 @@
1181611816
{
1181711817
"type": "CommentBlock",
1181811818
"value": "*\n * @external {Uint8Array} https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array\n ",
11819-
"start": 5228,
11820-
"end": 5350,
11819+
"start": 5216,
11820+
"end": 5338,
1182111821
"loc": {
1182211822
"start": {
1182311823
"line": 174,
@@ -11831,9 +11831,9 @@
1183111831
},
1183211832
{
1183311833
"type": "CommentBlock",
11834-
"value": "*\n * @external {NodeJSHttpServer} https://nodejs.org/api/http.html#http_class_http_server\n ",
11835-
"start": 5351,
11836-
"end": 5446,
11834+
"value": "*\n * @external {HttpServer} https://nodejs.org/api/http.html#http_class_http_server\n ",
11835+
"start": 5339,
11836+
"end": 5428,
1183711837
"loc": {
1183811838
"start": {
1183911839
"line": 177,
@@ -11847,9 +11847,9 @@
1184711847
},
1184811848
{
1184911849
"type": "CommentBlock",
11850-
"value": "*\n * @external {NodeJSHttpsServer} https://nodejs.org/api/https.html#https_class_https_server\n ",
11851-
"start": 5447,
11852-
"end": 5546,
11850+
"value": "*\n * @external {HttpsServer} https://nodejs.org/api/https.html#https_class_https_server\n ",
11851+
"start": 5429,
11852+
"end": 5522,
1185311853
"loc": {
1185411854
"start": {
1185511855
"line": 180,
@@ -11874,8 +11874,8 @@
1187411874
"binop": null,
1187511875
"updateContext": null
1187611876
},
11877-
"start": 5547,
11878-
"end": 5547,
11877+
"start": 5523,
11878+
"end": 5523,
1187911879
"loc": {
1188011880
"start": {
1188111881
"line": 183,

0 commit comments

Comments
 (0)