fix: updated metadata to exclude error object

src/index.ts

@@ -6,6 +6,18 @@ export const levels = winston.config.npm.levels;
 
 export type Logger = winston.Logger;
 
+/* A custom format that is used to format the error object. */
+const formatError = winston.format(info => {
+    if ("error" in info && info.error instanceof Error) {
+        const {
+            error: { message, stack, ...rest }
+        } = info;
+        info.error = { message, stack, ...rest };
+    }
+
+    return info;
+});
+
 export const createLogger = (
     {
         logLevel = "info",
@@ -32,8 +44,17 @@ export const createLogger = (
 
             // moves all the other fields in the message to `metadata` property
             metadata({
-                fillExcept: ["message", "level", "timestamp", "service", "type"]
+                fillExcept: [
+                    "message",
+                    "level",
+                    "timestamp",
+                    "service",
+                    "type",
+                    "error"
+                ]
             }),
+            // custom formatter to format the "error" property
+            formatError(),
 
             // default log format is JSON
             json()

test/index.test.js

@@ -2,4 +2,10 @@ const { createLogger } = require("logger-safe-security");
 const logger = createLogger({ service: "sample" });
 
 logger.info("This is a sample logger");
-logger.info("This is a sample logger with more information", { planet: "Earth" });
+logger.info("This is a sample logger with more information", {
+  planet: "Earth",
+});
+
+/* Logging the error property. */
+const err = new Error("This is a sample Error");
+logger.info("Error occurred while performing the operation", { error: err });

test/index.test.ts

@@ -2,4 +2,9 @@ import { createLogger } from "logger-safe-security";
 const logger = createLogger({ service: "sample" });
 
 logger.info("This is a sample logger");
-logger.info("This is a sample logger with more information", { planet: "Earth" });
+logger.info("This is a sample logger with more information", { planet: "Earth" });
+
+
+/* Logging the error property. */
+const err = new Error("This is a sample Error");
+logger.info("Error occurred while performing the operation", { error: err });