kuzzle-logger/dist/KuzzleLogger.d.ts

Logger package for Kuzzle backend, JS SDK, and any related module (like gateways).

import { Logger } from 'pino';
import { KuzzleLoggerConfig } from './types/KuzzleLoggerConfig';
/**
 * The Logger class provides logging functionality for Kuzzle.
 */
export declare class KuzzleLogger {
    private _pino;
    get level(): typeof this._pino.level;
    set level(level: typeof this._pino.level);
    get pino(): Logger;
    protected set pino(pinoInstance: Logger);
    private getMergingObject;
    constructor(config: KuzzleLoggerConfig);
    /**
     * Logs a message with the "trace" level.
     *
     * @param obj - The object to log.
     * @param msg - An optional message to add to the logged object.
     * @param args - Additional arguments to log.
     */
    trace<T extends object>(obj: T, msg?: string, ...args: any[]): void;
    trace(obj: unknown, msg?: string, ...args: any[]): void;
    trace(msg: string, ...args: any[]): void;
    /**
     * Logs a message with the "debug" level.
     *
     * @param obj - The object to log.
     * @param msg - An optional message to add to the logged object.
     * @param args - Additional arguments to log.
     */
    debug<T extends object>(obj: T, msg?: string, ...args: any[]): void;
    debug(obj: unknown, msg?: string, ...args: any[]): void;
    debug(msg: string, ...args: any[]): void;
    /**
     * Logs a message with the "info" level.
     *
     * @param obj - The object to log.
     * @param msg - An optional message to add to the logged object.
     * @param args - Additional arguments to log.
     */
    info<T extends object>(obj: T, msg?: string, ...args: any[]): void;
    info(obj: unknown, msg?: string, ...args: any[]): void;
    info(msg: string, ...args: any[]): void;
    /**
     * Logs a message with the "warn" level.
     *
     * @param obj - The object to log.
     * @param msg - An optional message to add to the logged object.
     * @param args - Additional arguments to log.
     */
    warn<T extends object>(obj: T, msg?: string, ...args: any[]): void;
    warn(obj: unknown, msg?: string, ...args: any[]): void;
    warn(msg: string, ...args: any[]): void;
    /**
     * Logs a message with the "error" level.
     *
     * @param obj - The object to log.
     * @param msg - An optional message to add to the logged object.
     * @param args - Additional arguments to log.
     */
    error<T extends object>(obj: T, msg?: string, ...args: any[]): void;
    error(obj: unknown, msg?: string, ...args: any[]): void;
    error(msg: string, ...args: any[]): void;
    /**
     * Logs a message with the "fatal" level.
     *
     * @param obj - The object to log.
     * @param msg - An optional message to add to the logged object.
     * @param args - Additional arguments to log.
     */
    fatal<T extends object>(obj: T, msg?: string, ...args: any[]): void;
    fatal(obj: unknown, msg?: string, ...args: any[]): void;
    fatal(msg: string, ...args: any[]): void;
    flush(): Promise<void>;
    child(namespace: string): KuzzleLogger;
    private isErrorLike;
}