Browse Source

修订文档

drake 3 years ago
parent
commit
8e530b968d
3 changed files with 18 additions and 12 deletions
  1. 1 1
      docs/css/extra.css
  2. 16 10
      docs/interval.md
  3. 1 1
      mkdocs.yml

+ 1 - 1
docs/css/extra.css

@@ -73,7 +73,7 @@
     -webkit-font-smoothing: subpixel-antialiased;
     -moz-osx-font-smoothing: auto;
     text-rendering: optimizeLegibility;
-    font-family: 'Iosevka', "HYZhengYuan" !important;
+    font-family: 'Iosevka', "HYZhengYuan", monospace !important;
 }
 
 /*布局*/

+ 16 - 10
docs/interval.md

@@ -1,4 +1,9 @@
-轮循器属于项目中常见需求, 网络请求也存在定时网络请求
+轮循器属于项目中常见需求, 本工具支持以下特性
+
+1. 正计时
+1. 倒计时
+1. 计数器
+1. 支持开始/停止/暂停/继续/重置/切换开关
 
 === "指定轮循次数/间隔"
     ```kotlin
@@ -23,15 +28,16 @@ interval.subscribe {
 }.start()
 ```
 
-操作轮循器
-```kotlin
-interval.start() // 开始轮循器
-interval.pause() // 暂停轮循器
-interval.resume() // 继续轮循器
-interval.reset() // 重置轮循器
-interval.switch() // 切换开关
-interval.stop() // 停止
-```
+| Interval函数 | 描述 |
+|-|-|
+| start | 开始轮循器 |
+| stop | 停止 |
+| pause | 暂停轮循器 |
+| resume | 继续轮循器 |
+| reset | 重置轮循器 |
+| switch | 切换开关 |
+| subscribe | 每次计时都会执行该回调 |
+| finish | 当计时器完成时执行该回调 |
 
 自动取消(感知生命周期)
 

+ 1 - 1
mkdocs.yml

@@ -69,6 +69,6 @@ nav:
   - 节流阀: debounce.md
   - 取消请求: cancel.md
   - 日志拦截器: log-recorder.md
-  - 轮循器: interval.md
+  - 轮循器/倒计时: interval.md
   - 更新日志: updates.md
   - 3.x文档: api/index.html