@decaf-ts/logging 0.10.0 → 0.10.2

package/lib/pino/pino.cjs

@@ -1,10 +1,40 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PinoFactory = exports.PinoLogger = void 0;
-const pino_1 = __importDefault(require("pino"));
+const pino_1 = __importStar(require("pino"));
 const logging_1 = require("./../logging.cjs");
 const constants_1 = require("./../constants.cjs");
 const LogLevelToPino = {
@@ -25,106 +55,92 @@ const PinoToLogLevel = {
     debug: constants_1.LogLevel.debug,
     trace: constants_1.LogLevel.trace,
 };
-const isPinoLogger = (candidate) => {
-    if (!candidate || typeof candidate !== "object")
-        return false;
-    const required = ["info", "error", "warn", "debug", "trace"];
-    return required.every((method) => typeof candidate[method] === "function");
-};
 const toPinoLevel = (level) => LogLevelToPino[level] ?? "info";
 const fromPinoLevel = (level) => {
     if (!level)
         return undefined;
     return PinoToLogLevel[level];
 };
-const buildPinoOptions = (context, config, candidate) => {
+const joinContext = (segments, separator) => {
+    if (!segments.length)
+        return "Logger";
+    return segments.join(separator);
+};
+const buildPinoOptions = (context, config, overrides) => {
     const options = {
         level: toPinoLevel(config.level),
         name: context,
-        ...(candidate || {}),
+        ...overrides,
     };
     if (!options.level)
         options.level = toPinoLevel(config.level);
     if (!options.name)
         options.name = context;
+    options.timestamp = config.timestamp
+        ? () => new Date().toISOString()
+        : false;
     return options;
 };
-const mergePinoConfig = (base, overrides) => {
-    if (!base && !overrides)
-        return {};
-    return {
-        ...(base || {}),
-        ...(overrides || {}),
-        options: {
-            ...(base?.options || {}),
-            ...(overrides?.options || {}),
-        },
-    };
+const isDestinationStream = (candidate) => {
+    if (!candidate || typeof candidate !== "object")
+        return false;
+    return typeof candidate.write === "function";
 };
-const extractPinoConfig = (config) => {
-    if (!config)
-        return {};
-    const raw = config.pino;
-    if (!raw || typeof raw !== "object")
-        return {};
-    return {
-        instance: raw.instance,
-        options: raw.options,
-        destination: raw.destination,
-    };
+const buildDestination = (transports) => {
+    if (!transports || transports.length === 0)
+        return undefined;
+    const streams = transports.filter(isDestinationStream);
+    if (streams.length <= 1)
+        return streams[0];
+    return (0, pino_1.multistream)(streams.map((stream) => ({ stream })));
 };
-const getPinoConfig = (globalConfig, instanceConfig) => mergePinoConfig(extractPinoConfig(globalConfig), extractPinoConfig(instanceConfig));
+/**
+ * @description A logger that is powered by the Pino logging library.
+ * @summary This class extends {@link MiniLogger} and uses Pino as its underlying logging engine.
+ * @param {string} [context] - The context (typically the class name) that this logger is associated with.
+ * @param {Partial<LoggingConfig>} [conf] - Optional configuration to override global settings.
+ * @param {PinoBaseLogger} [driver] - An optional, pre-existing Pino logger instance to use.
+ * @class PinoLogger
+ */
 class PinoLogger extends logging_1.MiniLogger {
-    constructor(context, conf) {
+    constructor(context, conf, driver) {
         super(context, conf);
-        this.childLoggers = new Map();
+        if (driver) {
+            this.pino = driver;
+            const derivedLevel = fromPinoLevel(driver.level);
+            if (derivedLevel)
+                this.setConfig({ level: derivedLevel });
+            return;
+        }
         const globalConfig = logging_1.Logging.getConfig();
         const config = Object.assign({}, globalConfig, this.conf || {});
-        const pinoConfig = getPinoConfig(globalConfig, this.conf);
-        if (isPinoLogger(pinoConfig.instance)) {
-            this.pino = pinoConfig.instance;
-            const logLevel = fromPinoLevel(this.pino.level);
-            if (logLevel)
-                this.conf = { ...(this.conf || {}), level: logLevel };
-        }
-        else {
-            const options = buildPinoOptions(context, config, pinoConfig.options);
-            this.pino = (0, pino_1.default)(options, pinoConfig.destination);
-        }
-    }
-    activePino() {
-        const override = this.config("pino");
-        if (override && override.instance && isPinoLogger(override.instance)) {
-            return override.instance;
-        }
-        return this.pino;
+        const separator = config.contextSeparator ||
+            logging_1.Logging.getConfig().contextSeparator;
+        const contextName = joinContext(Array.isArray(this.context) ? this.context : [], separator);
+        const options = buildPinoOptions(contextName, config);
+        const destination = buildDestination(config.transports || undefined);
+        this.pino = (0, pino_1.default)(options, destination);
     }
     log(level, msg, error) {
-        const configuredLevel = this.config("level") || constants_1.LogLevel.info;
-        if (constants_1.NumericLogLevels[configuredLevel] < constants_1.NumericLogLevels[level])
-            return;
         const formatted = this.createLog(level, msg, error);
         const methodName = toPinoLevel(level);
-        const target = this.activePino();
-        const emitter = target[methodName];
+        const emitter = this.pino[methodName];
         if (typeof emitter === "function") {
-            emitter.call(target, formatted);
+            emitter.call(this.pino, formatted);
             return;
         }
-        if (typeof target["log"] === "function") {
-            target.log({
+        if (typeof this.pino.log === "function") {
+            this.pino.log({
                 level: methodName,
                 msg: formatted,
             });
-            return;
         }
     }
     fatal(msg, error) {
         const formatted = this.createLog(constants_1.LogLevel.error, msg, error);
-        const target = this.activePino();
-        const fatal = target.fatal;
+        const fatal = this.pino.fatal;
         if (typeof fatal === "function") {
-            fatal.call(target, formatted);
+            fatal.call(this.pino, formatted);
         }
         else {
             this.error(msg, error);
@@ -136,42 +152,28 @@ class PinoLogger extends logging_1.MiniLogger {
             : typeof bindings.name === "string"
                 ? bindings.name
                 : undefined;
-        const combinedContext = nextContext
-            ? [this.context, nextContext].join(this.config("contextSeparator"))
-            : this.context;
-        const key = combinedContext;
-        let childPino = this.childLoggers.get(key);
-        if (!childPino) {
-            childPino =
-                typeof this.pino.child === "function"
-                    ? this.pino.child(bindings, options)
-                    : this.pino;
-            this.childLoggers.set(key, childPino);
-        }
-        const baseConfig = getPinoConfig(logging_1.Logging.getConfig(), this.conf);
-        const overrides = {
-            pino: mergePinoConfig(baseConfig, { instance: childPino }),
-        };
-        if (nextContext) {
-            return super.for(nextContext, overrides);
-        }
-        return super.for(overrides);
+        const childInstance = typeof this.pino.child === "function"
+            ? this.pino.child(bindings, options)
+            : this.pino;
+        const childLogger = new PinoLogger(nextContext ??
+            joinContext(this.context, this.config("contextSeparator") || "."), this.conf, childInstance);
+        childLogger.context = nextContext
+            ? [...this.context, nextContext]
+            : [...this.context];
+        return childLogger;
     }
     flush() {
-        const target = this.activePino();
-        if (typeof target.flush === "function") {
-            return target.flush();
+        if (typeof this.pino.flush === "function") {
+            return this.pino.flush();
         }
     }
     get level() {
-        const target = this.activePino();
-        return target.level;
+        return this.pino.level;
     }
     set level(value) {
         if (!value)
             return;
-        const target = this.activePino();
-        target.level = value;
+        this.pino.level = value;
         const mapped = fromPinoLevel(value);
         if (mapped)
             this.setConfig({ level: mapped });
@@ -179,40 +181,14 @@ class PinoLogger extends logging_1.MiniLogger {
 }
 exports.PinoLogger = PinoLogger;
 /**
- * @description Factory function returning a Pino-backed logger.
- * @summary Allows registering the Pino logger with the global Logging facade.
+ * @description A factory for creating {@link PinoLogger} instances.
+ * @summary This factory function creates a new {@link PinoLogger} instance, and can optionally accept a pre-existing Pino logger instance.
+ * @const {LoggerFactory} PinoFactory
+ * @memberOf module:Logging
  */
 const PinoFactory = (context, conf, ...args) => {
-    const shallowClone = conf
-        ? {
-            ...conf,
-            pino: conf.pino ? { ...conf.pino } : undefined,
-        }
-        : {};
-    const normalized = shallowClone;
-    const ensurePinoConfig = () => {
-        const current = normalized.pino;
-        if (current)
-            return current;
-        const fresh = {};
-        normalized.pino = fresh;
-        return fresh;
-    };
-    const [firstArg, secondArg] = args;
-    if (isPinoLogger(firstArg)) {
-        const pinoConfig = ensurePinoConfig();
-        pinoConfig.instance = firstArg;
-    }
-    else if (firstArg) {
-        const pinoConfig = ensurePinoConfig();
-        pinoConfig.options = {
-            ...(pinoConfig.options || {}),
-            ...firstArg,
-        };
-        if (secondArg !== undefined)
-            pinoConfig.destination = secondArg;
-    }
-    return new PinoLogger(context, normalized);
+    const [driver] = args;
+    return new PinoLogger(context, conf, driver);
 };
 exports.PinoFactory = PinoFactory;
 //# sourceMappingURL=pino.js.map

package/lib/pino/pino.d.ts

@@ -2,11 +2,17 @@ import { Logger as PinoBaseLogger } from "pino";
 import { MiniLogger } from "../logging";
 import { Logger, LoggerFactory, LoggingConfig, StringLike } from "../types";
 import { LogLevel } from "../constants";
+/**
+ * @description A logger that is powered by the Pino logging library.
+ * @summary This class extends {@link MiniLogger} and uses Pino as its underlying logging engine.
+ * @param {string} [context] - The context (typically the class name) that this logger is associated with.
+ * @param {Partial<LoggingConfig>} [conf] - Optional configuration to override global settings.
+ * @param {PinoBaseLogger} [driver] - An optional, pre-existing Pino logger instance to use.
+ * @class PinoLogger
+ */
 export declare class PinoLogger extends MiniLogger implements Logger {
     protected pino: PinoBaseLogger;
-    private readonly childLoggers;
-    constructor(context: string, conf?: Partial<LoggingConfig>);
-    private activePino;
+    constructor(context?: string, conf?: Partial<LoggingConfig>, driver?: PinoBaseLogger);
     protected log(level: LogLevel, msg: StringLike | Error, error?: Error): void;
     fatal(msg: StringLike | Error, error?: Error): void;
     child(bindings?: Record<string, unknown>, options?: Record<string, unknown>): PinoLogger;
@@ -15,7 +21,9 @@ export declare class PinoLogger extends MiniLogger implements Logger {
     set level(value: string | undefined);
 }
 /**
- * @description Factory function returning a Pino-backed logger.
- * @summary Allows registering the Pino logger with the global Logging facade.
+ * @description A factory for creating {@link PinoLogger} instances.
+ * @summary This factory function creates a new {@link PinoLogger} instance, and can optionally accept a pre-existing Pino logger instance.
+ * @const {LoggerFactory} PinoFactory
+ * @memberOf module:Logging
  */
 export declare const PinoFactory: LoggerFactory;

package/lib/pino/pino.js.map

@@ -1 +1 @@
-{"version":3,"file":"pino.js","sourceRoot":"","sources":["../../src/pino/pino.ts"],"names":[],"mappings":";;;;;;AAAA,gDAIc;AACd,8CAAiD;AAEjD,kDAA0D;AAI1D,MAAM,cAAc,GAAoC;IACtD,CAAC,oBAAQ,CAAC,SAAS,CAAC,EAAE,MAAM;IAC5B,CAAC,oBAAQ,CAAC,KAAK,CAAC,EAAE,OAAO;IACzB,CAAC,oBAAQ,CAAC,IAAI,CAAC,EAAE,MAAM;IACvB,CAAC,oBAAQ,CAAC,IAAI,CAAC,EAAE,MAAM;IACvB,CAAC,oBAAQ,CAAC,OAAO,CAAC,EAAE,OAAO;IAC3B,CAAC,oBAAQ,CAAC,KAAK,CAAC,EAAE,OAAO;IACzB,CAAC,oBAAQ,CAAC,KAAK,CAAC,EAAE,OAAO;IACzB,CAAC,oBAAQ,CAAC,KAAK,CAAC,EAAE,OAAO;CAC1B,CAAC;AAEF,MAAM,cAAc,GAA6C;IAC/D,KAAK,EAAE,oBAAQ,CAAC,KAAK;IACrB,KAAK,EAAE,oBAAQ,CAAC,KAAK;IACrB,IAAI,EAAE,oBAAQ,CAAC,IAAI;IACnB,IAAI,EAAE,oBAAQ,CAAC,IAAI;IACnB,KAAK,EAAE,oBAAQ,CAAC,KAAK;IACrB,KAAK,EAAE,oBAAQ,CAAC,KAAK;CACtB,CAAC;AAEF,MAAM,YAAY,GAAG,CAAC,SAAmB,EAA+B,EAAE;IACxE,IAAI,CAAC,SAAS,IAAI,OAAO,SAAS,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IAC9D,MAAM,QAAQ,GAAG,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAC7D,OAAO,QAAQ,CAAC,KAAK,CACnB,CAAC,MAAM,EAAE,EAAE,CACT,OAAQ,SAAqC,CAAC,MAAM,CAAC,KAAK,UAAU,CACvE,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG,CAAC,KAAe,EAAiB,EAAE,CACrD,cAAc,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC;AAElC,MAAM,aAAa,GAAG,CAAC,KAAc,EAAwB,EAAE;IAC7D,IAAI,CAAC,KAAK;QAAE,OAAO,SAAS,CAAC;IAC7B,OAAO,cAAc,CAAC,KAAsB,CAAC,CAAC;AAChD,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CACvB,OAAe,EACf,MAAqB,EACrB,SAA6B,EACV,EAAE;IACrB,MAAM,OAAO,GAAsB;QACjC,KAAK,EAAE,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC;QAChC,IAAI,EAAE,OAAO;QACb,GAAG,CAAE,SAA+B,IAAI,EAAE,CAAC;KAC5C,CAAC;IACF,IAAI,CAAC,OAAO,CAAC,KAAK;QAAE,OAAO,CAAC,KAAK,GAAG,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC9D,IAAI,CAAC,OAAO,CAAC,IAAI;QAAE,OAAO,CAAC,IAAI,GAAG,OAAO,CAAC;IAC1C,OAAO,OAAO,CAAC;AACjB,CAAC,CAAC;AAYF,MAAM,eAAe,GAAG,CACtB,IAAuB,EACvB,SAA4B,EACV,EAAE;IACpB,IAAI,CAAC,IAAI,IAAI,CAAC,SAAS;QAAE,OAAO,EAAE,CAAC;IACnC,OAAO;QACL,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC;QACf,GAAG,CAAC,SAAS,IAAI,EAAE,CAAC;QACpB,OAAO,EAAE;YACP,GAAG,CAAC,IAAI,EAAE,OAAO,IAAI,EAAE,CAAC;YACxB,GAAG,CAAC,SAAS,EAAE,OAAO,IAAI,EAAE,CAAC;SAC9B;KACF,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,iBAAiB,GAAG,CACxB,MAA+B,EACb,EAAE;IACpB,IAAI,CAAC,MAAM;QAAE,OAAO,EAAE,CAAC;IACvB,MAAM,GAAG,GAAI,MAAsC,CAAC,IAAI,CAAC;IACzD,IAAI,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ;QAAE,OAAO,EAAE,CAAC;IAE/C,OAAO;QACL,QAAQ,EAAE,GAAG,CAAC,QAAsC;QACpD,OAAO,EAAE,GAAG,CAAC,OAAwC;QACrD,WAAW,EAAE,GAAG,CAAC,WAA4C;KAC9D,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,CACpB,YAAoC,EACpC,cAAuC,EACrB,EAAE,CACpB,eAAe,CACb,iBAAiB,CAAC,YAAY,CAAC,EAC/B,iBAAiB,CAAC,cAAc,CAAC,CAClC,CAAC;AAEJ,MAAa,UAAW,SAAQ,oBAAU;IAIxC,YACE,OAAe,EACf,IAA6B;QAE7B,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QANN,iBAAY,GAAG,IAAI,GAAG,EAA0B,CAAC;QAOhE,MAAM,YAAY,GAAG,iBAAO,CAAC,SAAS,EAAE,CAAC;QACzC,MAAM,MAAM,GAAkB,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,YAAY,EAAE,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC;QAC/E,MAAM,UAAU,GAAG,aAAa,CAAC,YAAY,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QAE1D,IAAI,YAAY,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;YACtC,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC,QAAQ,CAAC;YAChC,MAAM,QAAQ,GAAG,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAChD,IAAI,QAAQ;gBAAE,IAAI,CAAC,IAAI,GAAG,EAAE,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC;QACtE,CAAC;aAAM,CAAC;YACN,MAAM,OAAO,GAAG,gBAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC;YACtE,IAAI,CAAC,IAAI,GAAG,IAAA,cAAI,EAAC,OAAO,EAAE,UAAU,CAAC,WAAW,CAAC,CAAC;QACpD,CAAC;IACH,CAAC;IAEO,UAAU;QAChB,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAiC,CAAC;QACrE,IAAI,QAAQ,IAAI,QAAQ,CAAC,QAAQ,IAAI,YAAY,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;YACrE,OAAO,QAAQ,CAAC,QAAQ,CAAC;QAC3B,CAAC;QACD,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAEkB,GAAG,CACpB,KAAe,EACf,GAAuB,EACvB,KAAa;QAEb,MAAM,eAAe,GAAI,IAAI,CAAC,MAAM,CAAC,OAAO,CAAc,IAAI,oBAAQ,CAAC,IAAI,CAAC;QAC5E,IAAI,4BAAgB,CAAC,eAAe,CAAC,GAAG,4BAAgB,CAAC,KAAK,CAAC;YAAE,OAAO;QAExE,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;QACpD,MAAM,UAAU,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC;QACtC,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QACjC,MAAM,OAAO,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC;QAEnC,IAAI,OAAO,OAAO,KAAK,UAAU,EAAE,CAAC;YACjC,OAAsC,CAAC,IAAI,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;YAChE,OAAO;QACT,CAAC;QAED,IAAI,OAAO,MAAM,CAAC,KAA4B,CAAC,KAAK,UAAU,EAAE,CAAC;YAC9D,MAAc,CAAC,GAAG,CAAC;gBAClB,KAAK,EAAE,UAAU;gBACjB,GAAG,EAAE,SAAS;aACf,CAAC,CAAC;YACH,OAAO;QACT,CAAC;IACH,CAAC;IAED,KAAK,CAAC,GAAuB,EAAE,KAAa;QAC1C,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,oBAAQ,CAAC,KAAK,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;QAC7D,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QACjC,MAAM,KAAK,GAAI,MAAc,CAAC,KAAK,CAAC;QACpC,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE,CAAC;YAC/B,KAAoC,CAAC,IAAI,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;QAChE,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QACzB,CAAC;IACH,CAAC;IAED,KAAK,CACH,WAAoC,EAAE,EACtC,OAAiC;QAEjC,MAAM,WAAW,GACf,OAAO,QAAQ,CAAC,OAAO,KAAK,QAAQ;YAClC,CAAC,CAAC,QAAQ,CAAC,OAAO;YAClB,CAAC,CAAC,OAAO,QAAQ,CAAC,IAAI,KAAK,QAAQ;gBACjC,CAAC,CAAC,QAAQ,CAAC,IAAI;gBACf,CAAC,CAAC,SAAS,CAAC;QAElB,MAAM,eAAe,GAAG,WAAW;YACjC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,IAAI,CAC9B,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAW,CAC1C;YACH,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC;QAEjB,MAAM,GAAG,GAAG,eAAe,CAAC;QAC5B,IAAI,SAAS,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC3C,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,SAAS;gBACP,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,KAAK,UAAU;oBACnC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,OAAO,CAAC;oBACpC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;YAChB,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;QACxC,CAAC;QAED,MAAM,UAAU,GAAG,aAAa,CAAC,iBAAO,CAAC,SAAS,EAAE,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QACjE,MAAM,SAAS,GAA2B;YACxC,IAAI,EAAE,eAAe,CAAC,UAAU,EAAE,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC;SAC3D,CAAC;QAEF,IAAI,WAAW,EAAE,CAAC;YAChB,OAAO,KAAK,CAAC,GAAG,CAAC,WAAW,EAAE,SAAS,CAAe,CAAC;QACzD,CAAC;QACD,OAAO,KAAK,CAAC,GAAG,CAAC,SAAS,CAAe,CAAC;IAC5C,CAAC;IAED,KAAK;QACH,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QACjC,IAAI,OAAO,MAAM,CAAC,KAAK,KAAK,UAAU,EAAE,CAAC;YACvC,OAAO,MAAM,CAAC,KAAK,EAAE,CAAC;QACxB,CAAC;IACH,CAAC;IAED,IAAI,KAAK;QACP,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QACjC,OAAO,MAAM,CAAC,KAAK,CAAC;IACtB,CAAC;IAED,IAAI,KAAK,CAAC,KAAyB;QACjC,IAAI,CAAC,KAAK;YAAE,OAAO;QACnB,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAChC,MAAc,CAAC,KAAK,GAAG,KAAK,CAAC;QAC9B,MAAM,MAAM,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC;QACpC,IAAI,MAAM;YAAE,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;IAChD,CAAC;CACF;AA9HD,gCA8HC;AAED;;;GAGG;AACI,MAAM,WAAW,GAAkB,CACxC,OAAe,EACf,IAA6B,EAC7B,GAAG,IAAW,EACd,EAAE;IACF,MAAM,YAAY,GAAG,IAAI;QACvB,CAAC,CAAC;YACE,GAAG,IAAI;YACP,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,SAAS;SAC/C;QACH,CAAC,CAAC,EAAE,CAAC;IACP,MAAM,UAAU,GAA2B,YAAY,CAAC;IAExD,MAAM,gBAAgB,GAAG,GAAqB,EAAE;QAC9C,MAAM,OAAO,GAAI,UAA0C,CAAC,IAAI,CAAC;QACjE,IAAI,OAAO;YAAE,OAAO,OAAO,CAAC;QAC5B,MAAM,KAAK,GAAqB,EAAE,CAAC;QAClC,UAA0C,CAAC,IAAI,GAAG,KAAK,CAAC;QACzD,OAAO,KAAK,CAAC;IACf,CAAC,CAAC;IAEF,MAAM,CAAC,QAAQ,EAAE,SAAS,CAAC,GAAG,IAAI,CAAC;IACnC,IAAI,YAAY,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC3B,MAAM,UAAU,GAAG,gBAAgB,EAAE,CAAC;QACtC,UAAU,CAAC,QAAQ,GAAG,QAAQ,CAAC;IACjC,CAAC;SAAM,IAAI,QAAQ,EAAE,CAAC;QACpB,MAAM,UAAU,GAAG,gBAAgB,EAAE,CAAC;QACtC,UAAU,CAAC,OAAO,GAAG;YACnB,GAAG,CAAC,UAAU,CAAC,OAAO,IAAI,EAAE,CAAC;YAC7B,GAAI,QAA8B;SACnC,CAAC;QACF,IAAI,SAAS,KAAK,SAAS;YAAE,UAAU,CAAC,WAAW,GAAG,SAAS,CAAC;IAClE,CAAC;IAED,OAAO,IAAI,UAAU,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;AAC7C,CAAC,CAAC;AAnCW,QAAA,WAAW,eAmCtB"}
+{"version":3,"file":"pino.js","sourceRoot":"","sources":["../../src/pino/pino.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAKc;AACd,8CAAiD;AAEjD,kDAAwC;AAIxC,MAAM,cAAc,GAAoC;IACtD,CAAC,oBAAQ,CAAC,SAAS,CAAC,EAAE,MAAM;IAC5B,CAAC,oBAAQ,CAAC,KAAK,CAAC,EAAE,OAAO;IACzB,CAAC,oBAAQ,CAAC,IAAI,CAAC,EAAE,MAAM;IACvB,CAAC,oBAAQ,CAAC,IAAI,CAAC,EAAE,MAAM;IACvB,CAAC,oBAAQ,CAAC,OAAO,CAAC,EAAE,OAAO;IAC3B,CAAC,oBAAQ,CAAC,KAAK,CAAC,EAAE,OAAO;IACzB,CAAC,oBAAQ,CAAC,KAAK,CAAC,EAAE,OAAO;IACzB,CAAC,oBAAQ,CAAC,KAAK,CAAC,EAAE,OAAO;CAC1B,CAAC;AAEF,MAAM,cAAc,GAA6C;IAC/D,KAAK,EAAE,oBAAQ,CAAC,KAAK;IACrB,KAAK,EAAE,oBAAQ,CAAC,KAAK;IACrB,IAAI,EAAE,oBAAQ,CAAC,IAAI;IACnB,IAAI,EAAE,oBAAQ,CAAC,IAAI;IACnB,KAAK,EAAE,oBAAQ,CAAC,KAAK;IACrB,KAAK,EAAE,oBAAQ,CAAC,KAAK;CACtB,CAAC;AAEF,MAAM,WAAW,GAAG,CAAC,KAAe,EAAiB,EAAE,CACrD,cAAc,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC;AAElC,MAAM,aAAa,GAAG,CAAC,KAAc,EAAwB,EAAE;IAC7D,IAAI,CAAC,KAAK;QAAE,OAAO,SAAS,CAAC;IAC7B,OAAO,cAAc,CAAC,KAAsB,CAAC,CAAC;AAChD,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG,CAAC,QAAkB,EAAE,SAAiB,EAAU,EAAE;IACpE,IAAI,CAAC,QAAQ,CAAC,MAAM;QAAE,OAAO,QAAQ,CAAC;IACtC,OAAO,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;AAClC,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CACvB,OAAe,EACf,MAAqB,EACrB,SAA6B,EACV,EAAE;IACrB,MAAM,OAAO,GAAsB;QACjC,KAAK,EAAE,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC;QAChC,IAAI,EAAE,OAAO;QACb,GAAG,SAAS;KACb,CAAC;IACF,IAAI,CAAC,OAAO,CAAC,KAAK;QAAE,OAAO,CAAC,KAAK,GAAG,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC9D,IAAI,CAAC,OAAO,CAAC,IAAI;QAAE,OAAO,CAAC,IAAI,GAAG,OAAO,CAAC;IAC1C,OAAO,CAAC,SAAS,GAAG,MAAM,CAAC,SAAS;QAClC,CAAC,CAAC,GAAG,EAAE,CAAC,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;QAChC,CAAC,CAAC,KAAK,CAAC;IACV,OAAO,OAAO,CAAC;AACjB,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAG,CAC1B,SAAkB,EACc,EAAE;IAClC,IAAI,CAAC,SAAS,IAAI,OAAO,SAAS,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IAC9D,OAAO,OAAQ,SAA+B,CAAC,KAAK,KAAK,UAAU,CAAC;AACtE,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CACvB,UAAgC,EACD,EAAE;IACjC,IAAI,CAAC,UAAU,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC;IAC7D,MAAM,OAAO,GAAG,UAAU,CAAC,MAAM,CAAC,mBAAmB,CAAC,CAAC;IACvD,IAAI,OAAO,CAAC,MAAM,IAAI,CAAC;QAAE,OAAO,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,OAAO,IAAA,kBAAW,EAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;AAC5D,CAAC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAa,UAAW,SAAQ,oBAAU;IAGxC,YACE,OAAgB,EAChB,IAA6B,EAC7B,MAAuB;QAEvB,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QACrB,IAAI,MAAM,EAAE,CAAC;YACX,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC;YACnB,MAAM,YAAY,GAAG,aAAa,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACjD,IAAI,YAAY;gBAAE,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC,CAAC;YAC1D,OAAO;QACT,CAAC;QAED,MAAM,YAAY,GAAG,iBAAO,CAAC,SAAS,EAAE,CAAC;QACzC,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,YAAY,EAAE,IAAI,CAAC,IAAI,IAAI,EAAE,CAAqC,CAAC;QAEpG,MAAM,SAAS,GACZ,MAAM,CAAC,gBAA2B;YAClC,iBAAO,CAAC,SAAS,EAAE,CAAC,gBAA2B,CAAC;QACnD,MAAM,WAAW,GAAG,WAAW,CAC7B,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAC/C,SAAS,CACV,CAAC;QACF,MAAM,OAAO,GAAG,gBAAgB,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;QACtD,MAAM,WAAW,GAAG,gBAAgB,CACjC,MAAM,CAAC,UAA8C,IAAI,SAAS,CACpE,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAA,cAAI,EAAC,OAAO,EAAE,WAAW,CAAC,CAAC;IACzC,CAAC;IAEkB,GAAG,CACpB,KAAe,EACf,GAAuB,EACvB,KAAa;QAEb,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;QACpD,MAAM,UAAU,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC;QACtC,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAEtC,IAAI,OAAO,OAAO,KAAK,UAAU,EAAE,CAAC;YACjC,OAAsC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;YACnE,OAAO;QACT,CAAC;QAED,IAAI,OAAQ,IAAI,CAAC,IAAY,CAAC,GAAG,KAAK,UAAU,EAAE,CAAC;YAChD,IAAI,CAAC,IAAY,CAAC,GAAG,CAAC;gBACrB,KAAK,EAAE,UAAU;gBACjB,GAAG,EAAE,SAAS;aACf,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,KAAK,CAAC,GAAuB,EAAE,KAAa;QAC1C,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,oBAAQ,CAAC,KAAK,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;QAC7D,MAAM,KAAK,GAAI,IAAI,CAAC,IAAY,CAAC,KAAK,CAAC;QACvC,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE,CAAC;YAC/B,KAAoC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;QACnE,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QACzB,CAAC;IACH,CAAC;IAED,KAAK,CACH,WAAoC,EAAE,EACtC,OAAiC;QAEjC,MAAM,WAAW,GACf,OAAO,QAAQ,CAAC,OAAO,KAAK,QAAQ;YAClC,CAAC,CAAC,QAAQ,CAAC,OAAO;YAClB,CAAC,CAAC,OAAO,QAAQ,CAAC,IAAI,KAAK,QAAQ;gBACjC,CAAC,CAAC,QAAQ,CAAC,IAAI;gBACf,CAAC,CAAC,SAAS,CAAC;QAElB,MAAM,aAAa,GACjB,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,KAAK,UAAU;YACnC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,OAAO,CAAC;YACpC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;QAChB,MAAM,WAAW,GAAG,IAAI,UAAU,CAChC,WAAW;YACT,WAAW,CACT,IAAI,CAAC,OAAO,EACX,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAY,IAAI,GAAG,CACnD,EACH,IAAI,CAAC,IAAI,EACT,aAAa,CACd,CAAC;QACF,WAAW,CAAC,OAAO,GAAG,WAAW;YAC/B,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,OAAO,EAAE,WAAW,CAAC;YAChC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC;QACtB,OAAO,WAAW,CAAC;IACrB,CAAC;IAED,KAAK;QACH,IAAI,OAAQ,IAAI,CAAC,IAAY,CAAC,KAAK,KAAK,UAAU,EAAE,CAAC;YACnD,OAAQ,IAAI,CAAC,IAAY,CAAC,KAAK,EAAE,CAAC;QACpC,CAAC;IACH,CAAC;IAED,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC;IACzB,CAAC;IAED,IAAI,KAAK,CAAC,KAAyB;QACjC,IAAI,CAAC,KAAK;YAAE,OAAO;QACnB,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACxB,MAAM,MAAM,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC;QACpC,IAAI,MAAM;YAAE,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;IAChD,CAAC;CACF;AA/GD,gCA+GC;AAED;;;;;GAKG;AACI,MAAM,WAAW,GAAkB,CACxC,OAAgB,EAChB,IAA6B,EAC7B,GAAG,IAAW,EACd,EAAE;IACF,MAAM,CAAC,MAAM,CAAC,GAAG,IAAoC,CAAC;IACtD,OAAO,IAAI,UAAU,CAAC,OAAO,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;AAC/C,CAAC,CAAC;AAPW,QAAA,WAAW,eAOtB"}

package/lib/text.cjs

@@ -14,17 +14,13 @@ exports.sf = sf;
 const constants_1 = require("./constants.cjs");
 /**
  * @description Pads the end of a string with a specified character.
- * @summary Extends the input string to a specified length by adding a padding character to the end.
- * If the input string is already longer than the specified length, it is returned unchanged.
- *
+ * @summary This function extends the input string to a specified length by adding a padding character to the end. If the input string is already longer than the specified length, it is returned unchanged.
  * @param {string} str - The input string to be padded.
  * @param {number} length - The desired total length of the resulting string.
- * @param {string} [char=" "] - The character to use for padding. Defaults to a space.
+ * @param {string} [char=" "] - The character to use for padding.
  * @return {string} The padded string.
  * @throws {Error} If the padding character is not exactly one character long.
- *
  * @function padEnd
- *
  * @memberOf module:Logging
  */
 function padEnd(str, length, char = " ") {
@@ -33,20 +29,15 @@ function padEnd(str, length, char = " ") {
     return str.padEnd(length, char);
 }
 /**
- * @description Replaces placeholders in a string with provided values.
- * @summary Interpolates a string by replacing placeholders of the form ${variableName}
- * with corresponding values from the provided object. If a placeholder doesn't have
- * a corresponding value, it is left unchanged in the string.
- *
- * @param {string} input - The input string containing placeholders to be replaced.
- * @param {Record<string, number | string>} values - An object containing key-value pairs for replacement.
- * @param prefix
- * @param suffix
- * @param flags
- * @return {string} The interpolated string with placeholders replaced by their corresponding values.
- *
+ * @description Replaces placeholders in a string with the provided values.
+ * @summary This function interpolates a string by replacing placeholders of the form `${variableName}` with the corresponding values from the provided object. If a placeholder does not have a corresponding value, it is left unchanged in the string.
+ * @param {string} input - The input string containing the placeholders to be replaced.
+ * @param {Record<string, (number|string)>} values - An object containing key-value pairs for the replacement.
+ * @param {string} [prefix="${"] - The prefix for the placeholders.
+ * @param {string} [suffix="}"] - The suffix for the placeholders.
+ * @param {string} [flags="g"] - The regular expression flags to use.
+ * @return {string} The interpolated string with the placeholders replaced by their corresponding values.
  * @function patchPlaceholders
- *
  * @mermaid
  * sequenceDiagram
  *   participant Caller
@@ -56,7 +47,6 @@ function padEnd(str, length, char = " ") {
  *   patchString->>String.replace: Call with regex and replacement function
  *   String.replace->>patchString: Return replaced string
  *   patchString-->>Caller: Return patched string
- *
  * @memberOf module:Logging
  */
 function patchPlaceholders(input, values, prefix = constants_1.DefaultPlaceholderWrappers[0], suffix = constants_1.DefaultPlaceholderWrappers[1], flags = "g") {
@@ -68,16 +58,12 @@ function patchPlaceholders(input, values, prefix = constants_1.DefaultPlaceholde
 }
 /**
  * @description Replaces occurrences of keys with their corresponding values in a string.
- * @summary Iterates through a set of key-value pairs and replaces all occurrences of each key
- * in the input string with its corresponding value. Supports regular expression flags for customized replacement.
- *
- * @param {string} input - The input string in which replacements will be made.
- * @param {Record<string, number | string>} values - An object containing key-value pairs for replacement.
- * @param {string} [flags="g"] - Regular expression flags to control the replacement behavior.
- * @return {string} The string with all specified replacements applied.
- *
+ * @summary This function iterates through a set of key-value pairs and replaces all occurrences of each key in the input string with its corresponding value. It supports regular expression flags for customized replacement.
+ * @param {string} input - The input string in which the replacements will be made.
+ * @param {Record<string, (number|string)>} values - An object containing key-value pairs for the replacement.
+ * @param {string} [flags="g"] - The regular expression flags to control the replacement behavior.
+ * @return {string} The string with all the specified replacements applied.
  * @function patchString
- *
  * @memberOf module:Logging
  */
 function patchString(input, values, flags = "g") {
@@ -89,14 +75,10 @@ function patchString(input, values, flags = "g") {
 }
 /**
  * @description Converts a string to camelCase.
- * @summary Transforms the input string into camelCase format, where words are joined without spaces
- * and each word after the first starts with a capital letter.
- *
+ * @summary This function transforms the input string into camelCase format, where words are joined without spaces and each word after the first starts with a capital letter.
  * @param {string} text - The input string to be converted.
  * @return {string} The input string converted to camelCase.
- *
  * @function toCamelCase
- *
  * @memberOf module:Logging
  */
 function toCamelCase(text) {
@@ -106,14 +88,10 @@ function toCamelCase(text) {
 }
 /**
  * @description Converts a string to ENVIRONMENT_VARIABLE format.
- * @summary Transforms the input string into uppercase with words separated by underscores,
- * typically used for environment variable names.
- *
+ * @summary This function transforms the input string into uppercase with words separated by underscores, which is a format that is typically used for environment variable names.
  * @param {string} text - The input string to be converted.
  * @return {string} The input string converted to ENVIRONMENT_VARIABLE format.
- *
  * @function toENVFormat
- *
  * @memberOf module:Logging
  */
 function toENVFormat(text) {
@@ -121,13 +99,10 @@ function toENVFormat(text) {
 }
 /**
  * @description Converts a string to snake_case.
- * @summary Transforms the input string into lowercase with words separated by underscores.
- *
+ * @summary This function transforms the input string into lowercase with words separated by underscores.
  * @param {string} text - The input string to be converted.
  * @return {string} The input string converted to snake_case.
- *
  * @function toSnakeCase
- *
  * @memberOf module:Logging
  */
 function toSnakeCase(text) {
@@ -138,13 +113,10 @@ function toSnakeCase(text) {
 }
 /**
  * @description Converts a string to kebab-case.
- * @summary Transforms the input string into lowercase with words separated by hyphens.
- *
+ * @summary This function transforms the input string into lowercase with words separated by hyphens.
  * @param {string} text - The input string to be converted.
  * @return {string} The input string converted to kebab-case.
- *
  * @function toKebabCase
- *
  * @memberOf module:Logging
  */
 function toKebabCase(text) {
@@ -155,14 +127,10 @@ function toKebabCase(text) {
 }
 /**
  * @description Converts a string to PascalCase.
- * @summary Transforms the input string into PascalCase format, where words are joined without spaces
- * and each word starts with a capital letter.
- *
+ * @summary This function transforms the input string into PascalCase format, where words are joined without spaces and each word starts with a capital letter.
  * @param {string} text - The input string to be converted.
  * @return {string} The input string converted to PascalCase.
- *
  * @function toPascalCase
- *
  * @memberOf module:Logging
  */
 function toPascalCase(text) {
@@ -172,26 +140,21 @@ function toPascalCase(text) {
 }
 /**
  * @description Escapes special characters in a string for use in a regular expression.
- * @summary Adds backslashes before characters that have special meaning in regular expressions,
- * allowing the string to be used as a literal match in a RegExp.
- *
+ * @summary This function adds backslashes before characters that have a special meaning in regular expressions, which allows the string to be used as a literal match in a RegExp.
  * @param {string} string - The string to escape for regular expression use.
- * @return {string} The escaped string safe for use in regular expressions.
- *
+ * @return {string} The escaped string that is safe for use in regular expressions.
  * @function escapeRegExp
- *
  * @memberOf module:Logging
  */
 function escapeRegExp(string) {
     return string.replace(/[.*+?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string
 }
 /**
- * @summary Util function to provide string format functionality similar to C#'s string.format
- *
- * @param {string} string
- * @param {Array<string | number> | Record<string, any>} [args] replacements made by order of appearance (replacement0 wil replace {0} and so on)
- * @return {string} formatted string
- *
+ * @description A utility function that provides string formatting functionality that is similar to C#'s string.format.
+ * @summary This function replaces placeholders in a string with the provided arguments.
+ * @param {string} string - The string to format.
+ * @param {...(string|number|Record<string, any>)} args - The arguments to use for formatting.
+ * @return {string} The formatted string.
  * @function sf
  * @memberOf module:Logging
  */
@@ -215,10 +178,9 @@ function sf(string, ...args) {
     });
 }
 /**
- * @summary Util function to provide string format functionality similar to C#'s string.format
- *
+ * @description A utility function that provides string formatting functionality that is similar to C#'s string.format.
+ * @summary This function is deprecated. Use {@link sf} instead.
  * @see sf
- *
  * @deprecated
  * @function stringFormat
  * @memberOf module:Logging