docs: 更新文档

blacktunes · Jan 16, 2022 · 80e0117 · 80e0117
1 parent f95f65c
commit 80e0117
Show file tree

Hide file tree

Showing 16 changed files with 240 additions and 133 deletions.
diff --git a/docs/classes/bot_app.app.md b/docs/classes/bot_app.app.md
@@ -50,47 +50,47 @@ BOT构造函数
 
 **Returns:** [*App*](bot_app.app.md)
 
-Defined in: Bot/App.ts:14
+Defined in: Bot/App.ts:15
 
 ## Properties
 
 ### Bot
 
 • `Private` `Readonly` **Bot**: [*Bot*](bot_bot.bot.md)
 
-Defined in: Bot/App.ts:37
+Defined in: Bot/App.ts:38
 
 ___
 
 ### \_pluginsList
 
 • `Private` **\_pluginsList**: { `class`: *boolean* ; `config?`: *any* ; `plugin`: [*Plugin*](../interfaces/type_bot.plugin.md) \| [*PluginFunction*](../modules/type_bot.md#pluginfunction)  }[]= []
 
-Defined in: Bot/App.ts:107
+Defined in: Bot/App.ts:108
 
 ___
 
 ### blacklist
 
 • `Private` **blacklist**: *Set*<number\>
 
-Defined in: Bot/App.ts:40
+Defined in: Bot/App.ts:41
 
 ___
 
 ### isStart
 
 • `Private` **isStart**: *boolean*= false
 
-Defined in: Bot/App.ts:35
+Defined in: Bot/App.ts:36
 
 ___
 
 ### whitelist
 
 • `Private` **whitelist**: *Set*<number\>
 
-Defined in: Bot/App.ts:39
+Defined in: Bot/App.ts:40
 
 ## Methods
 
@@ -108,7 +108,7 @@ Defined in: Bot/App.ts:39
 
 **Returns:** [*App*](bot_app.app.md)
 
-Defined in: Bot/App.ts:81
+Defined in: Bot/App.ts:82
 
 ___
 
@@ -126,7 +126,7 @@ ___
 
 **Returns:** [*App*](bot_app.app.md)
 
-Defined in: Bot/App.ts:64
+Defined in: Bot/App.ts:65
 
 ___
 
@@ -136,7 +136,7 @@ ___
 
 **Returns:** *Promise*<void\>
 
-Defined in: Bot/App.ts:184
+Defined in: Bot/App.ts:185
 
 ___
 
@@ -146,7 +146,7 @@ ___
 
 **Returns:** *Promise*<void\>
 
-Defined in: Bot/App.ts:251
+Defined in: Bot/App.ts:252
 
 ___
 
@@ -156,7 +156,7 @@ ___
 
 **Returns:** *Promise*<void\>
 
-Defined in: Bot/App.ts:295
+Defined in: Bot/App.ts:307
 
 ___
 
@@ -174,7 +174,7 @@ ___
 
 **Returns:** [*App*](bot_app.app.md)
 
-Defined in: Bot/App.ts:98
+Defined in: Bot/App.ts:99
 
 ___
 
@@ -190,7 +190,7 @@ ___
 
 **Returns:** [*App*](bot_app.app.md)
 
-Defined in: Bot/App.ts:90
+Defined in: Bot/App.ts:91
 
 ___
 
@@ -208,7 +208,7 @@ ___
 
 **Returns:** [*App*](bot_app.app.md)
 
-Defined in: Bot/App.ts:116
+Defined in: Bot/App.ts:117
 
 ▸ **plugin**<T\>(`plugin`: T, `config?`: *InstanceType*<T\>[``"config"``]): [*App*](bot_app.app.md)
 
@@ -229,7 +229,7 @@ Defined in: Bot/App.ts:116
 
 **Returns:** [*App*](bot_app.app.md)
 
-Defined in: Bot/App.ts:122
+Defined in: Bot/App.ts:123
 
 ___
 
@@ -239,7 +239,7 @@ ___
 
 **Returns:** *void*
 
-Defined in: Bot/App.ts:192
+Defined in: Bot/App.ts:193
 
 ___
 
@@ -259,7 +259,7 @@ ___
 
 **Returns:** *Promise*<[*Bot*](bot_bot.bot.md)\>
 
-Defined in: Bot/App.ts:149
+Defined in: Bot/App.ts:150
 
 ___
 
@@ -277,4 +277,4 @@ ___
 
 **Returns:** [*App*](bot_app.app.md)
 
-Defined in: Bot/App.ts:46
+Defined in: Bot/App.ts:47
diff --git a/docs/classes/bot_bot.bot.md b/docs/classes/bot_bot.bot.md
@@ -49,7 +49,7 @@ Defined in: Bot/Bot.ts:12
 
 管理员命令
 
-Defined in: Bot/Bot.ts:44
+Defined in: Bot/Bot.ts:32
 
 ___
 
@@ -59,7 +59,7 @@ ___
 
 HTTP API
 
-Defined in: Bot/Bot.ts:52
+Defined in: Bot/Bot.ts:36
 
 ___
 
@@ -69,7 +69,7 @@ ___
 
 CQ码
 
-Defined in: Bot/Bot.ts:32
+Defined in: Bot/Bot.ts:26
 
 ___
 
@@ -79,7 +79,7 @@ ___
 
 命令对象
 
-Defined in: Bot/Bot.ts:40
+Defined in: Bot/Bot.ts:30
 
 ___
 
@@ -89,7 +89,7 @@ ___
 
 WS链接
 
-Defined in: Bot/Bot.ts:48
+Defined in: Bot/Bot.ts:34
 
 ___
 
@@ -99,7 +99,7 @@ ___
 
 Bot的部分属性
 
-Defined in: Bot/Bot.ts:24
+Defined in: Bot/Bot.ts:22
 
 ___
 
@@ -109,7 +109,7 @@ ___
 
 测试类
 
-Defined in: Bot/Bot.ts:60
+Defined in: Bot/Bot.ts:40
 
 ___
 
@@ -119,7 +119,7 @@ ___
 
 消息事件
 
-Defined in: Bot/Bot.ts:56
+Defined in: Bot/Bot.ts:38
 
 ___
 
@@ -129,7 +129,7 @@ ___
 
 日志对象
 
-Defined in: Bot/Bot.ts:28
+Defined in: Bot/Bot.ts:24
 
 ___
 
@@ -139,4 +139,4 @@ ___
 
 插件对象
 
-Defined in: Bot/Bot.ts:36
+Defined in: Bot/Bot.ts:28
diff --git a/docs/classes/bot_modules_admin.admin.md b/docs/classes/bot_modules_admin.admin.md
@@ -42,23 +42,23 @@
 
 **Returns:** [*Admin*](bot_modules_admin.admin.md)
 
-Defined in: Bot/modules/Admin.ts:8
+Defined in: Bot/modules/Admin.ts:6
 
 ## Properties
 
 ### Bot
 
 • `Private` **Bot**: *Pick*<[*Bot*](bot_bot.bot.md), ``"Data"`` \| ``"Log"`` \| ``"CQCode"`` \| ``"Plugin"`` \| ``"Command"`` \| ``"Conn"`` \| ``"Api"`` \| ``"Event"`` \| ``"Debug"``\>
 
-Defined in: Bot/modules/Admin.ts:12
+Defined in: Bot/modules/Admin.ts:10
 
 ___
 
 ### adminList
 
 • **adminList**: *Set*<number\>
 
-Defined in: Bot/modules/Admin.ts:14
+Defined in: Bot/modules/Admin.ts:12
 
 ___
 
@@ -68,7 +68,7 @@ ___
 
 被ban名单
 
-Defined in: Bot/modules/Admin.ts:26
+Defined in: Bot/modules/Admin.ts:22
 
 ## Methods
 
@@ -84,7 +84,7 @@ Defined in: Bot/modules/Admin.ts:26
 
 **Returns:** *void*
 
-Defined in: Bot/modules/Admin.ts:15
+Defined in: Bot/modules/Admin.ts:13
 
 ___
 
@@ -102,14 +102,16 @@ ___
 
 **Returns:** *void*
 
-Defined in: Bot/modules/Admin.ts:83
+Defined in: Bot/modules/Admin.ts:78
 
 ___
 
 ### addWhitelist
 
 ▸ **addWhitelist**(`group_list`: *number*[]): *void*
 
+增加白名单列表，请勿和黑名单同时使用
+
 #### Parameters:
 
 | Name | Type |
@@ -118,7 +120,7 @@ ___
 
 **Returns:** *void*
 
-Defined in: Bot/modules/Admin.ts:71
+Defined in: Bot/modules/Admin.ts:68
 
 ___
 
@@ -138,7 +140,7 @@ ___
 
 **Returns:** *void*
 
-Defined in: Bot/modules/Admin.ts:33
+Defined in: Bot/modules/Admin.ts:29
 
 ___
 
@@ -154,7 +156,7 @@ ___
 
 **Returns:** *boolean*
 
-Defined in: Bot/modules/Admin.ts:19
+Defined in: Bot/modules/Admin.ts:17
 
 ___
 
@@ -170,7 +172,7 @@ ___
 
 **Returns:** *boolean*
 
-Defined in: Bot/modules/Admin.ts:67
+Defined in: Bot/modules/Admin.ts:63
 
 ___
 
@@ -186,4 +188,4 @@ ___
 
 **Returns:** *void*
 
-Defined in: Bot/modules/Admin.ts:59
+Defined in: Bot/modules/Admin.ts:55