Expose default loglevels

fullstack-build · Dec 14, 2024 · 0e71031 · 0e71031
1 parent 9a5d156
commit 0e71031
Show file tree

Hide file tree

Showing 4 changed files with 39 additions and 17 deletions.
diff --git a/README.md b/README.md
@@ -212,7 +212,7 @@ To ensure optimal performance in production, we recommend modifying these settin
 
 ### Default log level
 
-`tslog` comes with default log level `0: silly`, `1: trace`, `2: debug`, `3: info`, `4: warn`, `5: error`, `6: fatal`.
+`tslog` comes with default log levels (`DefaultLogLevels`): `0: silly`, `1: trace`, `2: debug`, `3: info`, `4: warn`, `5: error`, `6: fatal`.
 
 > **Tip:** Each logging method has a return type, which is a _JSON_ representation of the log message (`ILogObj`).
 

diff --git a/docs/README.md b/docs/README.md
@@ -212,7 +212,7 @@ To ensure optimal performance in production, we recommend modifying these settin
 
 ### Default log level
 
-`tslog` comes with default log level `0: silly`, `1: trace`, `2: debug`, `3: info`, `4: warn`, `5: error`, `6: fatal`.
+`tslog` comes with default log levels (`DefaultLogLevels`): `0: silly`, `1: trace`, `2: debug`, `3: info`, `4: warn`, `5: error`, `6: fatal`.
 
 > **Tip:** Each logging method has a return type, which is a _JSON_ representation of the log message (`ILogObj`).
 
@@ -379,7 +379,7 @@ Output:
 #### minLevel
 
 You can ignore every log message from being processed until a certain severity.
-Default severities are:
+Default severities (`DefaultLogLevels`) are:
 `0: silly`, `1: trace`, `2: debug`, `3: info`, `4: warn`, `5: error`, `6: fatal`
 
 ```typescript

diff --git a/src/index.browser.ts b/src/index.browser.ts
@@ -4,6 +4,16 @@ import { ILogObj, ILogObjMeta, ISettingsParam } from "./interfaces.js";
 export * from "./interfaces.js";
 export * from "./BaseLogger.js";
 
+export enum DefaultLogLevels {
+  SILLY = 0,
+  TRACE = 1,
+  DEBUG = 2,
+  INFO = 3,
+  WARN = 4,
+  ERROR = 5,
+  FATAL = 6,
+}
+
 export class Logger<LogObj> extends BaseLogger<LogObj> {
   constructor(settings?: ISettingsParam<LogObj>, logObj?: LogObj) {
     const isBrowser = ![typeof window, typeof document].includes("undefined");
@@ -34,55 +44,56 @@ export class Logger<LogObj> extends BaseLogger<LogObj> {
    * @param args  - Multiple log attributes that should be logged out.
    */
   public silly(...args: unknown[]): (LogObj & ILogObjMeta) | undefined {
-    return super.log(0, "SILLY", ...args);
+    return super.log(DefaultLogLevels.SILLY, "SILLY", ...args);
   }
 
   /**
    * Logs a trace message.
    * @param args  - Multiple log attributes that should be logged out.
    */
   public trace(...args: unknown[]): (LogObj & ILogObjMeta) | undefined {
-    return super.log(1, "TRACE", ...args);
+    return super.log(DefaultLogLevels.TRACE, "TRACE", ...args);
   }
 
   /**
    * Logs a debug message.
    * @param args  - Multiple log attributes that should be logged out.
    */
   public debug(...args: unknown[]): (LogObj & ILogObjMeta) | undefined {
-    return super.log(2, "DEBUG", ...args);
+    return super.log(DefaultLogLevels.DEBUG, "DEBUG", ...args);
   }
 
   /**
    * Logs an info message.
    * @param args  - Multiple log attributes that should be logged out.
    */
   public info(...args: unknown[]): (LogObj & ILogObjMeta) | undefined {
-    return super.log(3, "INFO", ...args);
+    // TODO: here
+    return super.log(DefaultLogLevels.INFO, "INFO", ...args);
   }
 
   /**
    * Logs a warn message.
    * @param args  - Multiple log attributes that should be logged out.
    */
   public warn(...args: unknown[]): (LogObj & ILogObjMeta) | undefined {
-    return super.log(4, "WARN", ...args);
+    return super.log(DefaultLogLevels.WARN, "WARN", ...args);
   }
 
   /**
    * Logs an error message.
    * @param args  - Multiple log attributes that should be logged out.
    */
   public error(...args: unknown[]): (LogObj & ILogObjMeta) | undefined {
-    return super.log(5, "ERROR", ...args);
+    return super.log(DefaultLogLevels.ERROR, "ERROR", ...args);
   }
 
   /**
    * Logs a fatal message.
    * @param args  - Multiple log attributes that should be logged out.
    */
   public fatal(...args: unknown[]): (LogObj & ILogObjMeta) | undefined {
-    return super.log(6, "FATAL", ...args);
+    return super.log(DefaultLogLevels.FATAL, "FATAL", ...args);
   }
 
   /**

diff --git a/src/index.ts b/src/index.ts
@@ -9,6 +9,16 @@ declare global {
   }
 }
 
+export enum DefaultLogLevels {
+  SILLY = 0,
+  TRACE = 1,
+  DEBUG = 2,
+  INFO = 3,
+  WARN = 4,
+  ERROR = 5,
+  FATAL = 6,
+}
+
 export class Logger<LogObj> extends BaseLogger<LogObj> {
   constructor(settings?: ISettingsParam<LogObj>, logObj?: LogObj) {
     const isBrowser = typeof window !== "undefined" && typeof document !== "undefined";
@@ -37,55 +47,56 @@ export class Logger<LogObj> extends BaseLogger<LogObj> {
    * @param args  - Multiple log attributes that should be logged out.
    */
   public silly(...args: unknown[]): (LogObj & ILogObjMeta) | undefined {
-    return super.log(0, "SILLY", ...args);
+    return super.log(DefaultLogLevels.SILLY, "SILLY", ...args);
   }
 
   /**
    * Logs a trace message.
    * @param args  - Multiple log attributes that should be logged out.
    */
   public trace(...args: unknown[]): (LogObj & ILogObjMeta) | undefined {
-    return super.log(1, "TRACE", ...args);
+    return super.log(DefaultLogLevels.TRACE, "TRACE", ...args);
   }
 
   /**
    * Logs a debug message.
    * @param args  - Multiple log attributes that should be logged out.
    */
   public debug(...args: unknown[]): (LogObj & ILogObjMeta) | undefined {
-    return super.log(2, "DEBUG", ...args);
+    return super.log(DefaultLogLevels.DEBUG, "DEBUG", ...args);
   }
 
   /**
    * Logs an info message.
    * @param args  - Multiple log attributes that should be logged out.
    */
   public info(...args: unknown[]): (LogObj & ILogObjMeta) | undefined {
-    return super.log(3, "INFO", ...args);
+    // TODO: here
+    return super.log(DefaultLogLevels.INFO, "INFO", ...args);
   }
 
   /**
    * Logs a warn message.
    * @param args  - Multiple log attributes that should be logged out.
    */
   public warn(...args: unknown[]): (LogObj & ILogObjMeta) | undefined {
-    return super.log(4, "WARN", ...args);
+    return super.log(DefaultLogLevels.WARN, "WARN", ...args);
   }
 
   /**
    * Logs an error message.
    * @param args  - Multiple log attributes that should be logged out.
    */
   public error(...args: unknown[]): (LogObj & ILogObjMeta) | undefined {
-    return super.log(5, "ERROR", ...args);
+    return super.log(DefaultLogLevels.ERROR, "ERROR", ...args);
   }
 
   /**
    * Logs a fatal message.
    * @param args  - Multiple log attributes that should be logged out.
    */
   public fatal(...args: unknown[]): (LogObj & ILogObjMeta) | undefined {
-    return super.log(6, "FATAL", ...args);
+    return super.log(DefaultLogLevels.FATAL, "FATAL", ...args);
   }
 
   /**