@imqueue/async-logger/src/Logger.d.ts

Configurable async logger over winston for @imqueue services

/*!
 * I'm Queue Software Project
 * Copyright (C) 2025  imqueue.com <support@imqueue.com>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 *
 * If you want to use this code in a closed source (commercial) project, you can
 * purchase a proprietary commercial license. Please contact us at
 * <support@imqueue.com> to get commercial licensing options.
 */
import { ILogger, JsonObject } from '@imqueue/core';
import { TransportOptions } from './TransportOptions';
export interface AsyncLoggerOptions {
    transports: TransportOptions[];
    metadata: JsonObject;
}
/**
 * Class Logger
 */
export declare class Logger implements ILogger {
    /**
     * Asynchronous console async-logger
     *
     * @type {ILogger}
     */
    private static readonly console;
    /**
     * @description
     * Configuring options of async-logger
     *
     * @returns {LoggerOptions}
     */
    private static getLoggerOptions;
    /**
     * Winston based async-logger having different logging transports
     *
     * @type {WinstonLogger}
     */
    private readonly logger;
    /**
     * Logger Ctor
     *
     * @constructor
     * @param {AsyncLoggerOptions} options
     */
    constructor(options?: AsyncLoggerOptions);
    /**
     * Logs given arguments to configured async-logger destinations and to stdout
     * with log level = LOG
     *
     * @param {...*[]} args
     */
    log(...args: any[]): void;
    /**
     * Logs given arguments to configured async-logger destinations and to stdout
     * with log level = INFO
     *
     * @param {...*[]} args
     */
    info(...args: any[]): void;
    /**
     * Logs given arguments to configured async-logger destinations and to stderr
     * with log level = WARN
     *
     * @param {...*[]} args
     */
    warn(...args: any[]): void;
    /**
     * Logs given arguments to configured async-logger destinations and to stderr
     * with log level = ERROR
     *
     * @param {...*[]} args
     */
    error(...args: any[]): void;
    /**
     * Configuring transports of async-logger
     *
     * @param {TransportOptions[]} config - configuration for transports from
     *                             environment variables
     */
    private setupLogger;
}