koa-ts-core 0.0.16 → 0.0.18

package/README.md

@@ -8,12 +8,6 @@
 npm i koa-ts-core
 ```
 
-宿主项目需要安装库
-
-```shell
-npm i koa @koa/router dotenv
-```
-
 ## 初始化
 
 ```typescript
@@ -28,6 +22,13 @@ const [app] = await initializeKoaApp({
   registerHighPriorityMiddleware: (app: Koa) => void,
   // 异常处理
   catchErrorCallback: (error: Error) => void,
+  // hook
+  registerHook: (
+    ctx: Koa.Context,
+    type: "request" | "response" | "error"
+  ) => void;
+  // 是否挂载log4到context
+  log4: TLog4;
 });
 
 app.listen();
@@ -47,6 +48,10 @@ app.listen();
 
   - registerHighPriorityMiddleware ((app: Koa) => void)) : 高优先级中间件注册函数，用于注册一些高优先级中间件。
 
+  - registerHook ((ctx: Koa.Context, type: "request" | "response" | "error") => void) : hook 注册函数，用于注册一些 hook
+
+  - log4 (TLog4) : 是否挂载 log4 到 context
+
 ## 能力
 
 ### 约定式路由
@@ -267,6 +272,49 @@ export default class Test {
 
 打开`/doc`路由地址，渲染文档
 
+### 挂载 log4
+
+使用[log4js](https://www.npmjs.com/package/log4js)库对日志进行预加载
+
+```typescript
+type TLog4 = boolean | ((instance: Log4js) => Log4js);
+```
+
+如果传入值为`true`，则使用默认配置
+
+```js
+log4js.configure({
+  appenders: {
+    console: { type: "console" }, // 控制台输出
+    file: {
+      type: "dateFile",
+      filename: "logs/app.log",
+      pattern: ".yyyy-MM-dd",
+      compress: true,
+      numBackups: 7,
+      alwaysIncludePattern: true,
+    },
+  },
+  categories: {
+    default: { appenders: ["console", "file"], level: "info" },
+  },
+});
+```
+
+如需覆盖默认配置，传入函数
+
+```typescript
+initializeKoaApp({
+  log4: (instance) => {
+    return instance.configure({
+      appenders: {
+        console: { type: "console" }, // 控制台输出
+      },
+    });
+  },
+});
+```
+
 ### 配置项
 
 #### process.env.APP_PORT

package/dist/global.d.ts

@@ -0,0 +1,13 @@
+import "koa";
+
+declare module "koa" {
+  interface DefaultContext {
+    log4?: import("log4js").Log4js;
+  }
+}
+
+declare namespace NodeJS {
+  interface ProcessEnv {
+    NODE_ENV: "development" | "production" | "test"; // 环境类型
+  }
+}