@tsed/platform-log-request 8.40.2 → 8.41.1

package/lib/types/domain/PlatformLogRequestSettings.d.ts

@@ -2,7 +2,7 @@ import type { DIContext } from "@tsed/di";
 export type AlterLogCallback = (level: "debug" | "info" | "warn" | "error" | "all", obj: Record<string, unknown>, ctx: DIContext) => Record<string, unknown>;
 export interface PlatformLogRequestSettings {
     /**
-     * Log all incoming request. By default, is true and print the configured `logger.requestFields`.
+     * Log all incoming requests. By default, true.
      */
     logRequest?: boolean;
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tsed/platform-log-request",
-  "version": "8.40.2",
+  "version": "8.41.1",
   "description": "Log request module for Ts.ED Framework (Express, Koa, Serverless)",
   "source": "./src/index.ts",
   "type": "module",
@@ -26,11 +26,11 @@
     "tslib": ">=2.7.0"
   },
   "devDependencies": {
-    "@tsed/barrels": "8.40.2",
-    "@tsed/di": "8.40.2",
-    "@tsed/platform-middlewares": "8.40.2",
-    "@tsed/platform-params": "8.40.2",
-    "@tsed/typescript": "8.40.2",
+    "@tsed/barrels": "8.41.1",
+    "@tsed/di": "8.41.1",
+    "@tsed/platform-middlewares": "8.41.1",
+    "@tsed/platform-params": "8.41.1",
+    "@tsed/typescript": "8.41.1",
     "typescript": "6.0.2",
     "vitest": "4.1.4"
   },

package/readme.md

@@ -40,26 +40,29 @@ npm install --save @tsed/platform-log-request
 ```ts
 import {Configuration} from "@tsed/di";
 import "@tsed/platform-log-request";
-import {levels} from "@tsed/logger";
 
 @Configuration({
-  /**
-   * Log all incoming request. By default, is true and print the configured `logger.requestFields`.
-   * @optional
-   */
-  // logRequest: true,
-  /**
-   * A function to alter the log object before it's logged.
-   * @optional
-   */
-  // alterLog: (level, data, $ctx) => {
-  //   /// see example above
-  // },
-  /**
-   * A function to alter the log object before it's logged.
-   * @optional
-   */
-  // onLogEnd? : ($ctx: BaseContext) => void;
+  logger: {
+    /**
+     * Log all incoming requests. By default, true.
+     * @optional
+     */
+    // logRequest: true,
+    /**
+     * A function to alter the log object before it is logged.
+     * @optional
+     */
+    // alterLog: (level, data, $ctx) => {
+    //   /// see example below
+    // },
+    /**
+     * A function to log the server response.
+     * @optional
+     */
+    // onLogResponse: ($ctx) => {
+    //   /// see example below
+    // }
+  }
 })
 class Server {}
 ```
@@ -101,7 +104,9 @@ import "@tsed/platform-log-request";
 import {customAlterLog} from "./utils/customAlterLog.js";
 
 @Configuration({
-  alterLog: customAlterLog
+  logger: {
+    alterLog: customAlterLog
+  }
 })
 class Server {}
 ```
@@ -150,7 +155,9 @@ import "@tsed/platform-log-request";
 import {customOnLogResponse} from "./utils/customOnLogResponse.js";
 
 @Configuration({
-  onLogResponse: customOnLogResponse
+  logger: {
+    onLogResponse: customOnLogResponse
+  }
 })
 class Server {}
 ```