@aegis-framework/artemis/dist/types/Debug.d.ts

Aegis Framework Javascript Library

/**
 * ==============================
 * Debug
 * ==============================
 */
/**
 * Debug level enum
 */
export declare enum DebugLevel {
    NONE = 0,
    ERROR = 1,
    WARNING = 2,
    INFO = 3,
    DEBUG = 4,
    ALL = 5
}
/**
 * This class acts as a proxy for the console. It shares the same methods as the
 * web console but they are conditioned to a debug level.
 */
export declare class Debug {
    private static _level;
    /**
     * Get the current debug level
     */
    static get currentLevel(): DebugLevel;
    /**
     * Set or get the log level
     *
     * @param level - The debug level to use
     * @returns The current debug level
     */
    static level(level?: DebugLevel): DebugLevel;
    /**
     * Set the debug level
     *
     * @param level - The debug level to set
     */
    static setLevel(level: DebugLevel): void;
    /**
     * Check if a specific level is enabled
     *
     * @param level - The level to check
     */
    static isEnabled(level: DebugLevel): boolean;
    /**
     * Log the given elements.
     * Logs will only be made if the level is set to DEBUG or above
     *
     * @param args - Arguments to log
     */
    static log(...args: unknown[]): void;
    /**
     * Show a debugging log
     * Logs will only be made if the level is set DEBUG or above
     *
     * @param args - Arguments to log
     */
    static debug(...args: unknown[]): void;
    /**
     * Show an info log
     * Logs will only be made if the level is set to INFO or above
     *
     * @param args - Arguments to log
     */
    static info(...args: unknown[]): void;
    /**
     * Show an error log
     * Logs will only be made if the level is set to ERROR or above
     *
     * @param args - Arguments to log
     */
    static error(...args: unknown[]): void;
    /**
     * Show a warning log
     * Logs will only be made if the level is set to WARNING or above
     *
     * @param args - Arguments to log
     */
    static warning(...args: unknown[]): void;
    /**
     * Alias for warning()
     *
     * @param args - Arguments to log
     */
    static warn(...args: unknown[]): void;
    /**
     * Show data as a table
     * Table will only be made if the level is set to DEBUG or above
     *
     * @param data - Data to display as table
     * @param columns - Optional column names to include
     */
    static table(data: unknown, columns?: string[]): void;
    /**
     * Start an indented group
     *
     * @param args - Group label arguments
     */
    static group(...args: unknown[]): void;
    /**
     * Start an indented group collapsed by default
     *
     * @param args - Group label arguments
     */
    static groupCollapsed(...args: unknown[]): void;
    /**
     * End a previously started group
     */
    static groupEnd(): void;
    /**
     * Start a timer
     * The timer will only start if the level is set to DEBUG or above
     *
     * @param label - Timer label
     */
    static time(label?: string): void;
    /**
     * Log the time a timer has been running for
     * The time will only be logged if the level is set to DEBUG or above
     *
     * @param label - Timer label
     * @param args - Additional arguments to log
     */
    static timeLog(label?: string, ...args: unknown[]): void;
    /**
     * End a timer
     * The timer will only be available if the level is set to DEBUG or above
     *
     * @param label - Timer label
     */
    static timeEnd(label?: string): void;
    /**
     * Show the stack trace
     * The stack trace will only be available if the level is set to DEBUG or above
     *
     * @param args - Arguments to log with trace
     */
    static trace(...args: unknown[]): void;
    /**
     * Log a message if a condition is false
     * Only logs if the level is set to ERROR or above
     *
     * @param condition - Condition to check
     * @param args - Arguments to log if condition is false
     */
    static assert(condition: boolean, ...args: unknown[]): void;
    /**
     * Clear the console
     * Only clears if the level is set to DEBUG or above
     */
    static clear(): void;
    /**
     * Increment a counter with the given label
     * Only counts if the level is set to DEBUG or above
     *
     * @param label - Counter label
     */
    static count(label?: string): void;
    /**
     * Reset a counter with the given label
     * Only resets if the level is set to DEBUG or above
     *
     * @param label - Counter label
     */
    static countReset(label?: string): void;
    /**
     * Display an interactive listing of the properties of an object
     * Only displays if the level is set to DEBUG or above
     *
     * @param data - Object to display
     */
    static dir(data: unknown): void;
    /**
     * Display XML/HTML element representation
     * Only displays if the level is set to DEBUG or above
     *
     * @param data - Element to display
     */
    static dirxml(data: unknown): void;
    /**
     * Create a formatted string with substitution values
     *
     * @param format - Format string
     * @param args - Substitution values
     */
    static format(format: string, ...args: unknown[]): string;
}
//# sourceMappingURL=Debug.d.ts.map