simpl-loggar/lib/loggers/default.d.ts

Simple node.js logger

import * as enums from '../enums/index.js';
import type { LoggerOptions } from 'winston';
/**
 * Log passed data and save it in local files.
 */
export default class Log {
    private static _counter;
    private static _prefix;
    private static _styleJson;
    private static _logRules;
    private static _config;
    private static _memoryOnly;
    /**
     * Get current date.
     * @returns Formatted date for log files.
     */
    private static getDate;
    /**
     * Sets a rule for logs. If the rule returns true, the log will be shown; otherwise, it will not.
     * This is useful for adding additional rules to control logging behavior in production environments.
     * This rule will only be used to validate messages. Targets will not be validated.
     * If param used in this logger is not a string, it will be JSON.stringify. Keep this in mind, that certain params like full error objects might not work.
     * @param rule The rule to validate logs against.
     * @param target The log type to which this rule should be assigned.
     */
    static setLogRule(rule: (log: string) => boolean, target: enums.ELogTypes): void;
    /**
     * Set prefix for logs location. Useful if you want to group all logs from 1 project into 1 location.
     * @param prefix Prefix to use.
     */
    static setPrefix(prefix: string): void;
    /**
     * Set custom winston config.
     * @param config Config to set.
     */
    static setWinstonRules(config: LoggerOptions): void;
    /**
     * Disable winston.
     */
    static disableWinston(): void;
    private static get config();
    private static set config(value);
    private static get counter();
    private static set counter(value);
    private static get styleJson();
    private static set styleJson(value);
    private static get logRules();
    private static get prefix();
    private static set prefix(value);
    private static get memoryOnly();
    private static set memoryOnly(value);
    /**
     * Add spaces to json stringify.
     * Setting this to false will simply stringify logs in files without formatting them to more readable state.
     * This is useful, for when you have custom gui for logs like gcp. This will make logs more readable.
     * Default val: true.
     * @param val Boolean marking if json should include spaces.
     */
    static formatJson(val: boolean): void;
    /**
     * Log new error.
     * @param target Log target used as prefix for log.
     * @param {...unknown} messages All messages that you want to log.
     */
    static error(target: string, ...messages: unknown[]): void;
    /**
     * Log new error in decorator.
     * @param targetMessage Log target used as prefix for log.
     * @param {...unknown} messages All messages that you want to log.
     * @returns Decorator data.
     */
    static decorateError<This, Args extends unknown[], Return>(targetMessage: string, ...messages: unknown[]): (target: (this: This, ...args: Args) => Return | Promise<Return>, _context: ClassMethodDecoratorContext<This, (this: This, ...args: Args) => Return | Promise<Return>>) => (this: This, ...args: Args) => Promise<Return>;
    /**
     * Log new warning.
     * @param target Log target used as prefix for log.
     * @param {...unknown} messages All messages that you want to log.
     */
    static warn(target: string, ...messages: unknown[]): void;
    /**
     * Log new warning in decorator.
     * @param targetMessage Log target used as prefix for log.
     * @param {...unknown} messages All messages that you want to log.
     * @returns Decorator data.
     */
    static decorateWarn<This, Args extends unknown[], Return>(targetMessage: string, ...messages: unknown[]): (target: (this: This, ...args: Args) => Return | Promise<Return>, _context: ClassMethodDecoratorContext<This, (this: This, ...args: Args) => Return | Promise<Return>>) => (this: This, ...args: Args) => Promise<Return>;
    /**
     * Log new log.
     * @param target Log target used as prefix for log.
     * @param {...unknown} messages All messages that you want to log.
     */
    static log(target: string, ...messages: unknown[]): void;
    /**
     * Log new log in decorator.
     * @param targetMessage Log target used as prefix for log.
     * @param {...unknown} messages All messages that you want to log.
     * @returns Decorator data.
     */
    static decorateLog<This, Args extends unknown[], Return>(targetMessage: string, ...messages: unknown[]): (target: (this: This, ...args: Args) => Return | Promise<Return>, _context: ClassMethodDecoratorContext<This, (this: This, ...args: Args) => Return | Promise<Return>>) => (this: This, ...args: Args) => Promise<Return>;
    /**
     * Log new debug.
     * This log will not show up, when NODE_ENV is set to production.
     * @param target Log target used as prefix for log.
     * @param {...unknown} messages All messages that you want to log.
     */
    static debug(target: string, ...messages: unknown[]): void;
    /**
     * Log new log in decorator.
     * This log will not show up, when NODE_ENV is set to production.
     * @param targetMessage Log target used as prefix for log.
     * @param {...unknown} messages All messages that you want to log.
     * @returns Decorator data.
     */
    static decorateDebug<This, Args extends unknown[], Return>(targetMessage: string, ...messages: unknown[]): (target: (this: This, ...args: Args) => Return | Promise<Return>, _context: ClassMethodDecoratorContext<This, (this: This, ...args: Args) => Return | Promise<Return>>) => (this: This, ...args: Args) => Promise<Return>;
    /**
     * Start counting time.
     * To end time counting, run `log.endtime` with the same target.
     * @param target Log target used as prefix for log.
     * @param {...unknown} messages All messages that you want to log.
     */
    static time(target: string, ...messages: unknown[]): void;
    /**
     * End counting time.
     * @param target Log target used as prefix for log.
     * @param {...unknown} messages All messages that you want to log.
     */
    static endTime(target: string, ...messages: unknown[]): void;
    /**
     * Decorator, which will counts how much time function took to run.
     * @param targetMessage Log target used as prefix for log.
     * @param {...unknown} messages All messages that you want to log.
     * @returns Decorator data.
     */
    static decorateTime<This, Args extends unknown[], Return>(targetMessage: string, ...messages: unknown[]): (target: (this: This, ...args: Args) => Return | Promise<Return>, _context: ClassMethodDecoratorContext<This, (this: This, ...args: Args) => Return | Promise<Return>>) => (this: This, ...args: Args) => Promise<Return>;
    /**
     * Decorator, which will counts how much time function took to run.
     * This log will not show up, when NODE_ENV is set to production.
     * @param targetMessage Log target used as prefix for log.
     * @param {...unknown} messages All messages that you want to log.
     * @returns Decorator data.
     */
    static decorateDebugTime<This, Args extends unknown[], Return>(targetMessage: string, ...messages: unknown[]): (target: (this: This, ...args: Args) => Return | Promise<Return>, _context: ClassMethodDecoratorContext<This, (this: This, ...args: Args) => Return | Promise<Return>>) => (this: This, ...args: Args) => Promise<Return>;
    /**
     * Trace selected data and log related params.
     * @param target Log target used as prefix for log.
     * @param {...unknown} messages All messages that you want to log.
     */
    static trace(target: string, ...messages: unknown[]): void;
    /**
     * Trace selected data and log related params in decorator.
     * @param targetMessage Log target used as prefix for log.
     * @param {...unknown} messages All messages that you want to log.
     * @returns Decorator data.
     */
    static decorateTrace<This, Args extends unknown[], Return>(targetMessage: string, ...messages: unknown[]): (target: (this: This, ...args: Args) => Return | Promise<Return>, _context: ClassMethodDecoratorContext<This, (this: This, ...args: Args) => Return | Promise<Return>>) => (this: This, ...args: Args) => Promise<Return>;
    /**
     * Console.log data from log and push it to function, which saves it.
     * @param color Chalks function, which colours logs.
     * @param type Category of log.
     * @param header Header to user.
     * @param message Messages to save.
     */
    private static buildLog;
    private static createDecorator;
}