@vvlad1973/simple-logger 2.1.7 → 2.1.8

package/dist/classes/simple-logger.d.ts

@@ -1,125 +1,125 @@
-/**
- * A module for simple logging with various logging levels.
- * @module SimpleLogger
- */
-import { ExternalLogger, LogFn, LoggerFactory, LoggerLevel, LoggerOptions } from '../types/simple-logger.types.js';
-export default class SimpleLogger {
-    private currentLevelIndex;
-    private logger;
-    private bindings;
-    private msgPrefix?;
-    private enabled;
-    isExternal: boolean;
-    static readonly noop: LogFn;
-    trace: LogFn;
-    debug: LogFn;
-    info: LogFn;
-    warn: LogFn;
-    error: LogFn;
-    fatal: LogFn;
-    silent: LogFn;
-    /**
-     * Initializes a new instance of the SimpleLogger class.
-     *
-     * @param {ExternalLogger | LoggerFactory | null} externalLogger - The external logger to use, or null to use the console.
-     * @param {LoggerOptions} [options={}] - Options for the logger, such as the logging level and bindings.
-     */
-    constructor(externalLogger?: ExternalLogger | LoggerFactory | null, options?: LoggerOptions);
-    /**
-     * Resolves the effective logging level based on the provided logger and explicit level.
-     *
-     * @param {ExternalLogger | Console} logger - The logger to resolve the level for.
-     * @param {LoggerLevel} [explicitLevel] - The explicit logging level to use, if provided.
-     * @return {LoggerLevel} The resolved effective logging level.
-     */
-    private resolveEffectiveLevel;
-    /**
-     * Initializes the logger with the provided external logger and options.
-     *
-     * Handles different cases for the external logger, including:
-     * - No external logger provided (falls back to console)
-     * - External logger is a factory function (e.g. pino)
-     * - External logger is invalid or console (falls back to console)
-     * - External logger is provided without parameters
-     * - External logger has a .child() method
-     * - External logger does not have a .child() method (uses directly)
-     *
-     * @param {ExternalLogger | LoggerFactory | null} externalLogger - The external logger to use, or null to use the console.
-     * @param {LoggerOptions} options - Options for the logger, such as the logging level and bindings.
-     * @return {void}
-     */
-    private initLogger;
-    /**
-     * Updates the logging methods based on the current logging level and external logger configuration.
-     *
-     * Iterates over the available logging levels and sets the corresponding logging method to either call the external log method or the internal pretty format log method, depending on the logger configuration.
-     *
-     * @return {void}
-     */
-    private updateLoggingMethods;
-    /**
-     * Calls the external log method for the specified level with the provided arguments.
-     *
-     * @param {LoggerLevel} level - The logging level to use for the external log method.
-     * @param {unknown[]} args - The arguments to pass to the external log method.
-     * @return {void}
-     */
-    private callExternalLogMethod;
-    /**
-     * Formats and logs a message with the specified level and arguments.
-     *
-     * @param {LoggerLevel} level - The logging level to use for the log message.
-     * @param {unknown[]} args - The arguments to use when formatting the log message.
-     * @return {void}
-     */
-    private prettyFormatLog;
-    /**
-     * Retrieves the current logging level.
-     *
-     * @return {LoggerLevel} The current logging level.
-     */
-    getLevel(): LoggerLevel;
-    /**
-     * Sets the logging level.
-     *
-     * @param {LoggerLevel} level - The logging level to set.
-     * @return {void}
-     */
-    setLevel(level: LoggerLevel): void;
-    /**
-     * Enables the logger.
-     *
-     * @return {void}
-     */
-    enable(): void;
-    /**
-     * Disables the logger.
-     *
-     * @return {void} Nothing is returned.
-     */
-    disable(): void;
-    /**
-     * Creates a new child logger with the merged bindings.
-     *
-     * If the external logger supports the `child` method, it will be used to create the child logger.
-     * Otherwise, a new SimpleLogger instance will be created with the merged bindings.
-     *
-     * @param {Record<string, unknown>} newBindings - The new bindings to merge with the existing bindings.
-     * @return {SimpleLogger} The new child logger instance.
-     */
-    child(newBindings: Record<string, unknown>): SimpleLogger;
-    /**
-     * Logs the start of a function.
-     *
-     * @param {string} name - Optional function name to log. If not provided, the caller function name will be used.
-     * @return {void}
-     */
-    logFunctionStart(name?: string): void;
-    /**
-     * Logs the end of a function.
-     *
-     * @param {string} name - Optional function name to log. If not provided, the caller function name will be used.
-     * @return {void}
-     */
-    logFunctionEnd(name?: string): void;
-}
+/**
+ * A module for simple logging with various logging levels.
+ * @module SimpleLogger
+ */
+import { ExternalLogger, LogFn, LoggerFactory, LoggerLevel, LoggerOptions } from '../types/simple-logger.types.js';
+export default class SimpleLogger {
+    private currentLevelIndex;
+    private logger;
+    private bindings;
+    private msgPrefix?;
+    private enabled;
+    isExternal: boolean;
+    static readonly noop: LogFn;
+    trace: LogFn;
+    debug: LogFn;
+    info: LogFn;
+    warn: LogFn;
+    error: LogFn;
+    fatal: LogFn;
+    silent: LogFn;
+    /**
+     * Initializes a new instance of the SimpleLogger class.
+     *
+     * @param {ExternalLogger | LoggerFactory | null} externalLogger - The external logger to use, or null to use the console.
+     * @param {LoggerOptions} [options={}] - Options for the logger, such as the logging level and bindings.
+     */
+    constructor(externalLogger?: ExternalLogger | LoggerFactory | null, options?: LoggerOptions);
+    /**
+     * Resolves the effective logging level based on the provided logger and explicit level.
+     *
+     * @param {ExternalLogger | Console} logger - The logger to resolve the level for.
+     * @param {LoggerLevel} [explicitLevel] - The explicit logging level to use, if provided.
+     * @return {LoggerLevel} The resolved effective logging level.
+     */
+    private resolveEffectiveLevel;
+    /**
+     * Initializes the logger with the provided external logger and options.
+     *
+     * Handles different cases for the external logger, including:
+     * - No external logger provided (falls back to console)
+     * - External logger is a factory function (e.g. pino)
+     * - External logger is invalid or console (falls back to console)
+     * - External logger is provided without parameters
+     * - External logger has a .child() method
+     * - External logger does not have a .child() method (uses directly)
+     *
+     * @param {ExternalLogger | LoggerFactory | null} externalLogger - The external logger to use, or null to use the console.
+     * @param {LoggerOptions} options - Options for the logger, such as the logging level and bindings.
+     * @return {void}
+     */
+    private initLogger;
+    /**
+     * Updates the logging methods based on the current logging level and external logger configuration.
+     *
+     * Iterates over the available logging levels and sets the corresponding logging method to either call the external log method or the internal pretty format log method, depending on the logger configuration.
+     *
+     * @return {void}
+     */
+    private updateLoggingMethods;
+    /**
+     * Calls the external log method for the specified level with the provided arguments.
+     *
+     * @param {LoggerLevel} level - The logging level to use for the external log method.
+     * @param {unknown[]} args - The arguments to pass to the external log method.
+     * @return {void}
+     */
+    private callExternalLogMethod;
+    /**
+     * Formats and logs a message with the specified level and arguments.
+     *
+     * @param {LoggerLevel} level - The logging level to use for the log message.
+     * @param {unknown[]} args - The arguments to use when formatting the log message.
+     * @return {void}
+     */
+    private prettyFormatLog;
+    /**
+     * Retrieves the current logging level.
+     *
+     * @return {LoggerLevel} The current logging level.
+     */
+    getLevel(): LoggerLevel;
+    /**
+     * Sets the logging level.
+     *
+     * @param {LoggerLevel} level - The logging level to set.
+     * @return {void}
+     */
+    setLevel(level: LoggerLevel): void;
+    /**
+     * Enables the logger.
+     *
+     * @return {void}
+     */
+    enable(): void;
+    /**
+     * Disables the logger.
+     *
+     * @return {void} Nothing is returned.
+     */
+    disable(): void;
+    /**
+     * Creates a new child logger with the merged bindings.
+     *
+     * If the external logger supports the `child` method, it will be used to create the child logger.
+     * Otherwise, a new SimpleLogger instance will be created with the merged bindings.
+     *
+     * @param {Record<string, unknown>} newBindings - The new bindings to merge with the existing bindings.
+     * @return {SimpleLogger} The new child logger instance.
+     */
+    child(newBindings: Record<string, unknown>): SimpleLogger;
+    /**
+     * Logs the start of a function.
+     *
+     * @param {string} name - Optional function name to log. If not provided, the caller function name will be used.
+     * @return {void}
+     */
+    logFunctionStart(name?: string): void;
+    /**
+     * Logs the end of a function.
+     *
+     * @param {string} name - Optional function name to log. If not provided, the caller function name will be used.
+     * @return {void}
+     */
+    logFunctionEnd(name?: string): void;
+}