feat: add support for loglevels (#3)

Co-authored-by: Aman Jain (ECS/DEL) <[email protected]>

README.md

@@ -25,20 +25,23 @@ The introduction of this package makes it very easy for clients to consume & lev
 
 In Javascript:
 ```js
-const { logger } = require("logger-safe-security");
+const { createLogger } = require("logger-safe-security");
+const logger = createLogger({ logLevel: "info" });
 logger.info("Hello world!");
 ```
 
 In Typescript:
 ```js
-import { logger } from "logger-safe-security";
+import { createLogger } from "logger-safe-security";
+const logger = createLogger({ logLevel: "info" });
 logger.info("Hello world!");
 ```
 
 Additionally, one can create child loggers inherited from the parent/package-default to pass specific metadata. 
 One such use case would be to add `service` metadata while importing it within the context of a service. For example:
 ```js
-import { logger } from "logger-safe-security";
+const { createLogger } = require("logger-safe-security");
+const logger = createLogger();
 const serviceLogger = logger.child({ service: "sample" });
 serviceLogger.info("This log line will include service metadata");
 ```
@@ -51,7 +54,7 @@ The logger exported as part of this package contains the following definition:
   - Application errors will be captured in the logs.
   - String interpolation is supported.
 - Log level: 
-  - The defeault log level is `INFO`.
+  - The default log level is `INFO`.
 - Transports:
   - All logs will be written to `Console` by default.
   - Exceptions & Promise Rejections will be handled & written to `Console` as well.

src/index.ts

@@ -2,40 +2,41 @@ import winston from "winston";
 
 const { combine, errors, timestamp, splat, json } = winston.format;
 
-export const logger = winston.createLogger({
-
-    // default log level is "info"
-    level: "info",
-
-    // combining multiple formats to get the desired output
-    format: combine(
-
-        // required to log errors thrown by the application; ignored otherwise
-        errors({ stack: true }),
-
-        // enables string interpolation of messages
-        splat(),
-
-        // adds timestamp to all log messages
-        timestamp(),
-
-        // default log format is JSON
-        json()
-    ),
-
-    transports: [
-
-        // logs will be written to console
-        new winston.transports.Console({
-
-            // catch and log `uncaughtException` events from the application
-            handleExceptions: true,
-
-            // catch and log `uncaughtRejection` events from the application
-            handleRejections: true
-        })
-    ],
-
-    // generic metadata applied to all logs
-    defaultMeta: { type: "application" }
-});
+export const createLogger = ({
+    logLevel = "info"
+}: {
+    logLevel: string;
+}): winston.Logger =>
+    winston.createLogger({
+        // default log level is "info"
+        level: logLevel,
+
+        // combining multiple formats to get the desired output
+        format: combine(
+            // required to log errors thrown by the application; ignored otherwise
+            errors({ stack: true }),
+
+            // enables string interpolation of messages
+            splat(),
+
+            // adds timestamp to all log messages
+            timestamp(),
+
+            // default log format is JSON
+            json()
+        ),
+
+        transports: [
+            // logs will be written to console
+            new winston.transports.Console({
+                // catch and log `uncaughtException` events from the application
+                handleExceptions: true,
+
+                // catch and log `uncaughtRejection` events from the application
+                handleRejections: true
+            })
+        ],
+
+        // generic metadata applied to all logs
+        defaultMeta: { type: "application" }
+    });