@pristine-ts/logging 0.0.170 → 0.0.174

package/dist/lib/cjs/enums/output-mode.enum.js

@@ -1,9 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OutputModeEnum = void 0;
+/**
+ * Output mode for the logs.
+ */
 var OutputModeEnum;
 (function (OutputModeEnum) {
+    /**
+     * The logs will output a JSON format.
+     */
     OutputModeEnum["Json"] = "JSON";
+    /**
+     * The logs will output a simple string format.
+     */
     OutputModeEnum["Simple"] = "SIMPLE";
 })(OutputModeEnum = exports.OutputModeEnum || (exports.OutputModeEnum = {}));
 //# sourceMappingURL=output-mode.enum.js.map

package/dist/lib/cjs/enums/output-mode.enum.js.map

@@ -1 +1 @@
-{"version":3,"file":"output-mode.enum.js","sourceRoot":"","sources":["../../../../src/enums/output-mode.enum.ts"],"names":[],"mappings":";;;AAAA,IAAY,cAGX;AAHD,WAAY,cAAc;IACtB,+BAAa,CAAA;IACb,mCAAiB,CAAA;AACrB,CAAC,EAHW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAGzB"}
+{"version":3,"file":"output-mode.enum.js","sourceRoot":"","sources":["../../../../src/enums/output-mode.enum.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,IAAY,cASX;AATD,WAAY,cAAc;IACtB;;OAEG;IACH,+BAAa,CAAA;IACb;;OAEG;IACH,mCAAiB,CAAA;AACrB,CAAC,EATW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QASzB"}

package/dist/lib/cjs/enums/severity.enum.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SeverityEnum = void 0;
+/**
+ * The severity supported for logging purposes.
+ */
 var SeverityEnum;
 (function (SeverityEnum) {
     SeverityEnum[SeverityEnum["Critical"] = 4] = "Critical";

package/dist/lib/cjs/enums/severity.enum.js.map

@@ -1 +1 @@
-{"version":3,"file":"severity.enum.js","sourceRoot":"","sources":["../../../../src/enums/severity.enum.ts"],"names":[],"mappings":";;;AAAA,IAAY,YAMX;AAND,WAAY,YAAY;IACpB,uDAAY,CAAA;IACZ,iDAAS,CAAA;IACT,qDAAW,CAAA;IACX,+CAAQ,CAAA;IACR,iDAAS,CAAA;AACb,CAAC,EANW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAMvB"}
+{"version":3,"file":"severity.enum.js","sourceRoot":"","sources":["../../../../src/enums/severity.enum.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,IAAY,YAMX;AAND,WAAY,YAAY;IACpB,uDAAY,CAAA;IACZ,iDAAS,CAAA;IACT,qDAAW,CAAA;IACX,+CAAQ,CAAA;IACR,iDAAS,CAAA;AACb,CAAC,EANW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAMvB"}

package/dist/lib/cjs/handlers/log.handler.js

@@ -19,7 +19,20 @@ const severity_enum_1 = require("../enums/severity.enum");
 const log_model_1 = require("../models/log.model");
 const common_1 = require("@pristine-ts/common");
 const utils_1 = require("../utils/utils");
+/**
+ * The LogHandler to use when we want to output some logs.
+ * This handler makes sure that only the right level of logs are outputted, stacks logs, and logs with different loggers.
+ * It is registered with the tag LogHandlerInterface so that it can be injected as a LogHandlerInterface to facilitate mocking.
+ */
 let LogHandler = class LogHandler {
+    /**
+     * The LogHandler to use when we want to output some logs.
+     * @param loggers The loggers to use to output the logs. All services with the tag ServiceDefinitionTagEnum.Logger will be automatically injected here.
+     * @param logSeverityLevelConfiguration The severity from which to start logging the logs.
+     * @param activateDiagnostics Whether or not the outputted logs should contain the diagnostic part. This is an intensive process and can dramatically reduce the performance of the code.
+     * @param kernelInstantiationId The id of instantiation of the kernel.
+     * @param tracingContext The context of the tracing.
+     */
     constructor(loggers, logSeverityLevelConfiguration, activateDiagnostics, kernelInstantiationId, tracingContext) {
         this.loggers = loggers;
         this.logSeverityLevelConfiguration = logSeverityLevelConfiguration;
@@ -27,21 +40,63 @@ let LogHandler = class LogHandler {
         this.kernelInstantiationId = kernelInstantiationId;
         this.tracingContext = tracingContext;
     }
-    error(message, extra, module = "application") {
-        return this.log(message, severity_enum_1.SeverityEnum.Error, extra, module);
-    }
+    /**
+     * Logs the message if the severity is set to critical or above.
+     * This function is wrapper function for the log method with the proper severity to make it cleaner when using it in the code.
+     * @param message The message to log.
+     * @param extra The extra object to log.
+     * @param module The module from where the log was created.
+     */
     critical(message, extra, module = "application") {
         return this.log(message, severity_enum_1.SeverityEnum.Critical, extra, module);
     }
-    debug(message, extra, module = "application") {
-        return this.log(message, severity_enum_1.SeverityEnum.Debug, extra, module);
+    /**
+     * Logs the message if the severity is set to error or above.
+     * This function is wrapper function for the log method with the proper severity to make it cleaner when using it in the code.
+     * @param message The message to log.
+     * @param extra The extra object to log.
+     * @param module The module from where the log was created.
+     */
+    error(message, extra, module = "application") {
+        return this.log(message, severity_enum_1.SeverityEnum.Error, extra, module);
     }
+    /**
+     * Logs the message if the severity is set to warning or above.
+     * This function is wrapper function for the log method with the proper severity to make it cleaner when using it in the code.
+     * @param message The message to log.
+     * @param extra The extra object to log.
+     * @param module The module from where the log was created.
+     */
+    warning(message, extra, module = "application") {
+        return this.log(message, severity_enum_1.SeverityEnum.Warning, extra, module);
+    }
+    /**
+     * Logs the message if the severity is set to info or above.
+     * This function is wrapper function for the log method with the proper severity to make it cleaner when using it in the code.
+     * @param message The message to log.
+     * @param extra The extra object to log.
+     * @param module The module from where the log was created.
+     */
     info(message, extra, module = "application") {
         return this.log(message, severity_enum_1.SeverityEnum.Info, extra, module);
     }
-    warning(message, extra, module = "application") {
-        return this.log(message, severity_enum_1.SeverityEnum.Warning, extra, module);
+    /**
+     * Logs the message if the severity is set to debug or above.
+     * This function is wrapper function for the log method with the proper severity to make it cleaner when using it in the code.
+     * @param message The message to log.
+     * @param extra The extra object to log.
+     * @param module The module from where the log was created.
+     */
+    debug(message, extra, module = "application") {
+        return this.log(message, severity_enum_1.SeverityEnum.Debug, extra, module);
     }
+    /**
+     * Logs the message based on the severity.
+     * @param message The message to log.
+     * @param severity The minimum severity to log.
+     * @param extra The extra object to log.
+     * @param module The module from where the log was created.
+     */
     log(message, severity = severity_enum_1.SeverityEnum.Error, extra, module = "application") {
         const log = new log_model_1.LogModel(severity, message);
         log.kernelInstantiationId = this.kernelInstantiationId;
@@ -64,9 +119,10 @@ let LogHandler = class LogHandler {
             }
             log.extra["__diagnostics"] = diagnostics;
         }
-        for (const writer of this.loggers) {
-            if (writer.isActive()) {
-                writer.readableStream.push(log);
+        // Log in every logger that is activated.
+        for (const logger of this.loggers) {
+            if (logger.isActive()) {
+                logger.readableStream.push(log);
             }
         }
     }

package/dist/lib/cjs/handlers/log.handler.js.map

@@ -1 +1 @@
-{"version":3,"file":"log.handler.js","sourceRoot":"","sources":["../../../../src/handlers/log.handler.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,4BAAyB;AACzB,uCAAkE;AAClE,0DAAoD;AACpD,mDAA6C;AAE7C,gDAAkH;AAElH,0CAAqC;AAIrC,IAAa,UAAU,GAAvB,MAAa,UAAU;IAErB,YAAgF,OAA0B,EACV,6BAAqC,EAC/C,mBAA4B,EAChB,qBAA6B,EAC3F,cAA8B;QAJc,YAAO,GAAP,OAAO,CAAmB;QACV,kCAA6B,GAA7B,6BAA6B,CAAQ;QAC/C,wBAAmB,GAAnB,mBAAmB,CAAS;QAChB,0BAAqB,GAArB,qBAAqB,CAAQ;QAC3F,mBAAc,GAAd,cAAc,CAAgB;IAClE,CAAC;IAEM,KAAK,CAAC,OAAe,EAAE,KAAW,EAAE,SAAiB,aAAa;QACvE,OAAO,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,4BAAY,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;IAC9D,CAAC;IAEM,QAAQ,CAAC,OAAe,EAAE,KAAW,EAAE,SAAiB,aAAa;QAC1E,OAAO,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,4BAAY,CAAC,QAAQ,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;IACjE,CAAC;IAEM,KAAK,CAAC,OAAe,EAAE,KAAW,EAAE,SAAiB,aAAa;QACvE,OAAO,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,4BAAY,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;IAC9D,CAAC;IAEM,IAAI,CAAC,OAAe,EAAE,KAAW,EAAE,SAAiB,aAAa;QACtE,OAAO,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,4BAAY,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;IAC7D,CAAC;IAEM,OAAO,CAAC,OAAe,EAAE,KAAW,EAAE,SAAiB,aAAa;QACzE,OAAO,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,4BAAY,CAAC,OAAO,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;IAChE,CAAC;IAEO,GAAG,CAAC,OAAe,EAAE,WAAyB,4BAAY,CAAC,KAAK,EAAE,KAAW,EAAE,SAAiB,aAAa;QACnH,MAAM,GAAG,GAAG,IAAI,oBAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QAC5C,GAAG,CAAC,qBAAqB,GAAG,IAAI,CAAC,qBAAqB,CAAC;QACvD,GAAG,CAAC,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC;QAC1C,GAAG,CAAC,KAAK,GAAG,KAAK,CAAC;QAClB,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC;QACpB,GAAG,CAAC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAEtB,wIAAwI;QACxI,yFAAyF;QACzF,IAAG,IAAI,CAAC,mBAAmB,EAAE;YAC3B,MAAM,WAAW,GAAG,aAAK,CAAC,cAAc,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC;YAEtD,mHAAmH;YACnH,yCAAyC;YACzC,KAAK,MAAM,UAAU,IAAI,WAAW,CAAC,UAAU,EAAE;gBAC/C,IAAG,UAAU,CAAC,SAAS,KAAK,SAAS,IAAI,UAAU,CAAC,SAAS,KAAK,EAAE,IAAI,UAAU,CAAC,SAAS,CAAC,UAAU,CAAC,YAAY,CAAC,IAAI,UAAU,CAAC,SAAS,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE;oBACjK,SAAS;iBACV;gBAED,WAAW,CAAC,cAAc,GAAG,UAAU,CAAC;gBACxC,MAAM;aACP;YAED,GAAG,CAAC,KAAK,CAAC,eAAe,CAAC,GAAG,WAAW,CAAC;SAC1C;QAED,KAAI,MAAM,MAAM,IAAI,IAAI,CAAC,OAAO,EAAC;YAC/B,IAAG,MAAM,CAAC,QAAQ,EAAE,EAAE;gBACpB,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;aACjC;SACF;IACH,CAAC;CACF,CAAA;AA9DY,UAAU;IAFtB,YAAG,CAAC,qBAAqB,CAAC;IAC1B,qBAAU,EAAE;IAGS,WAAA,oBAAS,CAAC,iCAAwB,CAAC,MAAM,CAAC,CAAA;IAC1C,WAAA,iBAAM,CAAC,kDAAkD,CAAC,CAAA;IAC1D,WAAA,iBAAM,CAAC,wCAAwC,CAAC,CAAA;IAChD,WAAA,iBAAM,CAAC,uCAA8B,CAAC,qBAAqB,CAAC,CAAA;qEAC5B,uBAAc;GANvD,UAAU,CA8DtB;AA9DY,gCAAU"}
+{"version":3,"file":"log.handler.js","sourceRoot":"","sources":["../../../../src/handlers/log.handler.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,4BAAyB;AACzB,uCAAkE;AAClE,0DAAoD;AACpD,mDAA6C;AAE7C,gDAAkH;AAElH,0CAAqC;AAErC;;;;GAIG;AAGH,IAAa,UAAU,GAAvB,MAAa,UAAU;IAErB;;;;;;;OAOG;IACH,YAAgF,OAA0B,EACV,6BAAqC,EAC/C,mBAA4B,EAChB,qBAA6B,EAC3F,cAA8B;QAJc,YAAO,GAAP,OAAO,CAAmB;QACV,kCAA6B,GAA7B,6BAA6B,CAAQ;QAC/C,wBAAmB,GAAnB,mBAAmB,CAAS;QAChB,0BAAqB,GAArB,qBAAqB,CAAQ;QAC3F,mBAAc,GAAd,cAAc,CAAgB;IAClE,CAAC;IAED;;;;;;OAMG;IACI,QAAQ,CAAC,OAAe,EAAE,KAAW,EAAE,SAAiB,aAAa;QAC1E,OAAO,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,4BAAY,CAAC,QAAQ,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,OAAe,EAAE,KAAW,EAAE,SAAiB,aAAa;QACvE,OAAO,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,4BAAY,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;OAMG;IACI,OAAO,CAAC,OAAe,EAAE,KAAW,EAAE,SAAiB,aAAa;QACzE,OAAO,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,4BAAY,CAAC,OAAO,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;OAMG;IACI,IAAI,CAAC,OAAe,EAAE,KAAW,EAAE,SAAiB,aAAa;QACtE,OAAO,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,4BAAY,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,OAAe,EAAE,KAAW,EAAE,SAAiB,aAAa;QACvE,OAAO,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,4BAAY,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;OAMG;IACK,GAAG,CAAC,OAAe,EAAE,WAAyB,4BAAY,CAAC,KAAK,EAAE,KAAW,EAAE,SAAiB,aAAa;QACnH,MAAM,GAAG,GAAG,IAAI,oBAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QAC5C,GAAG,CAAC,qBAAqB,GAAG,IAAI,CAAC,qBAAqB,CAAC;QACvD,GAAG,CAAC,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC;QAC1C,GAAG,CAAC,KAAK,GAAG,KAAK,CAAC;QAClB,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC;QACpB,GAAG,CAAC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAEtB,wIAAwI;QACxI,yFAAyF;QACzF,IAAG,IAAI,CAAC,mBAAmB,EAAE;YAC3B,MAAM,WAAW,GAAG,aAAK,CAAC,cAAc,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC;YAEtD,mHAAmH;YACnH,yCAAyC;YACzC,KAAK,MAAM,UAAU,IAAI,WAAW,CAAC,UAAU,EAAE;gBAC/C,IAAG,UAAU,CAAC,SAAS,KAAK,SAAS,IAAI,UAAU,CAAC,SAAS,KAAK,EAAE,IAAI,UAAU,CAAC,SAAS,CAAC,UAAU,CAAC,YAAY,CAAC,IAAI,UAAU,CAAC,SAAS,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE;oBACjK,SAAS;iBACV;gBAED,WAAW,CAAC,cAAc,GAAG,UAAU,CAAC;gBACxC,MAAM;aACP;YAED,GAAG,CAAC,KAAK,CAAC,eAAe,CAAC,GAAG,WAAW,CAAC;SAC1C;QAED,yCAAyC;QACzC,KAAI,MAAM,MAAM,IAAI,IAAI,CAAC,OAAO,EAAC;YAC/B,IAAG,MAAM,CAAC,QAAQ,EAAE,EAAE;gBACpB,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;aACjC;SACF;IACH,CAAC;CACF,CAAA;AAjHY,UAAU;IAFtB,YAAG,CAAC,qBAAqB,CAAC;IAC1B,qBAAU,EAAE;IAWS,WAAA,oBAAS,CAAC,iCAAwB,CAAC,MAAM,CAAC,CAAA;IAC1C,WAAA,iBAAM,CAAC,kDAAkD,CAAC,CAAA;IAC1D,WAAA,iBAAM,CAAC,wCAAwC,CAAC,CAAA;IAChD,WAAA,iBAAM,CAAC,uCAA8B,CAAC,qBAAqB,CAAC,CAAA;qEAC5B,uBAAc;GAdvD,UAAU,CAiHtB;AAjHY,gCAAU"}

package/dist/lib/cjs/loggers/base.logger.js

@@ -5,7 +5,32 @@ const severity_enum_1 = require("../enums/severity.enum");
 const utils_1 = require("../utils/utils");
 const common_1 = require("@pristine-ts/common");
 const output_mode_enum_1 = require("../enums/output-mode.enum");
+/**
+ * The BaseLogger is the base abstract class that all internal loggers should extend.
+ * It defines the basic logic that applies to all internal loggers.
+ * External loggers could extend the base logger but it is not mandatory.
+ */
 class BaseLogger {
+    /**
+     * The BaseLogger is the base abstract class that all loggers should extend.
+     * It defines the basic logic that applies to all loggers.
+     * @param numberOfStackedLogs The number of logs to keep in the stack and to print once a log with a high enough severity arrives.
+     * @param logSeverityLevelConfiguration The number representing the severity from which logs should be outputted.
+     * For example, if this is set to 3, any log that has a severity of Error(3) or critical(4) will be outputted.
+     * @param logDebugDepthConfiguration The number of level to go down in an object when printing a log with the Debug severity.
+     * We often do not need to go to the bottom layer of an object, so we can truncate at a certain depth.
+     * @param logInfoDepthConfiguration The number of level to go down in an object when printing a log with the Info severity.
+     * We often do not need to go to the bottom layer of an object, so we can truncate at a certain depth.
+     * @param logWarningDepthConfiguration The number of level to go down in an object when printing a log with the Warning severity.
+     * We often do not need to go to the bottom layer of an object, so we can truncate at a certain depth.
+     * @param logErrorDepthConfiguration The number of level to go down in an object when printing a log with the Error severity.
+     * We often do not need to go to the bottom layer of an object, so we can truncate at a certain depth.
+     * @param logCriticalDepthConfiguration The number of level to go down in an object when printing a log with the Critical severity.
+     * We often do not need to go to the bottom layer of an object, so we can truncate at a certain depth.
+     * @param isActivated Whether or not this particular logger is activated and should output logs.
+     * @param outputMode The output mode, that the logger should use.
+     * @param spaces The number of spaces to indent the outputted logs.
+     */
     constructor(numberOfStackedLogs, logSeverityLevelConfiguration, logDebugDepthConfiguration, logInfoDepthConfiguration, logWarningDepthConfiguration, logErrorDepthConfiguration, logCriticalDepthConfiguration, isActivated = true, outputMode = output_mode_enum_1.OutputModeEnum.Json, spaces = 2) {
         this.numberOfStackedLogs = numberOfStackedLogs;
         this.logSeverityLevelConfiguration = logSeverityLevelConfiguration;
@@ -17,12 +42,23 @@ class BaseLogger {
         this.isActivated = isActivated;
         this.outputMode = outputMode;
         this.spaces = spaces;
+        /**
+         * The stacked logs are the logs that were not outputted right away but that will need to be outputted if a log with a higher severity arrives.
+         * @private
+         */
         this.stackedLogs = {};
     }
+    /**
+     * Returns whether this particular logger is active and should output logs.
+     */
     isActive() {
         return this.isActivated;
     }
-    outputLog(log) {
+    /**
+     * Gets the formatted output log based on a log model.
+     * @param log The log to be formatted.
+     */
+    getFormattedOutputLog(log) {
         switch (log.severity) {
             case severity_enum_1.SeverityEnum.Debug:
                 return utils_1.Utils.outputLog(log, this.outputMode, this.logDebugDepthConfiguration);
@@ -36,6 +72,11 @@ class BaseLogger {
                 return utils_1.Utils.outputLog(log, this.outputMode, this.logCriticalDepthConfiguration);
         }
     }
+    /**
+     * Captures the log and evaluates which logs need to be outputted or stacked.
+     * @param log The log to be captured.
+     * @protected
+     */
     captureLog(log) {
         if (this.numberOfStackedLogs > 0) {
             this.setupStackedLogsArrayIfRequired(log.traceId);
@@ -50,6 +91,11 @@ class BaseLogger {
             this.log(log);
         }
     }
+    /**
+     * Sets up the stack of logs if it is required.
+     * @param traceId Optional trace id to stack logs based on different requests.
+     * @private
+     */
     setupStackedLogsArrayIfRequired(traceId) {
         var _a;
         if (this.stackedLogs.hasOwnProperty(common_1.CommonModuleKeyname) === false) {
@@ -59,6 +105,11 @@ class BaseLogger {
             this.stackedLogs[traceId] = (_a = this.stackedLogs[common_1.CommonModuleKeyname]) !== null && _a !== void 0 ? _a : [];
         }
     }
+    /**
+     * Adds the log to the stacked logs and makes sure we only keep the right amount of stacked logs.
+     * @param log The log to be added.
+     * @private
+     */
     addStackedLog(log) {
         var _a;
         const stackedLogsKey = (_a = log.traceId) !== null && _a !== void 0 ? _a : common_1.CommonModuleKeyname;
@@ -71,6 +122,11 @@ class BaseLogger {
             } while (this.stackedLogs[stackedLogsKey].length > this.numberOfStackedLogs);
         }
     }
+    /**
+     * Outputs the stacked logs.
+     * @param traceId Optional trace id so that we only output the stacked logs for this trace.
+     * @private
+     */
     outputStackedLogs(traceId) {
         for (const log of this.stackedLogs[common_1.CommonModuleKeyname]) {
             this.log(log);
@@ -83,6 +139,11 @@ class BaseLogger {
         }
         this.clearStackedLogs(traceId);
     }
+    /**
+     * Clears the stacked logs.
+     * @param traceId Optional trace id so that we only remove the stacked logs for this trace.
+     * @private
+     */
     clearStackedLogs(traceId) {
         this.stackedLogs[common_1.CommonModuleKeyname] = [];
         if (traceId === undefined || this.stackedLogs.hasOwnProperty(traceId) === false) {

package/dist/lib/cjs/loggers/base.logger.js.map

@@ -1 +1 @@
-{"version":3,"file":"base.logger.js","sourceRoot":"","sources":["../../../../src/loggers/base.logger.ts"],"names":[],"mappings":";;;AACA,0DAAoD;AACpD,0CAAqC;AACrC,gDAAwD;AAExD,gEAAyD;AAEzD,MAAsB,UAAU;IAG5B,YACuB,mBAA2B,EAC3B,6BAAqC,EACrC,0BAAkC,EAClC,yBAAiC,EACjC,4BAAoC,EACpC,0BAAkC,EAClC,6BAAqC,EACvC,cAAc,IAAI,EAChB,aAAa,iCAAc,CAAC,IAAI,EAChC,SAAS,CAAC;QATV,wBAAmB,GAAnB,mBAAmB,CAAQ;QAC3B,kCAA6B,GAA7B,6BAA6B,CAAQ;QACrC,+BAA0B,GAA1B,0BAA0B,CAAQ;QAClC,8BAAyB,GAAzB,yBAAyB,CAAQ;QACjC,iCAA4B,GAA5B,4BAA4B,CAAQ;QACpC,+BAA0B,GAA1B,0BAA0B,CAAQ;QAClC,kCAA6B,GAA7B,6BAA6B,CAAQ;QACvC,gBAAW,GAAX,WAAW,CAAO;QAChB,eAAU,GAAV,UAAU,CAAsB;QAChC,WAAM,GAAN,MAAM,CAAI;QAZzB,gBAAW,GAAkC,EAAE,CAAC;IAaxD,CAAC;IAIM,QAAQ;QACX,OAAO,IAAI,CAAC,WAAW,CAAC;IAC5B,CAAC;IAEM,SAAS,CAAC,GAAa;QAC1B,QAAQ,GAAG,CAAC,QAAQ,EAAE;YAClB,KAAK,4BAAY,CAAC,KAAK;gBACnB,OAAO,aAAK,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,0BAA0B,CAAC,CAAC;YAElF,KAAK,4BAAY,CAAC,IAAI;gBAClB,OAAO,aAAK,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,yBAAyB,CAAC,CAAC;YAEjF,KAAK,4BAAY,CAAC,OAAO;gBACrB,OAAO,aAAK,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,4BAA4B,CAAC,CAAA;YAEnF,KAAK,4BAAY,CAAC,KAAK;gBACnB,OAAO,aAAK,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,0BAA0B,CAAC,CAAA;YAEjF,KAAK,4BAAY,CAAC,QAAQ;gBACtB,OAAO,aAAK,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,6BAA6B,CAAC,CAAA;SACvF;IACL,CAAC;IAIS,UAAU,CAAC,GAAa;QAC9B,IAAI,IAAI,CAAC,mBAAmB,GAAG,CAAC,EAAE;YAC9B,IAAI,CAAC,+BAA+B,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;YAElD,IAAI,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC,6BAA6B,EAAE;gBACnD,2FAA2F;gBAC3F,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;gBAExB,OAAO;aACV;YAED,IAAI,CAAC,iBAAiB,EAAE,CAAC;SAC5B;QAED,IAAI,GAAG,CAAC,QAAQ,IAAI,IAAI,CAAC,6BAA6B,EAAE;YACpD,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;SACjB;IACL,CAAC;IAEO,+BAA+B,CAAC,OAAgB;;QACpD,IAAI,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,4BAAmB,CAAC,KAAK,KAAK,EAAE;YAChE,IAAI,CAAC,WAAW,CAAC,4BAAmB,CAAC,GAAG,EAAE,CAAC;SAC9C;QAED,IAAI,OAAO,IAAI,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,OAAO,CAAC,KAAK,KAAK,EAAE;YAC/D,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,MAAA,IAAI,CAAC,WAAW,CAAC,4BAAmB,CAAC,mCAAI,EAAE,CAAC;SAC3E;IACL,CAAC;IAEO,aAAa,CAAC,GAAa;;QAC/B,MAAM,cAAc,GAAG,MAAA,GAAG,CAAC,OAAO,mCAAI,4BAAmB,CAAC;QAE1D,uCAAuC;QACvC,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAE3C,yFAAyF;QACzF,IAAI,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC,MAAM,IAAI,IAAI,CAAC,mBAAmB,EAAE;YACrE,GAAG;gBACC,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC,KAAK,EAAE,CAAC;aAC5C,QAAQ,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC,MAAM,GAAG,IAAI,CAAC,mBAAmB,EAAC;SAC/E;IACL,CAAC;IAEO,iBAAiB,CAAC,OAAgB;QACtC,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,WAAW,CAAC,4BAAmB,CAAC,EAAE;YACrD,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;SACjB;QAED,IAAI,OAAO,KAAK,SAAS,IAAI,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,OAAO,CAAC,KAAK,KAAK,EAAE;YAC7E,OAAO;SACV;QAED,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE;YACzC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;SACjB;QAED,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACnC,CAAC;IAEO,gBAAgB,CAAC,OAAgB;QACrC,IAAI,CAAC,WAAW,CAAC,4BAAmB,CAAC,GAAG,EAAE,CAAC;QAE3C,IAAI,OAAO,KAAK,SAAS,IAAI,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,OAAO,CAAC,KAAK,KAAK,EAAE;YAC7E,OAAO;SACV;QAED,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;IACnC,CAAC;CACJ;AA/GD,gCA+GC"}
+{"version":3,"file":"base.logger.js","sourceRoot":"","sources":["../../../../src/loggers/base.logger.ts"],"names":[],"mappings":";;;AACA,0DAAoD;AACpD,0CAAqC;AACrC,gDAAwD;AACxD,gEAAyD;AAEzD;;;;GAIG;AACH,MAAsB,UAAU;IAQ5B;;;;;;;;;;;;;;;;;;;OAmBG;IACH,YACuB,mBAA2B,EAC3B,6BAAqC,EACrC,0BAAkC,EAClC,yBAAiC,EACjC,4BAAoC,EACpC,0BAAkC,EAClC,6BAAqC,EACvC,cAAc,IAAI,EAChB,aAAa,iCAAc,CAAC,IAAI,EAChC,SAAS,CAAC;QATV,wBAAmB,GAAnB,mBAAmB,CAAQ;QAC3B,kCAA6B,GAA7B,6BAA6B,CAAQ;QACrC,+BAA0B,GAA1B,0BAA0B,CAAQ;QAClC,8BAAyB,GAAzB,yBAAyB,CAAQ;QACjC,iCAA4B,GAA5B,4BAA4B,CAAQ;QACpC,+BAA0B,GAA1B,0BAA0B,CAAQ;QAClC,kCAA6B,GAA7B,6BAA6B,CAAQ;QACvC,gBAAW,GAAX,WAAW,CAAO;QAChB,eAAU,GAAV,UAAU,CAAsB;QAChC,WAAM,GAAN,MAAM,CAAI;QApCjC;;;WAGG;QACK,gBAAW,GAAkC,EAAE,CAAC;IAiCxD,CAAC;IAQD;;OAEG;IACI,QAAQ;QACX,OAAO,IAAI,CAAC,WAAW,CAAC;IAC5B,CAAC;IAED;;;OAGG;IACI,qBAAqB,CAAC,GAAa;QACtC,QAAQ,GAAG,CAAC,QAAQ,EAAE;YAClB,KAAK,4BAAY,CAAC,KAAK;gBACnB,OAAO,aAAK,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,0BAA0B,CAAC,CAAC;YAElF,KAAK,4BAAY,CAAC,IAAI;gBAClB,OAAO,aAAK,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,yBAAyB,CAAC,CAAC;YAEjF,KAAK,4BAAY,CAAC,OAAO;gBACrB,OAAO,aAAK,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,4BAA4B,CAAC,CAAA;YAEnF,KAAK,4BAAY,CAAC,KAAK;gBACnB,OAAO,aAAK,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,0BAA0B,CAAC,CAAA;YAEjF,KAAK,4BAAY,CAAC,QAAQ;gBACtB,OAAO,aAAK,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,6BAA6B,CAAC,CAAA;SACvF;IACL,CAAC;IASD;;;;OAIG;IACO,UAAU,CAAC,GAAa;QAC9B,IAAI,IAAI,CAAC,mBAAmB,GAAG,CAAC,EAAE;YAC9B,IAAI,CAAC,+BAA+B,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;YAElD,IAAI,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC,6BAA6B,EAAE;gBACnD,2FAA2F;gBAC3F,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;gBAExB,OAAO;aACV;YAED,IAAI,CAAC,iBAAiB,EAAE,CAAC;SAC5B;QAED,IAAI,GAAG,CAAC,QAAQ,IAAI,IAAI,CAAC,6BAA6B,EAAE;YACpD,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;SACjB;IACL,CAAC;IAED;;;;OAIG;IACK,+BAA+B,CAAC,OAAgB;;QACpD,IAAI,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,4BAAmB,CAAC,KAAK,KAAK,EAAE;YAChE,IAAI,CAAC,WAAW,CAAC,4BAAmB,CAAC,GAAG,EAAE,CAAC;SAC9C;QAED,IAAI,OAAO,IAAI,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,OAAO,CAAC,KAAK,KAAK,EAAE;YAC/D,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,MAAA,IAAI,CAAC,WAAW,CAAC,4BAAmB,CAAC,mCAAI,EAAE,CAAC;SAC3E;IACL,CAAC;IAED;;;;OAIG;IACK,aAAa,CAAC,GAAa;;QAC/B,MAAM,cAAc,GAAG,MAAA,GAAG,CAAC,OAAO,mCAAI,4BAAmB,CAAC;QAE1D,uCAAuC;QACvC,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAE3C,yFAAyF;QACzF,IAAI,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC,MAAM,IAAI,IAAI,CAAC,mBAAmB,EAAE;YACrE,GAAG;gBACC,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC,KAAK,EAAE,CAAC;aAC5C,QAAQ,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC,MAAM,GAAG,IAAI,CAAC,mBAAmB,EAAC;SAC/E;IACL,CAAC;IAED;;;;OAIG;IACK,iBAAiB,CAAC,OAAgB;QACtC,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,WAAW,CAAC,4BAAmB,CAAC,EAAE;YACrD,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;SACjB;QAED,IAAI,OAAO,KAAK,SAAS,IAAI,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,OAAO,CAAC,KAAK,KAAK,EAAE;YAC7E,OAAO;SACV;QAED,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE;YACzC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;SACjB;QAED,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACnC,CAAC;IAED;;;;OAIG;IACK,gBAAgB,CAAC,OAAgB;QACrC,IAAI,CAAC,WAAW,CAAC,4BAAmB,CAAC,GAAG,EAAE,CAAC;QAE3C,IAAI,OAAO,KAAK,SAAS,IAAI,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,OAAO,CAAC,KAAK,KAAK,EAAE;YAC7E,OAAO;SACV;QAED,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;IACnC,CAAC;CACJ;AAjLD,gCAiLC"}

package/dist/lib/cjs/loggers/console.logger.js

@@ -20,11 +20,38 @@ const common_1 = require("@pristine-ts/common");
 const output_mode_enum_1 = require("../enums/output-mode.enum");
 const logging_module_keyname_1 = require("../logging.module.keyname");
 const base_logger_1 = require("./base.logger");
+/**
+ * The ConsoleLogger outputs the logs in the console.
+ * It is registered with the tag Logger so that it can be injected along with all the other Loggers.
+ * It is module scoped to the logging module so that it is only registered if the logging module is imported.
+ */
 let ConsoleLogger = class ConsoleLogger extends base_logger_1.BaseLogger {
-    constructor(numberOfStackedLogs, logSeverityLevelConfiguration, logDebugDepthConfiguration, logInfoDepthConfiguration, logWarningDepthConfiguration, logErrorDepthConfiguration, logCriticalDepthConfiguration, isActive, outputMode) {
-        super(numberOfStackedLogs, logSeverityLevelConfiguration, logDebugDepthConfiguration, logInfoDepthConfiguration, logWarningDepthConfiguration, logErrorDepthConfiguration, logCriticalDepthConfiguration, isActive, outputMode);
+    /**
+     * The ConsoleLogger outputs the logs in the console.
+     * @param numberOfStackedLogs The number of logs to keep in the stack and to print once a log with a high enough severity arrives.
+     * @param logSeverityLevelConfiguration The number representing the severity from which logs should be outputted.
+     * For example, if this is set to 3, any log that has a severity of Error(3) or critical(4) will be outputted.
+     * @param logDebugDepthConfiguration The number of level to go down in an object when printing a log with the Debug severity.
+     * We often do not need to go to the bottom layer of an object, so we can truncate at a certain depth.
+     * @param logInfoDepthConfiguration The number of level to go down in an object when printing a log with the Info severity.
+     * We often do not need to go to the bottom layer of an object, so we can truncate at a certain depth.
+     * @param logWarningDepthConfiguration The number of level to go down in an object when printing a log with the Warning severity.
+     * We often do not need to go to the bottom layer of an object, so we can truncate at a certain depth.
+     * @param logErrorDepthConfiguration The number of level to go down in an object when printing a log with the Error severity.
+     * We often do not need to go to the bottom layer of an object, so we can truncate at a certain depth.
+     * @param logCriticalDepthConfiguration The number of level to go down in an object when printing a log with the Critical severity.
+     * We often do not need to go to the bottom layer of an object, so we can truncate at a certain depth.
+     * @param isActivated Whether or not this particular logger is activated and should output logs.
+     * @param outputMode The output mode, that the logger should use.
+     */
+    constructor(numberOfStackedLogs, logSeverityLevelConfiguration, logDebugDepthConfiguration, logInfoDepthConfiguration, logWarningDepthConfiguration, logErrorDepthConfiguration, logCriticalDepthConfiguration, isActivated, outputMode) {
+        super(numberOfStackedLogs, logSeverityLevelConfiguration, logDebugDepthConfiguration, logInfoDepthConfiguration, logWarningDepthConfiguration, logErrorDepthConfiguration, logCriticalDepthConfiguration, isActivated, outputMode);
         this.initialize();
     }
+    /**
+     * Initializes the console logger.
+     * @protected
+     */
     initialize() {
         if (this.isActive()) {
             this.readableStream = new stream_1.Readable({
@@ -38,8 +65,13 @@ let ConsoleLogger = class ConsoleLogger extends base_logger_1.BaseLogger {
             });
         }
     }
+    /**
+     * Outputs the log in the console.
+     * @param log The log to be outputted
+     * @protected
+     */
     log(log) {
-        const outputLog = this.outputLog(log);
+        const outputLog = this.getFormattedOutputLog(log);
         switch (log.severity) {
             case severity_enum_1.SeverityEnum.Debug:
                 console.debug(outputLog);

package/dist/lib/cjs/loggers/console.logger.js.map

@@ -1 +1 @@
-{"version":3,"file":"console.logger.js","sourceRoot":"","sources":["../../../../src/loggers/console.logger.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,uCAAwD;AACxD,0DAAoD;AAGpD,mCAAgC;AAGhC,gDAAqG;AACrG,gEAAyD;AAEzD,sEAA+D;AAC/D,+CAAyC;AAMzC,IAAa,aAAa,GAA1B,MAAa,aAAc,SAAQ,wBAAU;IAG3C,YAAqE,mBAA2B,EACjB,6BAAqC,EACxC,0BAAkC,EACnC,yBAAiC,EAC9B,4BAAoC,EACtC,0BAAkC,EAC/B,6BAAqC,EAC5C,QAAiB,EAChB,UAA0B;QAEjG,KAAK,CAAC,mBAAmB,EACrB,6BAA6B,EAC7B,0BAA0B,EAC1B,yBAAyB,EACzB,4BAA4B,EAC5B,0BAA0B,EAC1B,6BAA6B,EAC7B,QAAQ,EACR,UAAU,CAAC,CAAC;QAEhB,IAAI,CAAC,UAAU,EAAE,CAAC;IACpB,CAAC;IAES,UAAU;QAClB,IAAG,IAAI,CAAC,QAAQ,EAAE,EAAE;YAClB,IAAI,CAAC,cAAc,GAAG,IAAI,iBAAQ,CAAC;gBACjC,UAAU,EAAE,IAAI;gBAChB,IAAI,CAAC,IAAY;oBACf,OAAO,IAAI,CAAC;gBACd,CAAC;aACF,CAAC,CAAC;YACH,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE;gBACrC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;YACzB,CAAC,CAAC,CAAC;SACJ;IACH,CAAC;IAES,GAAG,CAAC,GAAa;QACzB,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QAEtC,QAAQ,GAAG,CAAC,QAAQ,EAAE;YACpB,KAAK,4BAAY,CAAC,KAAK;gBACrB,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;gBACzB,MAAM;YAER,KAAK,4BAAY,CAAC,IAAI;gBACpB,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;gBACxB,MAAM;YAER,KAAK,4BAAY,CAAC,OAAO;gBACvB,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;gBACxB,MAAM;YAER,KAAK,4BAAY,CAAC,KAAK;gBACrB,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;gBACzB,MAAM;YAER,KAAK,4BAAY,CAAC,QAAQ;gBACxB,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;gBACzB,MAAM;SACT;IACH,CAAC;CACF,CAAA;AAjEY,aAAa;IAJzB,qBAAY,CAAC,6CAAoB,CAAC;IAClC,oBAAS,EAAE;IACX,YAAG,CAAC,iCAAwB,CAAC,MAAM,CAAC;IACpC,qBAAU,EAAE;IAIS,WAAA,iBAAM,CAAC,wCAAwC,CAAC,CAAA;IAChD,WAAA,iBAAM,CAAC,kDAAkD,CAAC,CAAA;IAC1D,WAAA,iBAAM,CAAC,+CAA+C,CAAC,CAAA;IACvD,WAAA,iBAAM,CAAC,8CAA8C,CAAC,CAAA;IACtD,WAAA,iBAAM,CAAC,iDAAiD,CAAC,CAAA;IACzD,WAAA,iBAAM,CAAC,+CAA+C,CAAC,CAAA;IACvD,WAAA,iBAAM,CAAC,kDAAkD,CAAC,CAAA;IAC1D,WAAA,iBAAM,CAAC,2CAA2C,CAAC,CAAA;IACnD,WAAA,iBAAM,CAAC,4CAA4C,CAAC,CAAA;;GAX7D,aAAa,CAiEzB;AAjEY,sCAAa"}
+{"version":3,"file":"console.logger.js","sourceRoot":"","sources":["../../../../src/loggers/console.logger.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,uCAAwD;AACxD,0DAAoD;AAGpD,mCAAgC;AAGhC,gDAAqG;AACrG,gEAAyD;AAEzD,sEAA+D;AAC/D,+CAAyC;AAEzC;;;;GAIG;AAKH,IAAa,aAAa,GAA1B,MAAa,aAAc,SAAQ,wBAAU;IAO3C;;;;;;;;;;;;;;;;;OAiBG;IACH,YAAqE,mBAA2B,EACjB,6BAAqC,EACxC,0BAAkC,EACnC,yBAAiC,EAC9B,4BAAoC,EACtC,0BAAkC,EAC/B,6BAAqC,EAC5C,WAAoB,EACnB,UAA0B;QAEjG,KAAK,CAAC,mBAAmB,EACrB,6BAA6B,EAC7B,0BAA0B,EAC1B,yBAAyB,EACzB,4BAA4B,EAC5B,0BAA0B,EAC1B,6BAA6B,EAC7B,WAAW,EACX,UAAU,CAAC,CAAC;QAEhB,IAAI,CAAC,UAAU,EAAE,CAAC;IACpB,CAAC;IAED;;;OAGG;IACO,UAAU;QAClB,IAAG,IAAI,CAAC,QAAQ,EAAE,EAAE;YAClB,IAAI,CAAC,cAAc,GAAG,IAAI,iBAAQ,CAAC;gBACjC,UAAU,EAAE,IAAI;gBAChB,IAAI,CAAC,IAAY;oBACf,OAAO,IAAI,CAAC;gBACd,CAAC;aACF,CAAC,CAAC;YACH,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE;gBACrC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;YACzB,CAAC,CAAC,CAAC;SACJ;IACH,CAAC;IAED;;;;OAIG;IACO,GAAG,CAAC,GAAa;QACzB,MAAM,SAAS,GAAG,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAC;QAElD,QAAQ,GAAG,CAAC,QAAQ,EAAE;YACpB,KAAK,4BAAY,CAAC,KAAK;gBACrB,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;gBACzB,MAAM;YAER,KAAK,4BAAY,CAAC,IAAI;gBACpB,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;gBACxB,MAAM;YAER,KAAK,4BAAY,CAAC,OAAO;gBACvB,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;gBACxB,MAAM;YAER,KAAK,4BAAY,CAAC,KAAK;gBACrB,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;gBACzB,MAAM;YAER,KAAK,4BAAY,CAAC,QAAQ;gBACxB,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;gBACzB,MAAM;SACT;IACH,CAAC;CACF,CAAA;AAhGY,aAAa;IAJzB,qBAAY,CAAC,6CAAoB,CAAC;IAClC,oBAAS,EAAE;IACX,YAAG,CAAC,iCAAwB,CAAC,MAAM,CAAC;IACpC,qBAAU,EAAE;IA0BS,WAAA,iBAAM,CAAC,wCAAwC,CAAC,CAAA;IAChD,WAAA,iBAAM,CAAC,kDAAkD,CAAC,CAAA;IAC1D,WAAA,iBAAM,CAAC,+CAA+C,CAAC,CAAA;IACvD,WAAA,iBAAM,CAAC,8CAA8C,CAAC,CAAA;IACtD,WAAA,iBAAM,CAAC,iDAAiD,CAAC,CAAA;IACzD,WAAA,iBAAM,CAAC,+CAA+C,CAAC,CAAA;IACvD,WAAA,iBAAM,CAAC,kDAAkD,CAAC,CAAA;IAC1D,WAAA,iBAAM,CAAC,2CAA2C,CAAC,CAAA;IACnD,WAAA,iBAAM,CAAC,4CAA4C,CAAC,CAAA;;GAjC7D,aAAa,CAgGzB;AAhGY,sCAAa"}

package/dist/lib/cjs/loggers/file.logger.js

@@ -24,12 +24,41 @@ const fs_1 = __importDefault(require("fs"));
 const logging_module_keyname_1 = require("../logging.module.keyname");
 const output_mode_enum_1 = require("../enums/output-mode.enum");
 const base_logger_1 = require("./base.logger");
+/**
+ * The FileLogger outputs the logs into file.
+ * It is registered with the tag Logger so that it can be injected along with all the other Loggers.
+ * It is module scoped to the logging module so that it is only registered if the logging module is imported.
+ */
 let FileLogger = class FileLogger extends base_logger_1.BaseLogger {
-    constructor(numberOfStackedLogs, logSeverityLevelConfiguration, logDebugDepthConfiguration, logInfoDepthConfiguration, logWarningDepthConfiguration, logErrorDepthConfiguration, logCriticalDepthConfiguration, isActive, outputMode, fileLoggerPretty, filePath) {
-        super(numberOfStackedLogs, logSeverityLevelConfiguration, logDebugDepthConfiguration, logInfoDepthConfiguration, logWarningDepthConfiguration, logErrorDepthConfiguration, logCriticalDepthConfiguration, isActive, outputMode, fileLoggerPretty ? 2 : 0);
+    /**
+     * The ConsoleLogger outputs the logs in the console.
+     * @param numberOfStackedLogs The number of logs to keep in the stack and to print once a log with a high enough severity arrives.
+     * @param logSeverityLevelConfiguration The number representing the severity from which logs should be outputted.
+     * For example, if this is set to 3, any log that has a severity of Error(3) or critical(4) will be outputted.
+     * @param logDebugDepthConfiguration The number of level to go down in an object when printing a log with the Debug severity.
+     * We often do not need to go to the bottom layer of an object, so we can truncate at a certain depth.
+     * @param logInfoDepthConfiguration The number of level to go down in an object when printing a log with the Info severity.
+     * We often do not need to go to the bottom layer of an object, so we can truncate at a certain depth.
+     * @param logWarningDepthConfiguration The number of level to go down in an object when printing a log with the Warning severity.
+     * We often do not need to go to the bottom layer of an object, so we can truncate at a certain depth.
+     * @param logErrorDepthConfiguration The number of level to go down in an object when printing a log with the Error severity.
+     * We often do not need to go to the bottom layer of an object, so we can truncate at a certain depth.
+     * @param logCriticalDepthConfiguration The number of level to go down in an object when printing a log with the Critical severity.
+     * We often do not need to go to the bottom layer of an object, so we can truncate at a certain depth.
+     * @param isActivated Whether or not this particular logger is activated and should output logs.
+     * @param outputMode The output mode, that the logger should use.
+     * @param fileLoggerPretty Whether or not the file logger should prettify the output.
+     * @param filePath The file path where to output the log.
+     */
+    constructor(numberOfStackedLogs, logSeverityLevelConfiguration, logDebugDepthConfiguration, logInfoDepthConfiguration, logWarningDepthConfiguration, logErrorDepthConfiguration, logCriticalDepthConfiguration, isActivated, outputMode, fileLoggerPretty, filePath) {
+        super(numberOfStackedLogs, logSeverityLevelConfiguration, logDebugDepthConfiguration, logInfoDepthConfiguration, logWarningDepthConfiguration, logErrorDepthConfiguration, logCriticalDepthConfiguration, isActivated, outputMode, fileLoggerPretty ? 2 : 0);
         this.filePath = filePath;
         this.initialize();
     }
+    /**
+     * Initializes the file logger, and opens the write stream.
+     * @protected
+     */
     initialize() {
         if (this.isActive()) {
             this.readableStream = new stream_1.Readable({
@@ -44,8 +73,13 @@ let FileLogger = class FileLogger extends base_logger_1.BaseLogger {
             });
         }
     }
+    /**
+     * Outputs the log in the file.
+     * @param log The log to be outputted
+     * @protected
+     */
     log(log) {
-        const outputLog = this.outputLog(log) + ";\n";
+        const outputLog = this.getFormattedOutputLog(log) + ";\n";
         switch (log.severity) {
             case severity_enum_1.SeverityEnum.Debug:
                 this.writableStream.write(outputLog);

package/dist/lib/cjs/loggers/file.logger.js.map

@@ -1 +1 @@
-{"version":3,"file":"file.logger.js","sourceRoot":"","sources":["../../../../src/loggers/file.logger.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAAA,uCAAuD;AACvD,0DAAoD;AAGpD,mCAA0C;AAC1C,gDAAgF;AAChF,4CAAoB;AACpB,sEAA+D;AAC/D,gEAAyD;AACzD,+CAAyC;AAMzC,IAAa,UAAU,GAAvB,MAAa,UAAW,SAAQ,wBAAU;IAIxC,YAAqE,mBAA2B,EACjB,6BAAqC,EACxC,0BAAkC,EACnC,yBAAiC,EAC9B,4BAAoC,EACtC,0BAAkC,EAC/B,6BAAqC,EAC/C,QAAiB,EAChB,UAA0B,EAC7B,gBAAyB,EACjB,QAAgB;QAEzF,KAAK,CAAC,mBAAmB,EACrB,6BAA6B,EAC7B,0BAA0B,EAC1B,yBAAyB,EACzB,4BAA4B,EAC5B,0BAA0B,EAC1B,6BAA6B,EAC7B,QAAQ,EACR,UAAU,EACV,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAX2C,aAAQ,GAAR,QAAQ,CAAQ;QAazF,IAAI,CAAC,UAAU,EAAE,CAAC;IACpB,CAAC;IAES,UAAU;QAClB,IAAG,IAAI,CAAC,QAAQ,EAAE,EAAE;YAClB,IAAI,CAAC,cAAc,GAAG,IAAI,iBAAQ,CAAC;gBACjC,UAAU,EAAE,IAAI;gBAChB,IAAI,CAAC,IAAY;oBACf,OAAO,IAAI,CAAC;gBACd,CAAC;aACF,CAAC,CAAC;YACH,IAAI,CAAC,cAAc,GAAG,YAAE,CAAC,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC1D,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE;gBACrC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;YACzB,CAAC,CAAC,CAAC;SACJ;IACH,CAAC;IAES,GAAG,CAAC,GAAa;QACzB,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;QAE9C,QAAQ,GAAG,CAAC,QAAQ,EAAE;YACpB,KAAK,4BAAY,CAAC,KAAK;gBACrB,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;gBACrC,MAAM;YAER,KAAK,4BAAY,CAAC,IAAI;gBACpB,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;gBACrC,MAAM;YAER,KAAK,4BAAY,CAAC,OAAO;gBACvB,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;gBACrC,MAAM;YAER,KAAK,4BAAY,CAAC,KAAK;gBACrB,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;gBACrC,MAAM;YAER,KAAK,4BAAY,CAAC,QAAQ;gBACxB,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;gBACrC,MAAM;SACT;IACH,CAAC;CACF,CAAA;AAtEY,UAAU;IAJtB,qBAAY,CAAC,6CAAoB,CAAC;IAClC,oBAAS,EAAE;IACX,YAAG,CAAC,iCAAwB,CAAC,MAAM,CAAC;IACpC,qBAAU,EAAE;IAKS,WAAA,iBAAM,CAAC,wCAAwC,CAAC,CAAA;IAChD,WAAA,iBAAM,CAAC,kDAAkD,CAAC,CAAA;IAC1D,WAAA,iBAAM,CAAC,+CAA+C,CAAC,CAAA;IACvD,WAAA,iBAAM,CAAC,8CAA8C,CAAC,CAAA;IACtD,WAAA,iBAAM,CAAC,iDAAiD,CAAC,CAAA;IACzD,WAAA,iBAAM,CAAC,+CAA+C,CAAC,CAAA;IACvD,WAAA,iBAAM,CAAC,kDAAkD,CAAC,CAAA;IAC1D,WAAA,iBAAM,CAAC,wCAAwC,CAAC,CAAA;IAChD,WAAA,iBAAM,CAAC,yCAAyC,CAAC,CAAA;IACjD,WAAA,iBAAM,CAAC,qCAAqC,CAAC,CAAA;IAC7C,YAAA,iBAAM,CAAC,6BAA6B,CAAC,CAAA;;GAd9C,UAAU,CAsEtB;AAtEY,gCAAU"}
+{"version":3,"file":"file.logger.js","sourceRoot":"","sources":["../../../../src/loggers/file.logger.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAAA,uCAAuD;AACvD,0DAAoD;AAGpD,mCAA0C;AAC1C,gDAAgF;AAChF,4CAAoB;AACpB,sEAA+D;AAC/D,gEAAyD;AACzD,+CAAyC;AAEzC;;;;GAIG;AAKH,IAAa,UAAU,GAAvB,MAAa,UAAW,SAAQ,wBAAU;IAaxC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,YAAqE,mBAA2B,EACjB,6BAAqC,EACxC,0BAAkC,EACnC,yBAAiC,EAC9B,4BAAoC,EACtC,0BAAkC,EAC/B,6BAAqC,EAC/C,WAAoB,EACnB,UAA0B,EAC7B,gBAAyB,EACjB,QAAgB;QAEzF,KAAK,CAAC,mBAAmB,EACrB,6BAA6B,EAC7B,0BAA0B,EAC1B,yBAAyB,EACzB,4BAA4B,EAC5B,0BAA0B,EAC1B,6BAA6B,EAC7B,WAAW,EACX,UAAU,EACV,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAX2C,aAAQ,GAAR,QAAQ,CAAQ;QAazF,IAAI,CAAC,UAAU,EAAE,CAAC;IACpB,CAAC;IAED;;;OAGG;IACO,UAAU;QAClB,IAAG,IAAI,CAAC,QAAQ,EAAE,EAAE;YAClB,IAAI,CAAC,cAAc,GAAG,IAAI,iBAAQ,CAAC;gBACjC,UAAU,EAAE,IAAI;gBAChB,IAAI,CAAC,IAAY;oBACf,OAAO,IAAI,CAAC;gBACd,CAAC;aACF,CAAC,CAAC;YACH,IAAI,CAAC,cAAc,GAAG,YAAE,CAAC,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC1D,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE;gBACrC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;YACzB,CAAC,CAAC,CAAC;SACJ;IACH,CAAC;IAED;;;;OAIG;IACO,GAAG,CAAC,GAAa;QACzB,MAAM,SAAS,GAAG,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;QAE1D,QAAQ,GAAG,CAAC,QAAQ,EAAE;YACpB,KAAK,4BAAY,CAAC,KAAK;gBACrB,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;gBACrC,MAAM;YAER,KAAK,4BAAY,CAAC,IAAI;gBACpB,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;gBACrC,MAAM;YAER,KAAK,4BAAY,CAAC,OAAO;gBACvB,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;gBACrC,MAAM;YAER,KAAK,4BAAY,CAAC,KAAK;gBACrB,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;gBACrC,MAAM;YAER,KAAK,4BAAY,CAAC,QAAQ;gBACxB,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;gBACrC,MAAM;SACT;IACH,CAAC;CACF,CAAA;AA5GY,UAAU;IAJtB,qBAAY,CAAC,6CAAoB,CAAC;IAClC,oBAAS,EAAE;IACX,YAAG,CAAC,iCAAwB,CAAC,MAAM,CAAC;IACpC,qBAAU,EAAE;IAkCS,WAAA,iBAAM,CAAC,wCAAwC,CAAC,CAAA;IAChD,WAAA,iBAAM,CAAC,kDAAkD,CAAC,CAAA;IAC1D,WAAA,iBAAM,CAAC,+CAA+C,CAAC,CAAA;IACvD,WAAA,iBAAM,CAAC,8CAA8C,CAAC,CAAA;IACtD,WAAA,iBAAM,CAAC,iDAAiD,CAAC,CAAA;IACzD,WAAA,iBAAM,CAAC,+CAA+C,CAAC,CAAA;IACvD,WAAA,iBAAM,CAAC,kDAAkD,CAAC,CAAA;IAC1D,WAAA,iBAAM,CAAC,wCAAwC,CAAC,CAAA;IAChD,WAAA,iBAAM,CAAC,yCAAyC,CAAC,CAAA;IACjD,WAAA,iBAAM,CAAC,qCAAqC,CAAC,CAAA;IAC7C,YAAA,iBAAM,CAAC,6BAA6B,CAAC,CAAA;;GA3C9C,UAAU,CA4GtB;AA5GY,gCAAU"}

package/dist/lib/cjs/loggers/loggers.js

@@ -11,4 +11,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./console.logger"), exports);
+__exportStar(require("./file.logger"), exports);
 //# sourceMappingURL=loggers.js.map

package/dist/lib/cjs/loggers/loggers.js.map

@@ -1 +1 @@
-{"version":3,"file":"loggers.js","sourceRoot":"","sources":["../../../../src/loggers/loggers.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,mDAAiC"}
+{"version":3,"file":"loggers.js","sourceRoot":"","sources":["../../../../src/loggers/loggers.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,mDAAiC;AACjC,gDAA8B"}

package/dist/lib/cjs/logging.module.js

@@ -19,13 +19,16 @@ const severity_enum_1 = require("./enums/severity.enum");
 __exportStar(require("./enums/enums"), exports);
 __exportStar(require("./handlers/handlers"), exports);
 __exportStar(require("./interfaces/interfaces"), exports);
-__exportStar(require("./models/models"), exports);
 __exportStar(require("./loggers/loggers"), exports);
+__exportStar(require("./models/models"), exports);
 __exportStar(require("./utils/utils"), exports);
 __exportStar(require("./logging.module.keyname"), exports);
 exports.LoggingModule = {
     keyname: logging_module_keyname_1.LoggingModuleKeyname,
     configurationDefinitions: [
+        /**
+         * The number of logs to keep in the stack and to print once a log with a high enough severity arrives.
+         */
         {
             parameterName: logging_module_keyname_1.LoggingModuleKeyname + ".numberOfStackedLogs",
             isRequired: false,
@@ -34,6 +37,10 @@ exports.LoggingModule = {
                 new configuration_1.NumberResolver(new configuration_1.EnvironmentVariableResolver("PRISTINE_LOGGING_NUMBER_OF_STACKED_LOGS")),
             ]
         },
+        /**
+         * The number representing the severity from which logs should be outputted.
+         * For example, if this is set to 3, any log that has a severity of Error(3) or critical(4) will be outputted.
+         */
         {
             parameterName: logging_module_keyname_1.LoggingModuleKeyname + ".logSeverityLevelConfiguration",
             defaultValue: severity_enum_1.SeverityEnum.Info,
@@ -42,6 +49,10 @@ exports.LoggingModule = {
                 new configuration_1.EnumResolver(new configuration_1.EnvironmentVariableResolver("PRISTINE_LOGGING_LOG_SEVERITY_LEVEL_CONFIGURATION"), severity_enum_1.SeverityEnum),
             ]
         },
+        /**
+         * The number of level to go down in an object when printing a log with the Debug severity.
+         * We often do not need to go to the bottom layer of an object, so we can truncate at a certain depth.
+         */
         {
             parameterName: logging_module_keyname_1.LoggingModuleKeyname + ".logDebugDepthConfiguration",
             defaultValue: 5,
@@ -50,6 +61,10 @@ exports.LoggingModule = {
                 new configuration_1.NumberResolver(new configuration_1.EnvironmentVariableResolver("PRISTINE_LOGGING_LOG_DEBUG_DEPTH_CONFIGURATION")),
             ]
         },
+        /**
+         * The number of level to go down in an object when printing a log with the Info severity.
+         * We often do not need to go to the bottom layer of an object, so we can truncate at a certain depth.
+         */
         {
             parameterName: logging_module_keyname_1.LoggingModuleKeyname + ".logInfoDepthConfiguration",
             defaultValue: 5,
@@ -58,6 +73,10 @@ exports.LoggingModule = {
                 new configuration_1.NumberResolver(new configuration_1.EnvironmentVariableResolver("PRISTINE_LOGGING_LOG_INFO_DEPTH_CONFIGURATION")),
             ]
         },
+        /**
+         * The number of level to go down in an object when printing a log with the Warning severity.
+         * We often do not need to go to the bottom layer of an object, so we can truncate at a certain depth.
+         */
         {
             parameterName: logging_module_keyname_1.LoggingModuleKeyname + ".logWarningDepthConfiguration",
             defaultValue: 5,
@@ -66,6 +85,10 @@ exports.LoggingModule = {
                 new configuration_1.NumberResolver(new configuration_1.EnvironmentVariableResolver("PRISTINE_LOGGING_LOG_WARNING_DEPTH_CONFIGURATION")),
             ]
         },
+        /**
+         * The number of level to go down in an object when printing a log with the Error severity.
+         * We often do not need to go to the bottom layer of an object, so we can truncate at a certain depth.
+         */
         {
             parameterName: logging_module_keyname_1.LoggingModuleKeyname + ".logErrorDepthConfiguration",
             defaultValue: 5,
@@ -74,6 +97,10 @@ exports.LoggingModule = {
                 new configuration_1.NumberResolver(new configuration_1.EnvironmentVariableResolver("PRISTINE_LOGGING_LOG_ERROR_DEPTH_CONFIGURATION")),
             ]
         },
+        /**
+         * The number of level to go down in an object when printing a log with the Critical severity.
+         * We often do not need to go to the bottom layer of an object, so we can truncate at a certain depth.
+         */
         {
             parameterName: logging_module_keyname_1.LoggingModuleKeyname + ".logCriticalDepthConfiguration",
             defaultValue: 5,
@@ -82,6 +109,9 @@ exports.LoggingModule = {
                 new configuration_1.NumberResolver(new configuration_1.EnvironmentVariableResolver("PRISTINE_LOGGING_LOG_CRITICAL_DEPTH_CONFIGURATION")),
             ]
         },
+        /**
+         * Whether or not the console logger is activated and should output logs.
+         */
         {
             parameterName: logging_module_keyname_1.LoggingModuleKeyname + ".consoleLoggerActivated",
             defaultValue: true,
@@ -90,6 +120,9 @@ exports.LoggingModule = {
                 new configuration_1.BooleanResolver(new configuration_1.EnvironmentVariableResolver("PRISTINE_LOGGING_CONSOLE_LOGGER_ACTIVATED")),
             ]
         },
+        /**
+         * The output mode, that the console logger should use from the OutputModeEnum.
+         */
         {
             parameterName: logging_module_keyname_1.LoggingModuleKeyname + ".consoleLoggerOutputMode",
             defaultValue: output_mode_enum_1.OutputModeEnum.Json,
@@ -98,6 +131,9 @@ exports.LoggingModule = {
                 new configuration_1.EnumResolver(new configuration_1.EnvironmentVariableResolver("PRISTINE_LOGGING_CONSOLE_LOGGER_OUTPUT_MODE"), output_mode_enum_1.OutputModeEnum),
             ]
         },
+        /**
+         * The output mode, that the file logger should use from the OutputModeEnum.
+         */
         {
             parameterName: logging_module_keyname_1.LoggingModuleKeyname + ".fileLoggerOutputMode",
             defaultValue: output_mode_enum_1.OutputModeEnum.Json,
@@ -106,6 +142,9 @@ exports.LoggingModule = {
                 new configuration_1.EnumResolver(new configuration_1.EnvironmentVariableResolver("PRISTINE_LOGGING_FILE_LOGGER_OUTPUT_MODE"), output_mode_enum_1.OutputModeEnum),
             ]
         },
+        /**
+         * Whether or not the console logger is activated and should output logs.
+         */
         {
             parameterName: logging_module_keyname_1.LoggingModuleKeyname + ".fileLoggerActivated",
             defaultValue: false,
@@ -114,6 +153,9 @@ exports.LoggingModule = {
                 new configuration_1.BooleanResolver(new configuration_1.EnvironmentVariableResolver("PRISTINE_LOGGING_FILE_LOGGER_ACTIVATED")),
             ]
         },
+        /**
+         * The file path to which the file logger should output the logs.
+         */
         {
             parameterName: logging_module_keyname_1.LoggingModuleKeyname + ".filePath",
             defaultValue: "./logs.txt",
@@ -122,6 +164,9 @@ exports.LoggingModule = {
                 new configuration_1.BooleanResolver(new configuration_1.EnvironmentVariableResolver("PRISTINE_LOGGING_FILE_PATH")),
             ]
         },
+        /**
+         * Whether or not the file logger should prettify the outputted logs.
+         */
         {
             parameterName: logging_module_keyname_1.LoggingModuleKeyname + ".fileLoggerPretty",
             defaultValue: false,
@@ -130,6 +175,11 @@ exports.LoggingModule = {
                 new configuration_1.BooleanResolver(new configuration_1.EnvironmentVariableResolver("PRISTINE_LOGGING_FILE_LOGGER_PRETTY")),
             ]
         },
+        /**
+         * Whether or not the diagnostic should be activated.
+         * When activated, the stack trace and other diagnostic information will be added to the logs.
+         * This is an intensive process and can dramatically reduce the performance of the code.
+         */
         {
             parameterName: logging_module_keyname_1.LoggingModuleKeyname + ".activateDiagnostics",
             defaultValue: false,

package/dist/lib/cjs/logging.module.js.map

@@ -1 +1 @@
-{"version":3,"file":"logging.module.js","sourceRoot":"","sources":["../../../src/logging.module.ts"],"names":[],"mappings":";;;;;;;;;;;;;AACA,qEAA8D;AAC9D,8DAKoC;AACpC,+DAAwD;AACxD,gDAAiD;AACjD,yDAAmD;AAEnD,gDAA8B;AAC9B,sDAAoC;AACpC,0DAAwC;AACxC,kDAAgC;AAChC,oDAAkC;AAClC,gDAA8B;AAC9B,2DAAwC;AAE3B,QAAA,aAAa,GAAoB;IAC1C,OAAO,EAAE,6CAAoB;IAC7B,wBAAwB,EAAE;QACtB;YACI,aAAa,EAAE,6CAAoB,GAAG,sBAAsB;YAC5D,UAAU,EAAE,KAAK;YACjB,YAAY,EAAE,EAAE;YAChB,gBAAgB,EAAE;gBACd,IAAI,8BAAc,CAAC,IAAI,2CAA2B,CAAC,yCAAyC,CAAC,CAAC;aACjG;SACJ;QACD;YACI,aAAa,EAAE,6CAAoB,GAAG,gCAAgC;YACtE,YAAY,EAAE,4BAAY,CAAC,IAAI;YAC/B,UAAU,EAAE,KAAK;YACjB,gBAAgB,EAAE;gBACd,IAAI,4BAAY,CAAC,IAAI,2CAA2B,CAAC,mDAAmD,CAAC,EAAE,4BAAY,CAAC;aACvH;SACJ;QACD;YACI,aAAa,EAAE,6CAAoB,GAAG,6BAA6B;YACnE,YAAY,EAAE,CAAC;YACf,UAAU,EAAE,KAAK;YACjB,gBAAgB,EAAE;gBACd,IAAI,8BAAc,CAAC,IAAI,2CAA2B,CAAC,gDAAgD,CAAC,CAAC;aACxG;SACJ;QACD;YACI,aAAa,EAAE,6CAAoB,GAAG,4BAA4B;YAClE,YAAY,EAAE,CAAC;YACf,UAAU,EAAE,KAAK;YACjB,gBAAgB,EAAE;gBACd,IAAI,8BAAc,CAAC,IAAI,2CAA2B,CAAC,+CAA+C,CAAC,CAAC;aACvG;SACJ;QACD;YACI,aAAa,EAAE,6CAAoB,GAAG,+BAA+B;YACrE,YAAY,EAAE,CAAC;YACf,UAAU,EAAE,KAAK;YACjB,gBAAgB,EAAE;gBACd,IAAI,8BAAc,CAAC,IAAI,2CAA2B,CAAC,kDAAkD,CAAC,CAAC;aAC1G;SACJ;QACD;YACI,aAAa,EAAE,6CAAoB,GAAG,6BAA6B;YACnE,YAAY,EAAE,CAAC;YACf,UAAU,EAAE,KAAK;YACjB,gBAAgB,EAAE;gBACd,IAAI,8BAAc,CAAC,IAAI,2CAA2B,CAAC,gDAAgD,CAAC,CAAC;aACxG;SACJ;QACD;YACI,aAAa,EAAE,6CAAoB,GAAG,gCAAgC;YACtE,YAAY,EAAE,CAAC;YACf,UAAU,EAAE,KAAK;YACjB,gBAAgB,EAAE;gBACd,IAAI,8BAAc,CAAC,IAAI,2CAA2B,CAAC,mDAAmD,CAAC,CAAC;aAC3G;SACJ;QACD;YACI,aAAa,EAAE,6CAAoB,GAAG,yBAAyB;YAC/D,YAAY,EAAE,IAAI;YAClB,UAAU,EAAE,KAAK;YACjB,gBAAgB,EAAE;gBACd,IAAI,+BAAe,CAAC,IAAI,2CAA2B,CAAC,2CAA2C,CAAC,CAAC;aACpG;SACJ;QACD;YACI,aAAa,EAAE,6CAAoB,GAAG,0BAA0B;YAChE,YAAY,EAAE,iCAAc,CAAC,IAAI;YACjC,UAAU,EAAE,KAAK;YACjB,gBAAgB,EAAE;gBACd,IAAI,4BAAY,CAAC,IAAI,2CAA2B,CAAC,6CAA6C,CAAC,EAAE,iCAAc,CAAC;aACnH;SACJ;QACD;YACI,aAAa,EAAE,6CAAoB,GAAG,uBAAuB;YAC7D,YAAY,EAAE,iCAAc,CAAC,IAAI;YACjC,UAAU,EAAE,KAAK;YACjB,gBAAgB,EAAE;gBACd,IAAI,4BAAY,CAAC,IAAI,2CAA2B,CAAC,0CAA0C,CAAC,EAAE,iCAAc,CAAC;aAChH;SACJ;QACD;YACI,aAAa,EAAE,6CAAoB,GAAG,sBAAsB;YAC5D,YAAY,EAAE,KAAK;YACnB,UAAU,EAAE,KAAK;YACjB,gBAAgB,EAAE;gBACd,IAAI,+BAAe,CAAC,IAAI,2CAA2B,CAAC,wCAAwC,CAAC,CAAC;aACjG;SACJ;QACD;YACI,aAAa,EAAE,6CAAoB,GAAG,WAAW;YACjD,YAAY,EAAE,YAAY;YAC1B,UAAU,EAAE,KAAK;YACjB,gBAAgB,EAAE;gBACd,IAAI,+BAAe,CAAC,IAAI,2CAA2B,CAAC,4BAA4B,CAAC,CAAC;aACrF;SACJ;QACD;YACI,aAAa,EAAE,6CAAoB,GAAG,mBAAmB;YACzD,YAAY,EAAE,KAAK;YACnB,UAAU,EAAE,KAAK;YACjB,gBAAgB,EAAE;gBACd,IAAI,+BAAe,CAAC,IAAI,2CAA2B,CAAC,qCAAqC,CAAC,CAAC;aAC9F;SACJ;QACD;YACI,aAAa,EAAE,6CAAoB,GAAG,sBAAsB;YAC5D,YAAY,EAAE,KAAK;YACnB,UAAU,EAAE,KAAK;YACjB,gBAAgB,EAAE;gBACd,IAAI,+BAAe,CAAC,IAAI,2CAA2B,CAAC,uCAAuC,CAAC,CAAC;aAChG;SACJ;KACJ;IACD,aAAa,EAAE;QACX,qBAAY;QACZ,mCAAmB;KACtB;IACD,qBAAqB,EAAE,EAAE;CAC5B,CAAC"}
+{"version":3,"file":"logging.module.js","sourceRoot":"","sources":["../../../src/logging.module.ts"],"names":[],"mappings":";;;;;;;;;;;;;AACA,qEAA8D;AAC9D,8DAKoC;AACpC,+DAAwD;AACxD,gDAAiD;AACjD,yDAAmD;AAEnD,gDAA8B;AAC9B,sDAAoC;AACpC,0DAAwC;AACxC,oDAAkC;AAClC,kDAAgC;AAChC,gDAA8B;AAC9B,2DAAwC;AAE3B,QAAA,aAAa,GAAoB;IAC1C,OAAO,EAAE,6CAAoB;IAC7B,wBAAwB,EAAE;QACtB;;WAEG;QACH;YACI,aAAa,EAAE,6CAAoB,GAAG,sBAAsB;YAC5D,UAAU,EAAE,KAAK;YACjB,YAAY,EAAE,EAAE;YAChB,gBAAgB,EAAE;gBACd,IAAI,8BAAc,CAAC,IAAI,2CAA2B,CAAC,yCAAyC,CAAC,CAAC;aACjG;SACJ;QACD;;;WAGG;QACH;YACI,aAAa,EAAE,6CAAoB,GAAG,gCAAgC;YACtE,YAAY,EAAE,4BAAY,CAAC,IAAI;YAC/B,UAAU,EAAE,KAAK;YACjB,gBAAgB,EAAE;gBACd,IAAI,4BAAY,CAAC,IAAI,2CAA2B,CAAC,mDAAmD,CAAC,EAAE,4BAAY,CAAC;aACvH;SACJ;QACD;;;WAGG;QACH;YACI,aAAa,EAAE,6CAAoB,GAAG,6BAA6B;YACnE,YAAY,EAAE,CAAC;YACf,UAAU,EAAE,KAAK;YACjB,gBAAgB,EAAE;gBACd,IAAI,8BAAc,CAAC,IAAI,2CAA2B,CAAC,gDAAgD,CAAC,CAAC;aACxG;SACJ;QACD;;;WAGG;QACH;YACI,aAAa,EAAE,6CAAoB,GAAG,4BAA4B;YAClE,YAAY,EAAE,CAAC;YACf,UAAU,EAAE,KAAK;YACjB,gBAAgB,EAAE;gBACd,IAAI,8BAAc,CAAC,IAAI,2CAA2B,CAAC,+CAA+C,CAAC,CAAC;aACvG;SACJ;QACD;;;WAGG;QACH;YACI,aAAa,EAAE,6CAAoB,GAAG,+BAA+B;YACrE,YAAY,EAAE,CAAC;YACf,UAAU,EAAE,KAAK;YACjB,gBAAgB,EAAE;gBACd,IAAI,8BAAc,CAAC,IAAI,2CAA2B,CAAC,kDAAkD,CAAC,CAAC;aAC1G;SACJ;QACD;;;WAGG;QACH;YACI,aAAa,EAAE,6CAAoB,GAAG,6BAA6B;YACnE,YAAY,EAAE,CAAC;YACf,UAAU,EAAE,KAAK;YACjB,gBAAgB,EAAE;gBACd,IAAI,8BAAc,CAAC,IAAI,2CAA2B,CAAC,gDAAgD,CAAC,CAAC;aACxG;SACJ;QACD;;;WAGG;QACH;YACI,aAAa,EAAE,6CAAoB,GAAG,gCAAgC;YACtE,YAAY,EAAE,CAAC;YACf,UAAU,EAAE,KAAK;YACjB,gBAAgB,EAAE;gBACd,IAAI,8BAAc,CAAC,IAAI,2CAA2B,CAAC,mDAAmD,CAAC,CAAC;aAC3G;SACJ;QACD;;WAEG;QACH;YACI,aAAa,EAAE,6CAAoB,GAAG,yBAAyB;YAC/D,YAAY,EAAE,IAAI;YAClB,UAAU,EAAE,KAAK;YACjB,gBAAgB,EAAE;gBACd,IAAI,+BAAe,CAAC,IAAI,2CAA2B,CAAC,2CAA2C,CAAC,CAAC;aACpG;SACJ;QACD;;WAEG;QACH;YACI,aAAa,EAAE,6CAAoB,GAAG,0BAA0B;YAChE,YAAY,EAAE,iCAAc,CAAC,IAAI;YACjC,UAAU,EAAE,KAAK;YACjB,gBAAgB,EAAE;gBACd,IAAI,4BAAY,CAAC,IAAI,2CAA2B,CAAC,6CAA6C,CAAC,EAAE,iCAAc,CAAC;aACnH;SACJ;QACD;;WAEG;QACH;YACI,aAAa,EAAE,6CAAoB,GAAG,uBAAuB;YAC7D,YAAY,EAAE,iCAAc,CAAC,IAAI;YACjC,UAAU,EAAE,KAAK;YACjB,gBAAgB,EAAE;gBACd,IAAI,4BAAY,CAAC,IAAI,2CAA2B,CAAC,0CAA0C,CAAC,EAAE,iCAAc,CAAC;aAChH;SACJ;QACD;;WAEG;QACH;YACI,aAAa,EAAE,6CAAoB,GAAG,sBAAsB;YAC5D,YAAY,EAAE,KAAK;YACnB,UAAU,EAAE,KAAK;YACjB,gBAAgB,EAAE;gBACd,IAAI,+BAAe,CAAC,IAAI,2CAA2B,CAAC,wCAAwC,CAAC,CAAC;aACjG;SACJ;QACD;;WAEG;QACH;YACI,aAAa,EAAE,6CAAoB,GAAG,WAAW;YACjD,YAAY,EAAE,YAAY;YAC1B,UAAU,EAAE,KAAK;YACjB,gBAAgB,EAAE;gBACd,IAAI,+BAAe,CAAC,IAAI,2CAA2B,CAAC,4BAA4B,CAAC,CAAC;aACrF;SACJ;QACD;;WAEG;QACH;YACI,aAAa,EAAE,6CAAoB,GAAG,mBAAmB;YACzD,YAAY,EAAE,KAAK;YACnB,UAAU,EAAE,KAAK;YACjB,gBAAgB,EAAE;gBACd,IAAI,+BAAe,CAAC,IAAI,2CAA2B,CAAC,qCAAqC,CAAC,CAAC;aAC9F;SACJ;QACD;;;;WAIG;QACH;YACI,aAAa,EAAE,6CAAoB,GAAG,sBAAsB;YAC5D,YAAY,EAAE,KAAK;YACnB,UAAU,EAAE,KAAK;YACjB,gBAAgB,EAAE;gBACd,IAAI,+BAAe,CAAC,IAAI,2CAA2B,CAAC,uCAAuC,CAAC,CAAC;aAChG;SACJ;KACJ;IACD,aAAa,EAAE;QACX,qBAAY;QACZ,mCAAmB;KACtB;IACD,qBAAqB,EAAE,EAAE;CAC5B,CAAC"}