@creejs/commons-logging 1.0.0

package/types/logger.d.ts

@@ -0,0 +1,111 @@
+export = Logger;
+/**
+ * Interface of All Logger
+ * @abstract
+ */
+declare class Logger {
+    /**
+     * Creates a new ConsoleLog instance.
+     * @constructor
+     * @param {string} name - The name identifier for the logger
+     * @param {number} [level=1] - The logging level, default is {@link DefaultLevel} error:1
+     * @param {module} [providerLib] - The provider library
+     */
+    constructor(name: string, level?: number, providerLib?: any);
+    _name: string;
+    level: number;
+    _providerLib: any;
+    /**
+     * Gets the name of the logger instance.
+     * @returns {string} The name of the logger.
+     */
+    get name(): string;
+    get fatalEnabled(): boolean;
+    get errorEnabled(): boolean;
+    get warnEnabled(): boolean;
+    get debugEnabled(): boolean;
+    get infoEnabled(): boolean;
+    get traceEnabled(): boolean;
+    /**
+     * Logs a fatal error message with timestamp and logger name.
+     * Only outputs if fatal logging is enabled for this logger instance.
+     * @param {...any} args - Arguments to log (will be space-separated)
+     */
+    fatal(...args: any[]): void;
+    /**
+     * Override this method to implement fatal logging.
+     * @public
+     * @param {...*} args - Variable arguments
+     * @throws {Error} Always throws "Not Implemented Yet" error
+     */
+    public _fatal(...args: any[]): void;
+    /**
+     * Logs an error message to the console with timestamp and logger name.
+     * Only logs if error logging is enabled for this logger instance.
+     * @param {...any} args - Arguments to be logged as error message
+     */
+    error(...args: any[]): void;
+    /**
+     * Override this method to implement error logging.
+     * @public
+     * @param {...*} args - Variable arguments
+     * @throws {Error} Always throws "Not Implemented Yet" error
+     */
+    public _error(...args: any[]): void;
+    /**
+     * Logs a warning message to the console if warn logging is enabled.
+     * @param {...any} args - The arguments to log as a warning message.
+     */
+    warn(...args: any[]): void;
+    /**
+     * Override this method to implement warn logging.
+     * @public
+     * @param {...*} args - Variable arguments
+     * @throws {Error} Always throws "Not Implemented Yet" error
+     */
+    public _warn(...args: any[]): void;
+    /**
+     * Logs debug messages to console if debug mode is enabled.
+     * @param {...any} args - The data to be logged
+     */
+    debug(...args: any[]): void;
+    /**
+     * Override this method to implement debug logging.
+     * @public
+     * @param {...*} args - Variable arguments
+     * @throws {Error} Always throws "Not Implemented Yet" error
+     */
+    public _debug(...args: any[]): void;
+    /**
+     * Logs an info message to the console with timestamp and logger name.
+     * @param {...any} args - The data to be logged. Accepts multiple arguments.
+     * @example
+     * logger.info('Service started', { port: 3000 });
+     */
+    info(...args: any[]): void;
+    /**
+     * Override this method to implement info logging.
+     * @public
+     * @param {...*} args - Variable arguments
+     * @throws {Error} Always throws "Not Implemented Yet" error
+     */
+    public _info(...args: any[]): void;
+    /**
+     * Logs a trace message with timestamp and logger name if trace logging is enabled.
+     * @param {...any} args - Data to be logged as trace message.
+     */
+    trace(...args: any[]): void;
+    /**
+     * Override this method to implement trace logging.
+     * @public
+     * @param {...*} args - Variable arguments
+     * @throws {Error} Always throws "Not Implemented Yet" error
+     */
+    public _trace(...args: any[]): void;
+    isFatalEnabled(): boolean;
+    isErrorEnabled(): boolean;
+    isWarnEnabled(): boolean;
+    isDebugEnabled(): boolean;
+    isInfoEnabled(): boolean;
+    isTraceEnabled(): boolean;
+}

package/types/logging-level.d.ts

@@ -0,0 +1,41 @@
+/**
+ * Standard logging level names
+ * @type {Object.<string, string>}
+ */
+export const Names: {
+    [x: string]: string;
+};
+/**
+ * *
+ */
+export type Level = number;
+export namespace Level {
+    let OFF: number;
+    let FATAL: number;
+    let ERROR: number;
+    let WARN: number;
+    let INFO: number;
+    let DEBUG: number;
+    let TRACE: number;
+    let ALL: number;
+}
+/**
+ * The default logging level (ERROR)
+ * @type {number}
+ */
+export const DefaultLevel: number;
+/**
+ * Converts a numeric logging level value to its corresponding name.
+ * @param {number} value - The numeric logging level value to convert.
+ * @returns {string|undefined} The name associated with the given logging level value.
+ * @memberof LoggingLevel
+ */
+export function value2Name(value: number): string | undefined;
+/**
+ * Converts a logging level name to its corresponding numeric value.
+ * @param {string} name - The name of the logging level.
+ * @returns {number|undefined} The numeric value of the logging level, or undefined if name is not supported.
+ * @memberof LoggingLevel
+ */
+export function name2Value(name: string): number | undefined;
+export { Names as LevelNames, Level as LevelValue };