Interface LoggingOptsFile

interface LoggingOptsFile {
    colorize?: boolean;
    console?: "error" | "off" | "warn" | "info" | "debug" | "trace";
    fileDatePattern?: string;
    files: {
        [filename: string]: LogLevel;
    };
    json?: boolean;
    maxFiles?: number;
    timestampFormat?: string;
}

Hierarchy (view full)

Properties

colorize? console? fileDatePattern? files json? maxFiles? timestampFormat?

Properties

Optional colorize

colorize?: boolean

Should the logs color-code the level strings in the output.

Optional console

console?: "error" | "off" | "warn" | "info" | "debug" | "trace"

The log level used by the console output.

Optional fileDatePattern

fileDatePattern?: string

The moment.js compatible date string to use when naming files.

files

files: {
    [filename: string]: LogLevel;
}

An object mapping a file name to a logging level. The file will contain all logs for that level inclusive up to the highest level. (info will contain warn, error etc) Use %DATE% to set the date of the file within the string. Use the fileDatePattern to set the date format.

Type declaration

Example

{"info-%DATE%.log": "info"}

Optional json

json?: boolean

Should the logs be outputted in JSON format, for consumption by a collector.

Optional maxFiles

maxFiles?: number

The number of files to keep before the last file is rotated. If not set, no files are deleted.

Optional timestampFormat

timestampFormat?: string

Timestamp format used in the log output.

Default

"HH:mm:ss:SSS"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc