ProjectHentai/nonebot2
6
0
Fork 0
mirror of https://github.com/nonebot/nonebot2.git synced 2025-09-12 15:06:59 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

📝 update api docs

Browse Source
This commit is contained in:
yanyongyu
2020-12-07 00:52:26 +08:00
parent a420af75fc
commit e0d44f3fa7
12 changed files with 58 additions and 204 deletions
Download Patch File Download Diff File Expand all files Collapse all files

164
docs/api/typing.md
View File

@ -14,98 +14,18 @@ sidebarDepth: 0
以下类型均可从 nonebot.typing 模块导入。
## `Driver`
## `State`
* **类型**
`BaseDriver`
`Dict[Any, Any]`
* **说明**
所有 Driver 的基类。
## `WebSocket`
* **类型**
`BaseWebSocket`
* **说明**
所有 WebSocket 的基类。
## `Bot`
* **类型**
`BaseBot`
* **说明**
所有 Bot 的基类。
## `Event`
* **类型**
`BaseEvent`
* **说明**
所有 Event 的基类。
## `Message`
* **类型**
`BaseMessage`
* **说明**
所有 Message 的基类。
## `MessageSegment`
* **类型**
`BaseMessageSegment`
* **说明**
所有 MessageSegment 的基类。
事件处理状态 State 类型
@ -115,7 +35,7 @@ sidebarDepth: 0
* **类型**
`Callable[[Bot, Event, dict], Union[Awaitable[None], Awaitable[NoReturn]]]`
`Callable[[Bot, Event, State], Awaitable[None]]`
@ -131,7 +51,7 @@ sidebarDepth: 0
* **类型**
`Callable[[Bot, Event, dict], Union[Awaitable[None], Awaitable[NoReturn]]]`
`Callable[[Bot, Event, State], Awaitable[None]]`
@ -147,7 +67,7 @@ sidebarDepth: 0
* **类型**
`Callable[[Matcher, Bot, Event, dict], Union[Awaitable[None], Awaitable[NoReturn]]]`
`Callable[[Matcher, Bot, Event, State], Awaitable[None]]`
@ -163,7 +83,7 @@ sidebarDepth: 0
* **类型**
`Callable[[Matcher, Optional[Exception], Bot, Event, dict], Union[Awaitable[None], Awaitable[NoReturn]]]`
`Callable[[Matcher, Optional[Exception], Bot, Event, State], Awaitable[None]]`
@ -174,60 +94,12 @@ sidebarDepth: 0
## `Matcher`
* **类型**
`Matcher`
* **说明**
Matcher 即响应事件的处理类。通过 Rule 判断是否响应事件，运行 Handler。
## `MatcherGroup`
* **类型**
`MatcherGroup`
* **说明**
MatcherGroup 为 Matcher 的集合。可以共享 Handler。
## `Rule`
* **类型**
`Rule`
* **说明**
Rule 即判断是否响应事件的处理类。内部存储 RuleChecker ，返回全为 True 则响应事件。
## `RuleChecker`
* **类型**
`Callable[[Bot, Event, dict], Union[bool, Awaitable[bool]]]`
`Callable[[Bot, Event, State], Union[bool, Awaitable[bool]]]`
@ -238,22 +110,6 @@ sidebarDepth: 0
## `Permission`
* **类型**
`Permission`
* **说明**
Permission 即判断是否响应消息的处理类。内部存储 PermissionChecker ，返回只要有一个 True 则响应消息。
## `PermissionChecker`
@ -275,7 +131,7 @@ sidebarDepth: 0
* **类型**
`Callable[[Bot, Event, dict], Union[Awaitable[None], Awaitable[NoReturn]]]`
`Callable[[Bot, Event, State], Union[Awaitable[None], Awaitable[NoReturn]]]`
@ -291,7 +147,7 @@ sidebarDepth: 0
* **类型**
`Callable[[Bot, Event, dict], Union[Awaitable[None], Awaitable[NoReturn]]]`
`Callable[[Bot, Event, State], Awaitable[None]]`