docs: 优化文档展示,适配部分无目录文档,适配非结构体的类型定义,增加测试用例文档
This commit is contained in:
@@ -1,19 +1,20 @@
|
||||
# Fsm
|
||||
|
||||
|
||||
|
||||
[](https://pkg.go.dev/github.com/kercylan98/minotaur/fsm)
|
||||

|
||||
|
||||
## 目录
|
||||
列出了该 `package` 下所有的函数,可通过目录进行快捷跳转 ❤️
|
||||
|
||||
|
||||
|
||||
## 目录导航
|
||||
列出了该 `package` 下所有的函数及类型定义,可通过目录导航进行快捷跳转 ❤️
|
||||
<details>
|
||||
<summary>展开 / 折叠目录</summary
|
||||
<summary>展开 / 折叠目录导航</summary>
|
||||
|
||||
|
||||
> 包级函数定义
|
||||
|
||||
|函数|描述
|
||||
|函数名称|描述
|
||||
|:--|:--
|
||||
|[NewFSM](#NewFSM)|创建一个新的状态机
|
||||
|[WithEnterBeforeEvent](#WithEnterBeforeEvent)|设置状态进入前的回调
|
||||
@@ -23,44 +24,52 @@
|
||||
|[WithExitAfterEvent](#WithExitAfterEvent)|设置状态退出后的回调
|
||||
|
||||
|
||||
> 结构体定义
|
||||
> 类型定义
|
||||
|
||||
|结构体|描述
|
||||
|:--|:--
|
||||
|[FSM](#fsm)|状态机
|
||||
|[Option](#option)|暂无描述...
|
||||
|类型|名称|描述
|
||||
|:--|:--|:--
|
||||
|`STRUCT`|[FSM](#fsm)|状态机
|
||||
|`STRUCT`|[Option](#option)|暂无描述...
|
||||
|
||||
</details>
|
||||
|
||||
|
||||
***
|
||||
## 详情信息
|
||||
#### func NewFSM(data Data) *FSM[State, Data]
|
||||
<span id="NewFSM"></span>
|
||||
> 创建一个新的状态机
|
||||
|
||||
***
|
||||
#### func WithEnterBeforeEvent(fn func (state *FSM[State, Data])) Option[State, Data]
|
||||
<span id="WithEnterBeforeEvent"></span>
|
||||
> 设置状态进入前的回调
|
||||
> - 在首次设置状态时,状态机本身的当前状态为零值状态
|
||||
|
||||
***
|
||||
#### func WithEnterAfterEvent(fn func (state *FSM[State, Data])) Option[State, Data]
|
||||
<span id="WithEnterAfterEvent"></span>
|
||||
> 设置状态进入后的回调
|
||||
|
||||
***
|
||||
#### func WithUpdateEvent(fn func (state *FSM[State, Data])) Option[State, Data]
|
||||
<span id="WithUpdateEvent"></span>
|
||||
> 设置状态内刷新的回调
|
||||
|
||||
***
|
||||
#### func WithExitBeforeEvent(fn func (state *FSM[State, Data])) Option[State, Data]
|
||||
<span id="WithExitBeforeEvent"></span>
|
||||
> 设置状态退出前的回调
|
||||
> - 该阶段状态机的状态为退出前的状态,而非新的状态
|
||||
|
||||
***
|
||||
#### func WithExitAfterEvent(fn func (state *FSM[State, Data])) Option[State, Data]
|
||||
<span id="WithExitAfterEvent"></span>
|
||||
> 设置状态退出后的回调
|
||||
> - 该阶段状态机的状态为新的状态,而非退出前的状态
|
||||
|
||||
***
|
||||
### FSM
|
||||
### FSM `STRUCT`
|
||||
状态机
|
||||
```go
|
||||
type FSM[State comparable, Data any] struct {
|
||||
@@ -75,8 +84,8 @@ type FSM[State comparable, Data any] struct {
|
||||
exitAfterEventHandles map[State][]func(state *FSM[State, Data])
|
||||
}
|
||||
```
|
||||
### Option
|
||||
### Option `STRUCT`
|
||||
|
||||
```go
|
||||
type Option[State comparable, Data any] struct{}
|
||||
type Option[State comparable, Data any] func(fsm *FSM[State, Data], state State)
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user