feat: 补充 logger types

yyl-team · Mar 31, 2021 · de3a34f · de3a34f
1 parent b865035
commit de3a34f
Show file tree

Hide file tree

Showing 10 changed files with 57 additions and 26 deletions.
diff --git a/docs/interfaces/seedentry.md b/docs/interfaces/seedentry.md
@@ -33,7 +33,7 @@ Name | Type |
 `default` | *string*[] |
 `yy` | *string*[] |
 
-Defined in: types.ts:74
+Defined in: [types.ts:82](https://github.com/jackness1208/yyl-seed-base/blob/b865035/src/types.ts#L82)
 
 ___
 
@@ -43,7 +43,7 @@ ___
 
 seed 名称
 
-Defined in: types.ts:66
+Defined in: [types.ts:74](https://github.com/jackness1208/yyl-seed-base/blob/b865035/src/types.ts#L74)
 
 ___
 
@@ -53,7 +53,7 @@ ___
 
 构建处理
 
-Defined in: types.ts:72
+Defined in: [types.ts:80](https://github.com/jackness1208/yyl-seed-base/blob/b865035/src/types.ts#L80)
 
 ___
 
@@ -63,7 +63,7 @@ ___
 
 所在地址
 
-Defined in: types.ts:70
+Defined in: [types.ts:78](https://github.com/jackness1208/yyl-seed-base/blob/b865035/src/types.ts#L78)
 
 ___
 
@@ -73,4 +73,4 @@ ___
 
 版本
 
-Defined in: types.ts:68
+Defined in: [types.ts:76](https://github.com/jackness1208/yyl-seed-base/blob/b865035/src/types.ts#L76)
diff --git a/docs/interfaces/seedeventname.md b/docs/interfaces/seedeventname.md
@@ -27,7 +27,7 @@ Name | Type |
 `Args02` | *any*[] |
 `Args03` | *undefined* |
 
-Defined in: types.ts:8
+Defined in: [types.ts:8](https://github.com/jackness1208/yyl-seed-base/blob/b865035/src/types.ts#L8)
 
 ___
 
@@ -43,4 +43,4 @@ Name | Type |
 `Args02` | [*MsgType*](../modules.md#msgtype) |
 `Args03` | *any*[] |
 
-Defined in: types.ts:13
+Defined in: [types.ts:13](https://github.com/jackness1208/yyl-seed-base/blob/b865035/src/types.ts#L13)
diff --git a/docs/interfaces/seedoptimizeoption.md b/docs/interfaces/seedoptimizeoption.md
@@ -25,7 +25,7 @@
 
 操作符
 
-Defined in: types.ts:57
+Defined in: [types.ts:65](https://github.com/jackness1208/yyl-seed-base/blob/b865035/src/types.ts#L65)
 
 ___
 
@@ -35,7 +35,7 @@ ___
 
 cli 传参
 
-Defined in: types.ts:55
+Defined in: [types.ts:63](https://github.com/jackness1208/yyl-seed-base/blob/b865035/src/types.ts#L63)
 
 ___
 
@@ -45,7 +45,7 @@ ___
 
 项目根目录
 
-Defined in: types.ts:53
+Defined in: [types.ts:61](https://github.com/jackness1208/yyl-seed-base/blob/b865035/src/types.ts#L61)
 
 ___
 
@@ -55,4 +55,4 @@ ___
 
 yylConfig
 
-Defined in: types.ts:51
+Defined in: [types.ts:59](https://github.com/jackness1208/yyl-seed-base/blob/b865035/src/types.ts#L59)
diff --git a/docs/interfaces/seedoptimizeresult.md b/docs/interfaces/seedoptimizeresult.md
@@ -34,7 +34,7 @@
 
 express 使用中间件后回调 hooks
 
-Defined in: types.ts:33
+Defined in: [types.ts:41](https://github.com/jackness1208/yyl-seed-base/blob/b865035/src/types.ts#L41)
 
 ___
 
@@ -44,7 +44,7 @@ ___
 
 express 使用中间件前回调 hooks
 
-Defined in: types.ts:31
+Defined in: [types.ts:39](https://github.com/jackness1208/yyl-seed-base/blob/b865035/src/types.ts#L39)
 
 ___
 
@@ -54,7 +54,7 @@ ___
 
 可操作句柄
 
-Defined in: types.ts:46
+Defined in: [types.ts:54](https://github.com/jackness1208/yyl-seed-base/blob/b865035/src/types.ts#L54)
 
 ___
 
@@ -64,7 +64,7 @@ ___
 
 通知父应用不运行本地 server
 
-Defined in: types.ts:29
+Defined in: [types.ts:37](https://github.com/jackness1208/yyl-seed-base/blob/b865035/src/types.ts#L37)
 
 ___
 
@@ -74,7 +74,7 @@ ___
 
 消息处理对象
 
-Defined in: types.ts:25
+Defined in: [types.ts:33](https://github.com/jackness1208/yyl-seed-base/blob/b865035/src/types.ts#L33)
 
 ___
 
@@ -84,7 +84,7 @@ ___
 
 项目根目录
 
-Defined in: types.ts:27
+Defined in: [types.ts:35](https://github.com/jackness1208/yyl-seed-base/blob/b865035/src/types.ts#L35)
 
 ## Methods
 
@@ -96,7 +96,7 @@ Defined in: types.ts:27
 
 **Returns:** [*SeedOptimizeResult*](seedoptimizeresult.md)
 
-Defined in: types.ts:42
+Defined in: [types.ts:50](https://github.com/jackness1208/yyl-seed-base/blob/b865035/src/types.ts#L50)
 
 ___
 
@@ -108,7 +108,7 @@ ___
 
 **Returns:** YylConfig
 
-Defined in: types.ts:23
+Defined in: [types.ts:31](https://github.com/jackness1208/yyl-seed-base/blob/b865035/src/types.ts#L31)
 
 ___
 
@@ -133,7 +133,7 @@ Name | Type |
 
 **Returns:** [*SeedOptimizeResult*](seedoptimizeresult.md)
 
-Defined in: types.ts:35
+Defined in: [types.ts:43](https://github.com/jackness1208/yyl-seed-base/blob/b865035/src/types.ts#L43)
 
 ___
 
@@ -145,4 +145,4 @@ ___
 
 **Returns:** [*SeedOptimizeResult*](seedoptimizeresult.md)
 
-Defined in: types.ts:44
+Defined in: [types.ts:52](https://github.com/jackness1208/yyl-seed-base/blob/b865035/src/types.ts#L52)
diff --git a/docs/modules.md b/docs/modules.md
@@ -13,25 +13,42 @@
 
 ### Type aliases
 
+- [Logger](modules.md#logger)
 - [MsgType](modules.md#msgtype)
 - [ProgressType](modules.md#progresstype)
 - [SeedOptimize](modules.md#seedoptimize)
 
 ## Type aliases
 
+### Logger
+
+Ƭ **Logger**<T\>: (`type`: T, `args01`: [*SeedEventName*](interfaces/seedeventname.md)[T][*Args01*], `args02?`: [*SeedEventName*](interfaces/seedeventname.md)[T][*Args02*], `args03?`: [*SeedEventName*](interfaces/seedeventname.md)[T][*Args03*]) => *void*
+
+日志logger
+
+#### Type parameters:
+
+Name | Type | Default |
+------ | ------ | ------ |
+`T` | keyof [*SeedEventName*](interfaces/seedeventname.md) | keyof [*SeedEventName*](interfaces/seedeventname.md) |
+
+Defined in: [types.ts:21](https://github.com/jackness1208/yyl-seed-base/blob/b865035/src/types.ts#L21)
+
+___
+
 ### MsgType
 
 Ƭ **MsgType**: *error* \| *warn* \| *info* \| *add* \| *update* \| *success* \| *del* \| *cmd*
 
-Defined in: types.ts:4
+Defined in: [types.ts:4](https://github.com/jackness1208/yyl-seed-base/blob/b865035/src/types.ts#L4)
 
 ___
 
 ### ProgressType
 
 Ƭ **ProgressType**: *start* \| *finished* \| *number*
 
-Defined in: types.ts:5
+Defined in: [types.ts:5](https://github.com/jackness1208/yyl-seed-base/blob/b865035/src/types.ts#L5)
 
 ___
 
@@ -41,4 +58,4 @@ ___
 
 构建函数
 
-Defined in: types.ts:61
+Defined in: [types.ts:69](https://github.com/jackness1208/yyl-seed-base/blob/b865035/src/types.ts#L69)
diff --git a/history.md b/history.md
@@ -1,5 +1,9 @@
 # 版本变更
 
+## 0.2.6 (2021-03-31)
+
+- feat: 补充 logger types
+
 ## 0.2.5 (2021-03-08)
 
 - feat: 补充 SeedResult.appWillMount

diff --git a/output/index.js b/output/index.js
@@ -1,5 +1,5 @@
 /*!
- * yyl-seed-base cjs 0.2.5
+ * yyl-seed-base cjs 0.2.6
  * (c) 2020 - 2021 
  * Released under the MIT License.
  */

diff --git a/output/types.d.ts b/output/types.d.ts
@@ -15,6 +15,8 @@ export interface SeedEventName {
         Args03: any[];
     };
 }
+/** 日志logger */
+export declare type Logger<T extends keyof SeedEventName = keyof SeedEventName> = (type: T, args01: SeedEventName[T]['Args01'], args02?: SeedEventName[T]['Args02'], args03?: SeedEventName[T]['Args03']) => void;
 /** 构建函数 - 返回 */
 export interface SeedOptimizeResult {
     /** 获取 yylConfig 的运行配置 */

diff --git a/package.json b/package.json
@@ -1,5 +1,5 @@
 {
-  "version": "0.2.5",
+  "version": "0.2.6",
   "main": "output/index.js",
   "types": "output/index.d.ts",
   "eslintConfig": {

diff --git a/src/types.ts b/src/types.ts
@@ -17,6 +17,14 @@ export interface SeedEventName {
   }
 }
 
+/** 日志logger */
+export type Logger<T extends keyof SeedEventName = keyof SeedEventName> = (
+  type: T,
+  args01: SeedEventName[T]['Args01'],
+  args02?: SeedEventName[T]['Args02'],
+  args03?: SeedEventName[T]['Args03']
+) => void
+
 /** 构建函数 - 返回 */
 export interface SeedOptimizeResult {
   /** 获取 yylConfig 的运行配置 */