Open settings for alternation at runtime. Fix #176

Author: terehov

README.md

@@ -260,6 +260,30 @@ A `settings` object is the first parameter passed to the `tslog` constructor:
 const logger = new Logger<ILogObj>({ /* SETTINGS */ }, defaultLogObject);
 ```
 
+##### Changing settings at runtime
+`settings` is a public property and can also be changed on runtime. 
+
+Example on changing `minLevel` on runtime:
+
+```typescript
+    const logger = new Logger({
+      minLevel: 1
+    });
+    
+    // visible
+    logger.log(1, "level_one", "LOG1");
+    // visible
+    logger.log(2, "level_two", "LOG2");
+    
+    // change minLevel to 2
+    logger.settings.minLevel = 2;
+
+    // hidden
+    logger.log(1, "level_one", "LOG3");
+    // visible
+    logger.log(2, "level_two", "LOG4");
+```
+
 #### Type: pretty, json, hidden
 
 - `pretty` **Default setting** prints out a formatted structured "pretty" log entry.

docs/README.md

@@ -49,8 +49,6 @@ Donations help me allocate more time for my open source work.
 
 ## Install
 
-> ❗ **`tslog` is a native ES module.**
-
 ```bash
 npm install tslog
 ```
@@ -262,6 +260,30 @@ A `settings` object is the first parameter passed to the `tslog` constructor:
 const logger = new Logger<ILogObj>({ /* SETTINGS */ }, defaultLogObject);
 ```
 
+##### Changing settings at runtime
+`settings` is a public property and can also be changed on runtime. 
+
+Example on changing `minLevel` on runtime:
+
+```typescript
+    const logger = new Logger({
+      minLevel: 1
+    });
+    
+    // visible
+    logger.log(1, "level_one", "LOG1");
+    // visible
+    logger.log(2, "level_two", "LOG2");
+    
+    // change minLevel to 2
+    logger.settings.minLevel = 2;
+
+    // hidden
+    logger.log(1, "level_one", "LOG3");
+    // visible
+    logger.log(2, "level_two", "LOG4");
+```
+
 #### Type: pretty, json, hidden
 
 - `pretty` **Default setting** prints out a formatted structured "pretty" log entry.

src/BaseLogger.ts

@@ -6,8 +6,9 @@ export * from "./interfaces";
 
 export class BaseLogger<LogObj> {
   private readonly runtime: "browser" | "nodejs" | "unknown";
-  private readonly settings: ISettings<LogObj>;
-  private subLoggers: BaseLogger<LogObj>[] = [];
+  public settings: ISettings<LogObj>;
+  // not needed yet
+  //private subLoggers: BaseLogger<LogObj>[] = [];
 
   constructor(settings?: ISettingsParam<LogObj>, private logObj?: LogObj, private stackDepthLevel: number = 4) {
     const isBrowser = ![typeof window, typeof document].includes("undefined");
@@ -175,7 +176,7 @@ export class BaseLogger<LogObj> {
       logObj?: LogObj,
       stackDepthLevel?: number
     ) => this)(subLoggerSettings, this.logObj, this.stackDepthLevel);
-    this.subLoggers.push(subLogger);
+    //this.subLoggers.push(subLogger);
     return subLogger;
   }
 

tests/Nodejs/7_pretty_Settings.test.ts

@@ -225,4 +225,23 @@ describe("Pretty: Settings", () => {
     expect(getConsoleLog()).toContain(`**${new Date().toISOString().split(".")[0]}`);
     expect(getConsoleLog()).toContain("** Test");
   });
+
+  test("Change settings: minLevel", (): void => {
+    const logger = new Logger({
+      type: "pretty",
+      minLevel: 1,
+    });
+    logger.log(1, "custom_level_one", "LOG1");
+    logger.log(2, "custom_level_two", "LOG2");
+
+    // change minLevel to 2
+    logger.settings.minLevel = 2;
+    logger.log(1, "custom_level_one", "LOG3");
+    logger.log(2, "custom_level_two", "LOG4");
+
+    expect(getConsoleLog()).toContain(`LOG1`);
+    expect(getConsoleLog()).toContain(`LOG2`);
+    expect(getConsoleLog()).not.toContain(`LOG3`);
+    expect(getConsoleLog()).toContain(`LOG4`);
+  });
 });