ソースを参照

chore[docs]: update docs

chenlei 2 年 前
コミット
f1e51afcd7

+ 6 - 6
packages/docs/.umirc.ts

@@ -52,19 +52,19 @@ export default defineConfig({
           "/components/Map",
         ],
       },
-    ],
-    "/utils": [
       {
-        title: "Service 接口请求",
-        path: "/utils/services",
+        title: "工具",
+        children: ["/components/utils/services", "/components/utils/storage"],
       },
+    ],
+    "/utils": [
       {
         title: "EventBus 事件",
         path: "/utils/eventbus",
       },
       {
-        title: "用户信息缓存",
-        path: "/utils/storage",
+        title: "日期格式化",
+        path: "/utils/date",
       },
     ],
     "/log": [

packages/docs/docs/utils/services.md → packages/docs/docs/components/utils/services.md


+ 1 - 1
packages/docs/docs/utils/storage.md

@@ -1,4 +1,4 @@
-## API
+## 用户信息缓存
 
 ### 从本地缓存中获取 Token 信息
 

+ 36 - 0
packages/docs/docs/utils/date.md

@@ -0,0 +1,36 @@
+基于 `dayjs` 的日期格式化
+
+## 方法
+
+### parseDate 日期解析
+
+| Name       | Description                | Type                           | Default      |
+| ---------- | -------------------------- | ------------------------------ | ------------ |
+| dateString | 要转换成日期的数字和字符串 | `string \| number \| Date`     | `(required)` |
+| format     | 用于指定日期的格式         | `string           \| string[]` | `--`         |
+
+### formatDate 格式化日期
+
+| Name        | Description                                                                 | Type                       | Default                     |
+| ----------- | --------------------------------------------------------------------------- | -------------------------- | --------------------------- |
+| date        | 日期                                                                        | `string \| number \| Date` | `(required)`                |
+| format      | [详见 string-format](https://dayjs.gitee.io/docs/zh-CN/parse/string-format) | `string`                   | [DATE_FORMAT](#date_format) |
+| parseFormat | 指定解析日期的格式                                                          | `string \| string[]`       | `--`                        |
+
+## 变量
+
+### DATE_FORMAT
+
+`YYYY-MM-DD`
+
+### DATE_TIME_FORMAT
+
+`YYYY-MM-DD HH:mm:ss`
+
+### SECOND 毫秒
+
+### MINUTE 分钟
+
+### HOUR 小时
+
+### DAY 天