@arcjet/logger/index.d.ts

Arcjet lightweight logger which mirrors the Pino structured logger interface

/**
 * Supported log levels.
 */
export type LogLevel = "debug" | "info" | "warn" | "error";
/**
 * Configuration.
 */
export interface Options {
    /**
     * Log level.
     */
    level: LogLevel;
}
/**
 * Configuration.
 *
 * @deprecated
 *   Use `Options` instead.
 */
export type LoggerOptions = Options;
/**
 * Logger.
 */
export declare class Logger {
    #private;
    /**
     * Configuration.
     *
     * @param options
     *   Configuration.
     * @returns
     *   Logger.
     */
    constructor(options: Options);
    /**
     * Debug.
     *
     * @param message
     *   Template.
     * @param interpolationValues
     *   Parameters to interpolate.
     * @returns
     *   Nothing.
     */
    debug(message: string, ...interpolationValues: unknown[]): void;
    /**
     * Debug.
     *
     * @param mergingObject
     *   Merging object copied into the JSON log line.
     * @param message
     *   Template.
     * @param interpolationValues
     *   Parameters to interpolate.
     * @returns
     *   Nothing.
     */
    debug(mergingObject: Record<string, unknown>, message?: string, ...interpolationValues: unknown[]): void;
    /**
     * Info.
     *
     * @param message
     *   Template.
     * @param interpolationValues
     *   Parameters to interpolate.
     * @returns
     *   Nothing.
     */
    info(message: string, ...interpolationValues: unknown[]): void;
    /**
     * Info.
     *
     * @param mergingObject
     *   Merging object copied into the JSON log line.
     * @param message
     *   Template.
     * @param interpolationValues
     *   Parameters to interpolate.
     * @returns
     *   Nothing.
     */
    info(mergingObject: Record<string, unknown>, message?: string, ...interpolationValues: unknown[]): void;
    /**
     * Warn.
     *
     * @param message
     *   Template.
     * @param interpolationValues
     *   Parameters to interpolate.
     * @returns
     *   Nothing.
     */
    warn(message: string, ...interpolationValues: unknown[]): void;
    /**
     * Warn.
     *
     * @param mergingObject
     *   Merging object copied into the JSON log line.
     * @param message
     *   Template.
     * @param interpolationValues
     *   Parameters to interpolate.
     * @returns
     *   Nothing.
     */
    warn(mergingObject: Record<string, unknown>, message?: string, ...interpolationValues: unknown[]): void;
    /**
     * Error.
     *
     * @param message
     *   Template.
     * @param interpolationValues
     *   Parameters to interpolate.
     * @returns
     *   Nothing.
     */
    error(message: string, ...interpolationValues: unknown[]): void;
    /**
     * Error.
     *
     * @param mergingObject
     *   Merging object copied into the JSON log line.
     * @param message
     *   Template.
     * @param interpolationValues
     *   Parameters to interpolate.
     * @returns
     *   Nothing.
     */
    error(mergingObject: Record<string, unknown>, message?: string, ...interpolationValues: unknown[]): void;
}