@spinajs/log-common 2.0.180 → 2.0.182

package/lib/cjs/index.d.ts

@@ -1,209 +1,209 @@
-import { Container, SyncService } from "@spinajs/di";
-export declare enum LogLevel {
-    Security = 999,
-    Fatal = 6,
-    Error = 5,
-    Warn = 4,
-    Success = 3,
-    Info = 2,
-    Debug = 1,
-    Trace = 0
-}
-export declare const StrToLogLevel: {
-    trace: LogLevel;
-    debug: LogLevel;
-    info: LogLevel;
-    success: LogLevel;
-    warn: LogLevel;
-    error: LogLevel;
-    fatal: LogLevel;
-    security: LogLevel;
-};
-export declare const LogLevelStrings: {
-    1: string;
-    5: string;
-    6: string;
-    2: string;
-    999: string;
-    3: string;
-    0: string;
-    4: string;
-};
-export interface ILogRule {
-    name: string;
-    level: "trace" | "debug" | "info" | "warn" | "error" | "fatal" | "security" | "success";
-    target: string | string[];
-}
-export interface ITargetsOption {
-    name: string;
-    type: string;
-    options?: ICommonTargetOptions;
-}
-export interface ILogOptions {
-    targets: ITargetsOption[];
-    rules: ILogRule[];
-    variables?: Record<string, unknown>;
-}
-export interface ICommonTargetOptions {
-    /**
-     * Message layout. You can use variables
-     *
-     * Default message layout is: datetime level message (logger)
-     */
-    layout: string;
-    /**
-     * Target name
-     */
-    name: string;
-    /**
-     * Target type
-     */
-    type: string;
-    /**
-     * Is logger enabled
-     */
-    enabled: boolean;
-}
-export interface IColoredConsoleTargetOptions extends ICommonTargetOptions {
-    /**
-     * Color theme for console message. Best leave it for default.
-     */
-    theme: {
-        security: string | string[];
-        fatal: string | string[];
-        error: string | string[];
-        warn: string | string[];
-        success: string | string[];
-        info: string | string[];
-        debug: string | string[];
-        trace: string | string[];
-    };
-}
-export interface IFileTargetOptions extends ICommonTargetOptions {
-    options: {
-        /**
-         * path whre log is stored. It is allowed to use variables to create path eg. date / time etc.
-         */
-        path: string;
-        /**
-         * Archive path for logs eg. when size is exceeded. Is is allowed to use variables eg. date / time etc.
-         *
-         * Default is none. When not set archive files are stored in same folder as logs.
-         */
-        archivePath: string;
-        /**
-         * Maximum log file size, if exceeded it is moved to archive, and new log file is created
-         *
-         * Default is 1mb
-         */
-        maxSize: number;
-        /**
-         * Should compress log file when moved to archive
-         *
-         * Default is false
-         */
-        compress: boolean;
-        /**
-         * Should rotate log file eg. new  file every new day.
-         * You should use cron like definition eg. at 1am every day: 0 1 * * *
-         * When rotate event occurs, old file is moved to archive, and new one is created
-         *
-         * Default is not set
-         */
-        rotate: string;
-        /**
-         * Max internal message buffer size before writting to file
-         * If bigger the number - less writes to disk.
-         *
-         * Set it big when logging very frequently to avoid disk writes
-         * Defaults to 100 messages
-         */
-        maxBufferSize: number;
-        /**
-         * How mutch archive files should be preserved before deletion. Default is 0
-         * Eg. to store max 5 archive files, set it to 5. Oldest by modification time are deleted.
-         */
-        maxArchiveFiles: number;
-        /**
-         * Log archive interval at whitch process should check if log files need archiving, in seconds.
-         * Default is 3 minutes
-         */
-        archiveInterval: number;
-    };
-}
-export interface ILogStaticVariables {
-    error: Error | undefined;
-    level: string;
-    logger: string;
-    message: string;
-}
-export interface ILogVariable {
-    [key: string]: unknown | (() => unknown);
-}
-export interface ILogEntry {
-    Level: LogLevel;
-    Variables: LogVariables;
-}
-export declare abstract class LogTarget<T extends ICommonTargetOptions> extends SyncService {
-    HasError: boolean;
-    Error: Error | null | unknown;
-    Options: T;
-    constructor(options: T);
-    abstract write(data: ILogEntry): void;
-}
-export interface ILogTargetDesc {
-    instance: LogTarget<ICommonTargetOptions>;
-    options?: ITargetsOption;
-    rule: ILogRule;
-}
-export declare function createLogMessageObject(err: Error | string, message: string | any[], level: LogLevel, logger: string, variables: any, ...args: any[]): ILogEntry;
-export declare abstract class Log extends SyncService {
-    static Loggers: Map<string, Log>;
-    static InternalLoggers: Map<string, Log>;
-    Timers: Map<string, Date>;
-    protected Targets: ILogTargetDesc[];
-    Name: string;
-    protected static AttachedToExitEvents: boolean;
-    protected Options: ILogOptions;
-    protected Rules: ILogRule[];
-    protected Container: Container;
-    protected Variables: Record<string, any>;
-    static clearLoggers(): Promise<Promise<void>[]>;
-    addVariable(name: string, value: unknown): void;
-    timeStart(name: string): void;
-    timeEnd(name: string): number;
-    child(name: string, variables?: LogVariables): Log;
-    abstract trace(message: string, ...args: any[]): void;
-    abstract trace(err: Error, message: string, ...args: any[]): void;
-    abstract trace(err: Error | string, message: string | any[], ...args: any[]): void;
-    abstract debug(message: string, ...args: any[]): void;
-    abstract debug(err: Error, message: string, ...args: any[]): void;
-    abstract debug(err: Error | string, message: string | any[], ...args: any[]): void;
-    abstract info(message: string, ...args: any[]): void;
-    abstract info(err: Error, message: string, ...args: any[]): void;
-    abstract info(err: Error | string, message: string | any[], ...args: any[]): void;
-    abstract warn(message: string, ...args: any[]): void;
-    abstract warn(err: Error, message: string, ...args: any[]): void;
-    abstract warn(err: Error | string, message: string | any[], ...args: any[]): void;
-    abstract error(message: string, ...args: any[]): void;
-    abstract error(err: Error, message: string, ...args: any[]): void;
-    abstract error(err: Error | string, message: string | any[], ...args: any[]): void;
-    abstract fatal(message: string, ...args: any[]): void;
-    abstract fatal(err: Error, message: string, ...args: any[]): void;
-    abstract fatal(err: Error | string, message: string | any[], ...args: any[]): void;
-    abstract security(message: string, ...args: any[]): void;
-    abstract security(err: Error, message: string, ...args: any[]): void;
-    abstract security(err: Error | string, message: string | any[], ...args: any[]): void;
-    abstract success(message: string, ...args: any[]): void;
-    abstract success(err: Error, message: string, ...args: any[]): void;
-    abstract success(err: Error | string, message: string | any[], ...args: any[]): void;
-    abstract write(entry: ILogEntry): Promise<PromiseSettledResult<void>[]>;
-}
-/**
- * Creates ( if not exists ) new logger instance with given name and optional variables
- * @param name - name of logger
- * @param variables - optional log variables
- */
-export declare function Logger(name: string, variables?: Record<string, unknown>): (target: any, key: string) => any;
-export type LogVariables = ILogStaticVariables & ILogVariable;
+import { Container, SyncService } from "@spinajs/di";
+export declare enum LogLevel {
+    Security = 999,
+    Fatal = 6,
+    Error = 5,
+    Warn = 4,
+    Success = 3,
+    Info = 2,
+    Debug = 1,
+    Trace = 0
+}
+export declare const StrToLogLevel: {
+    trace: LogLevel;
+    debug: LogLevel;
+    info: LogLevel;
+    success: LogLevel;
+    warn: LogLevel;
+    error: LogLevel;
+    fatal: LogLevel;
+    security: LogLevel;
+};
+export declare const LogLevelStrings: {
+    1: string;
+    5: string;
+    6: string;
+    2: string;
+    999: string;
+    3: string;
+    0: string;
+    4: string;
+};
+export interface ILogRule {
+    name: string;
+    level: "trace" | "debug" | "info" | "warn" | "error" | "fatal" | "security" | "success";
+    target: string | string[];
+}
+export interface ITargetsOption {
+    name: string;
+    type: string;
+    options?: ICommonTargetOptions;
+}
+export interface ILogOptions {
+    targets: ITargetsOption[];
+    rules: ILogRule[];
+    variables?: Record<string, unknown>;
+}
+export interface ICommonTargetOptions {
+    /**
+     * Message layout. You can use variables
+     *
+     * Default message layout is: datetime level message (logger)
+     */
+    layout: string;
+    /**
+     * Target name
+     */
+    name: string;
+    /**
+     * Target type
+     */
+    type: string;
+    /**
+     * Is logger enabled
+     */
+    enabled: boolean;
+}
+export interface IColoredConsoleTargetOptions extends ICommonTargetOptions {
+    /**
+     * Color theme for console message. Best leave it for default.
+     */
+    theme: {
+        security: string | string[];
+        fatal: string | string[];
+        error: string | string[];
+        warn: string | string[];
+        success: string | string[];
+        info: string | string[];
+        debug: string | string[];
+        trace: string | string[];
+    };
+}
+export interface IFileTargetOptions extends ICommonTargetOptions {
+    options: {
+        /**
+         * path whre log is stored. It is allowed to use variables to create path eg. date / time etc.
+         */
+        path: string;
+        /**
+         * Archive path for logs eg. when size is exceeded. Is is allowed to use variables eg. date / time etc.
+         *
+         * Default is none. When not set archive files are stored in same folder as logs.
+         */
+        archivePath: string;
+        /**
+         * Maximum log file size, if exceeded it is moved to archive, and new log file is created
+         *
+         * Default is 1mb
+         */
+        maxSize: number;
+        /**
+         * Should compress log file when moved to archive
+         *
+         * Default is false
+         */
+        compress: boolean;
+        /**
+         * Should rotate log file eg. new  file every new day.
+         * You should use cron like definition eg. at 1am every day: 0 1 * * *
+         * When rotate event occurs, old file is moved to archive, and new one is created
+         *
+         * Default is not set
+         */
+        rotate: string;
+        /**
+         * Max internal message buffer size before writting to file
+         * If bigger the number - less writes to disk.
+         *
+         * Set it big when logging very frequently to avoid disk writes
+         * Defaults to 100 messages
+         */
+        maxBufferSize: number;
+        /**
+         * How mutch archive files should be preserved before deletion. Default is 0
+         * Eg. to store max 5 archive files, set it to 5. Oldest by modification time are deleted.
+         */
+        maxArchiveFiles: number;
+        /**
+         * Log archive interval at whitch process should check if log files need archiving, in seconds.
+         * Default is 3 minutes
+         */
+        archiveInterval: number;
+    };
+}
+export interface ILogStaticVariables {
+    error: Error | undefined;
+    level: string;
+    logger: string;
+    message: string;
+}
+export interface ILogVariable {
+    [key: string]: unknown | (() => unknown);
+}
+export interface ILogEntry {
+    Level: LogLevel;
+    Variables: LogVariables;
+}
+export declare abstract class LogTarget<T extends ICommonTargetOptions> extends SyncService {
+    HasError: boolean;
+    Error: Error | null | unknown;
+    Options: T;
+    constructor(options: T);
+    abstract write(data: ILogEntry): void;
+}
+export interface ILogTargetDesc {
+    instance: LogTarget<ICommonTargetOptions>;
+    options?: ITargetsOption;
+    rule: ILogRule;
+}
+export declare function createLogMessageObject(err: Error | string, message: string | any[], level: LogLevel, logger: string, variables: any, ...args: any[]): ILogEntry;
+export declare abstract class Log extends SyncService {
+    static Loggers: Map<string, Log>;
+    static InternalLoggers: Map<string, Log>;
+    Timers: Map<string, Date>;
+    protected Targets: ILogTargetDesc[];
+    Name: string;
+    protected static AttachedToExitEvents: boolean;
+    protected Options: ILogOptions;
+    protected Rules: ILogRule[];
+    protected Container: Container;
+    protected Variables: Record<string, any>;
+    static clearLoggers(): Promise<Promise<void>[]>;
+    addVariable(name: string, value: unknown): void;
+    timeStart(name: string): void;
+    timeEnd(name: string): number;
+    child(name: string, variables?: LogVariables): Log;
+    abstract trace(message: string, ...args: any[]): void;
+    abstract trace(err: Error, message: string, ...args: any[]): void;
+    abstract trace(err: Error | string, message: string | any[], ...args: any[]): void;
+    abstract debug(message: string, ...args: any[]): void;
+    abstract debug(err: Error, message: string, ...args: any[]): void;
+    abstract debug(err: Error | string, message: string | any[], ...args: any[]): void;
+    abstract info(message: string, ...args: any[]): void;
+    abstract info(err: Error, message: string, ...args: any[]): void;
+    abstract info(err: Error | string, message: string | any[], ...args: any[]): void;
+    abstract warn(message: string, ...args: any[]): void;
+    abstract warn(err: Error, message: string, ...args: any[]): void;
+    abstract warn(err: Error | string, message: string | any[], ...args: any[]): void;
+    abstract error(message: string, ...args: any[]): void;
+    abstract error(err: Error, message: string, ...args: any[]): void;
+    abstract error(err: Error | string, message: string | any[], ...args: any[]): void;
+    abstract fatal(message: string, ...args: any[]): void;
+    abstract fatal(err: Error, message: string, ...args: any[]): void;
+    abstract fatal(err: Error | string, message: string | any[], ...args: any[]): void;
+    abstract security(message: string, ...args: any[]): void;
+    abstract security(err: Error, message: string, ...args: any[]): void;
+    abstract security(err: Error | string, message: string | any[], ...args: any[]): void;
+    abstract success(message: string, ...args: any[]): void;
+    abstract success(err: Error, message: string, ...args: any[]): void;
+    abstract success(err: Error | string, message: string | any[], ...args: any[]): void;
+    abstract write(entry: ILogEntry): Promise<PromiseSettledResult<void>[]>;
+}
+/**
+ * Creates ( if not exists ) new logger instance with given name and optional variables
+ * @param name - name of logger
+ * @param variables - optional log variables
+ */
+export declare function Logger(name: string, variables?: Record<string, unknown>): (target: any, key: string) => any;
+export type LogVariables = ILogStaticVariables & ILogVariable;
 //# sourceMappingURL=index.d.ts.map